From f4b21ccc65c12418222492ff91be7ff23db3f379 Mon Sep 17 00:00:00 2001 From: PureCloud Jenkins Date: Sun, 16 Jun 2024 06:36:48 +0000 Subject: [PATCH] 195.0.0 --- README.md | 4 +- build/.openapi-generator/FILES | 19 +- build/APIData.json | 382 +++++++++- build/README.md | 4 +- .../dist/node/purecloud-platform-client-v2.js | 705 +++++++++++++++--- .../web-amd/purecloud-platform-client-v2.js | 705 +++++++++++++++--- .../purecloud-platform-client-v2.min.js | 2 +- build/dist/web-cjs/bundle.js | 301 +++++--- .../web-cjs/purecloud-platform-client-v2.js | 301 +++++--- .../purecloud-platform-client-v2.min.js | 2 +- build/docs/AnalyticsApi.md | 283 ++++++- build/docs/ConversationsApi.md | 111 ++- build/docs/GroupsApi.md | 2 +- build/docs/JourneyApi.md | 4 +- build/docs/KnowledgeApi.md | 48 +- build/docs/LearningApi.md | 330 ++++++++ build/docs/OrganizationApi.md | 2 +- build/docs/RoutingApi.md | 12 - build/docs/SpeechTextAnalyticsApi.md | 326 ++++++++ build/docs/UsersApi.md | 2 +- build/docs/index.md | 4 +- build/docs/releaseNotes.md | 477 +++++++++--- build/index.d.ts | 700 +++++++++-------- build/package-lock.json | 28 +- build/package.json | 2 +- .../purecloud-platform-client-v2/ApiClient.js | 5 +- .../api/AlertingApi.js | 2 +- .../api/AnalyticsApi.js | 150 +++- .../api/ArchitectApi.js | 2 +- .../api/AuditApi.js | 2 +- .../api/AuthorizationApi.js | 2 +- .../api/BillingApi.js | 2 +- .../api/CarrierServicesApi.js | 2 +- .../api/ChatApi.js | 2 +- .../api/CoachingApi.js | 2 +- .../api/ContentManagementApi.js | 2 +- .../api/ConversationsApi.js | 58 +- .../api/DataExtensionsApi.js | 2 +- .../api/DownloadsApi.js | 2 +- .../api/EmailsApi.js | 2 +- .../api/EventsApi.js | 2 +- .../api/ExternalContactsApi.js | 2 +- .../api/FaxApi.js | 2 +- .../api/FlowsApi.js | 2 +- .../api/GamificationApi.js | 2 +- .../api/GeneralDataProtectionRegulationApi.js | 2 +- .../api/GeolocationApi.js | 2 +- .../api/GreetingsApi.js | 2 +- .../api/GroupsApi.js | 2 +- .../api/IdentityProviderApi.js | 2 +- .../api/InfrastructureAsCodeApi.js | 2 +- .../api/IntegrationsApi.js | 2 +- .../api/JourneyApi.js | 2 +- .../api/KnowledgeApi.js | 5 +- .../api/LanguageUnderstandingApi.js | 2 +- .../api/LanguagesApi.js | 2 +- .../api/LearningApi.js | 175 ++++- .../api/LicenseApi.js | 2 +- .../api/LocationsApi.js | 2 +- .../api/LogCaptureApi.js | 2 +- .../api/MessagingApi.js | 2 +- .../api/MobileDevicesApi.js | 2 +- .../api/NotificationsApi.js | 2 +- .../api/OAuthApi.js | 2 +- .../api/ObjectsApi.js | 2 +- .../api/OperationalEventsApi.js | 2 +- .../api/OrganizationApi.js | 2 +- .../api/OrganizationAuthorizationApi.js | 2 +- .../api/OutboundApi.js | 2 +- .../api/PresenceApi.js | 2 +- .../api/ProcessAutomationApi.js | 2 +- .../api/QualityApi.js | 2 +- .../api/RecordingApi.js | 2 +- .../api/ResponseManagementApi.js | 2 +- .../api/RoutingApi.js | 8 +- .../api/SCIMApi.js | 2 +- .../api/ScreenRecordingApi.js | 2 +- .../api/ScriptsApi.js | 2 +- .../api/SearchApi.js | 2 +- .../api/SettingsApi.js | 2 +- .../api/SpeechTextAnalyticsApi.js | 166 ++++- .../api/StationsApi.js | 2 +- .../api/SuggestApi.js | 2 +- .../api/TaskManagementApi.js | 2 +- .../api/TeamsApi.js | 2 +- .../api/TelephonyApi.js | 2 +- .../api/TelephonyProvidersEdgeApi.js | 2 +- .../api/TextbotsApi.js | 2 +- .../api/TokensApi.js | 2 +- .../api/UploadsApi.js | 2 +- .../api/UsageApi.js | 2 +- .../api/UserRecordingsApi.js | 2 +- .../api/UsersApi.js | 2 +- .../api/UtilitiesApi.js | 2 +- .../api/VoicemailApi.js | 2 +- .../api/WebChatApi.js | 2 +- .../api/WebDeploymentsApi.js | 2 +- .../api/WebMessagingApi.js | 2 +- .../api/WidgetsApi.js | 2 +- .../api/WorkforceManagementApi.js | 2 +- .../src/purecloud-platform-client-v2/index.js | 2 +- releaseNotes.md | 477 +++++++++--- swagger.json | 2 +- version.json | 6 +- 104 files changed, 4751 insertions(+), 1195 deletions(-) diff --git a/README.md b/README.md index 393b58f4..69171925 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ For direct use in a browser script: ```html - + diff --git a/build/.openapi-generator/FILES b/build/.openapi-generator/FILES index c672bb98..e10f1d4a 100644 --- a/build/.openapi-generator/FILES +++ b/build/.openapi-generator/FILES @@ -351,6 +351,7 @@ docs/deleteRoutingUtilizationTag-example.txt docs/deleteRoutingWrapupcode-example.txt docs/deleteScimUser-example.txt docs/deleteScimV2User-example.txt +docs/deleteSpeechandtextanalyticsCategory-example.txt docs/deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt docs/deleteSpeechandtextanalyticsProgram-example.txt docs/deleteSpeechandtextanalyticsSentimentfeedback-example.txt @@ -423,6 +424,8 @@ docs/getAlertingInteractionstatsRules-example.txt docs/getAlertingRule-example.txt docs/getAnalyticsActionsAggregatesJob-example.txt docs/getAnalyticsActionsAggregatesJobResults-example.txt +docs/getAnalyticsAgentcopilotsAggregatesJob-example.txt +docs/getAnalyticsAgentcopilotsAggregatesJobResults-example.txt docs/getAnalyticsBotflowDivisionsReportingturns-example.txt docs/getAnalyticsBotflowReportingturns-example.txt docs/getAnalyticsBotflowSessions-example.txt @@ -464,6 +467,7 @@ docs/getAnalyticsReportingDashboardsUsers-example.txt docs/getAnalyticsReportingExports-example.txt docs/getAnalyticsReportingExportsMetadata-example.txt docs/getAnalyticsReportingSettings-example.txt +docs/getAnalyticsReportingSettingsDashboardsQuery-example.txt docs/getAnalyticsReportingSettingsUserDashboards-example.txt docs/getAnalyticsResolutionsAggregatesJob-example.txt docs/getAnalyticsResolutionsAggregatesJobResults-example.txt @@ -666,7 +670,6 @@ docs/getConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt docs/getConversationsMessagingSetting-example.txt docs/getConversationsMessagingSettings-example.txt docs/getConversationsMessagingSettingsDefault-example.txt -docs/getConversationsMessagingSticker-example.txt docs/getConversationsMessagingSupportedcontent-example.txt docs/getConversationsMessagingSupportedcontentDefault-example.txt docs/getConversationsMessagingSupportedcontentSupportedContentId-example.txt @@ -988,15 +991,18 @@ docs/getLanguageunderstandingMinerTopics-example.txt docs/getLanguageunderstandingMiners-example.txt docs/getLanguageunderstandingSettings-example.txt docs/getLearningAssignment-example.txt +docs/getLearningAssignmentStep-example.txt docs/getLearningAssignments-example.txt docs/getLearningAssignmentsMe-example.txt docs/getLearningModule-example.txt docs/getLearningModuleJob-example.txt +docs/getLearningModulePreview-example.txt docs/getLearningModuleRule-example.txt docs/getLearningModuleVersion-example.txt docs/getLearningModules-example.txt docs/getLearningModulesAssignments-example.txt docs/getLearningModulesCoverartCoverArtId-example.txt +docs/getLearningScormScormId-example.txt docs/getLicenseDefinition-example.txt docs/getLicenseDefinitions-example.txt docs/getLicenseToggle-example.txt @@ -1290,7 +1296,10 @@ docs/getSearch-example.txt docs/getSearchSuggest-example.txt docs/getSearchSuggest-example.txt docs/getSettingsExecutiondata-example.txt +docs/getSpeechandtextanalyticsCategories-example.txt +docs/getSpeechandtextanalyticsCategory-example.txt docs/getSpeechandtextanalyticsConversation-example.txt +docs/getSpeechandtextanalyticsConversationCategories-example.txt docs/getSpeechandtextanalyticsConversationCommunicationTranscripturl-example.txt docs/getSpeechandtextanalyticsConversationCommunicationTranscripturls-example.txt docs/getSpeechandtextanalyticsDictionaryfeedback-example.txt @@ -1674,6 +1683,7 @@ docs/patchLanguageunderstandingDomain-example.txt docs/patchLanguageunderstandingMinerDraft-example.txt docs/patchLearningAssignment-example.txt docs/patchLearningAssignmentReschedule-example.txt +docs/patchLearningAssignmentStep-example.txt docs/patchLearningModuleUserAssignments-example.txt docs/patchLocation-example.txt docs/patchMessagingSetting-example.txt @@ -1761,6 +1771,8 @@ docs/postAlertingRulesBulkRemove-example.txt docs/postAlertingRulesQuery-example.txt docs/postAnalyticsActionsAggregatesJobs-example.txt docs/postAnalyticsActionsAggregatesQuery-example.txt +docs/postAnalyticsAgentcopilotsAggregatesJobs-example.txt +docs/postAnalyticsAgentcopilotsAggregatesQuery-example.txt docs/postAnalyticsBotsAggregatesJobs-example.txt docs/postAnalyticsBotsAggregatesQuery-example.txt docs/postAnalyticsConversationDetailsProperties-example.txt @@ -1927,6 +1939,7 @@ docs/postConversationsEmailMessages-example.txt docs/postConversationsEmailMessagesDraftAttachmentsCopy-example.txt docs/postConversationsEmailParticipantCommunicationWrapup-example.txt docs/postConversationsEmailParticipantReplace-example.txt +docs/postConversationsEmailReconnect-example.txt docs/postConversationsEmails-example.txt docs/postConversationsEmailsAgentless-example.txt docs/postConversationsFaxes-example.txt @@ -2124,6 +2137,7 @@ docs/postLearningModulePublish-example.txt docs/postLearningModules-example.txt docs/postLearningRulesQuery-example.txt docs/postLearningScheduleslotsQuery-example.txt +docs/postLearningScorm-example.txt docs/postLicenseInfer-example.txt docs/postLicenseOrganization-example.txt docs/postLicenseToggle-example.txt @@ -2251,6 +2265,7 @@ docs/postSearch-example.txt docs/postSearch-example.txt docs/postSearchSuggest-example.txt docs/postSearchSuggest-example.txt +docs/postSpeechandtextanalyticsCategories-example.txt docs/postSpeechandtextanalyticsDictionaryfeedback-example.txt docs/postSpeechandtextanalyticsPrograms-example.txt docs/postSpeechandtextanalyticsProgramsGeneralJobs-example.txt @@ -2507,6 +2522,7 @@ docs/putIntegrationsSpeechTtsSettings-example.txt docs/putIntegrationsUnifiedcommunicationThirdpartypresences-example.txt docs/putLanguageunderstandingDomainVersion-example.txt docs/putLearningModule-example.txt +docs/putLearningModulePreview-example.txt docs/putLearningModuleRule-example.txt docs/putMessagingSettingsDefault-example.txt docs/putMobiledevice-example.txt @@ -2585,6 +2601,7 @@ docs/putScimGroup-example.txt docs/putScimUser-example.txt docs/putScimV2Group-example.txt docs/putScimV2User-example.txt +docs/putSpeechandtextanalyticsCategory-example.txt docs/putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId-example.txt docs/putSpeechandtextanalyticsProgram-example.txt docs/putSpeechandtextanalyticsProgramMappings-example.txt diff --git a/build/APIData.json b/build/APIData.json index 417fef94..95e22b0c 100644 --- a/build/APIData.json +++ b/build/APIData.json @@ -426,6 +426,39 @@ "return": "ActionAsyncAggregateQueryResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet jobId = \"jobId_example\"; // String | jobId\nlet opts = { \n \"cursor\": \"cursor_example\" // String | Cursor token to retrieve next page\n};\n\n// Fetch a page of results for an async aggregates query\napiInstance.getAnalyticsActionsAggregatesJobResults(jobId, opts)\n .then((data) => {\n console.log(`getAnalyticsActionsAggregatesJobResults success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAnalyticsActionsAggregatesJobResults\");\n console.error(err);\n });" }, + "getanalyticsagentcopilotsaggregatesjob": { + "operationId": "getanalyticsagentcopilotsaggregatesjob", + "functionName": "getAnalyticsAgentcopilotsAggregatesJob", + "signature": "getAnalyticsAgentcopilotsAggregatesJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "AsyncQueryStatus", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet jobId = \"jobId_example\"; // String | jobId\n\n// Get status for async query for agent copilot aggregates\napiInstance.getAnalyticsAgentcopilotsAggregatesJob(jobId)\n .then((data) => {\n console.log(`getAnalyticsAgentcopilotsAggregatesJob success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAnalyticsAgentcopilotsAggregatesJob\");\n console.error(err);\n });" + }, + "getanalyticsagentcopilotsaggregatesjobresults": { + "operationId": "getanalyticsagentcopilotsaggregatesjobresults", + "functionName": "getAnalyticsAgentcopilotsAggregatesJobResults", + "signature": "getAnalyticsAgentcopilotsAggregatesJobResults(jobId, cursor)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "cursor", + "type": "String", + "required": "false" + } + ], + "return": "AgentCopilotAsyncAggregateQueryResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet jobId = \"jobId_example\"; // String | jobId\nlet opts = { \n \"cursor\": \"cursor_example\" // String | Cursor token to retrieve next page\n};\n\n// Fetch a page of results for an async aggregates query\napiInstance.getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts)\n .then((data) => {\n console.log(`getAnalyticsAgentcopilotsAggregatesJobResults success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAnalyticsAgentcopilotsAggregatesJobResults\");\n console.error(err);\n });" + }, "getanalyticsbotflowdivisionsreportingturns": { "operationId": "getanalyticsbotflowdivisionsreportingturns", "functionName": "getAnalyticsBotflowDivisionsReportingturns", @@ -955,6 +988,40 @@ "return": "AnalyticsReportingSettings", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\n// Get AnalyticsReportingSettings for an organization\napiInstance.getAnalyticsReportingSettings()\n .then((data) => {\n console.log(`getAnalyticsReportingSettings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAnalyticsReportingSettings\");\n console.error(err);\n });" }, + "getanalyticsreportingsettingsdashboardsquery": { + "operationId": "getanalyticsreportingsettingsdashboardsquery", + "functionName": "getAnalyticsReportingSettingsDashboardsQuery", + "signature": "getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, sortBy, pageNumber, pageSize)", + "parameters": [ + { + "name": "dashboardType", + "type": "String", + "required": "true" + }, + { + "name": "dashboardAccessFilter", + "type": "String", + "required": "true" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Number", + "required": "false" + }, + { + "name": "pageSize", + "type": "Number", + "required": "false" + } + ], + "return": "DashboardConfigurationListing", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet dashboardType = \"dashboardType_example\"; // String | List dashboard of given type\nlet dashboardAccessFilter = \"dashboardAccessFilter_example\"; // String | Filter dashboard based on the owner of dashboard\nlet opts = { \n \"sortBy\": \"desc\", // String | \n \"pageNumber\": 1, // Number | \n \"pageSize\": 9 // Number | \n};\n\n// Get list of dashboard configurations\napiInstance.getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts)\n .then((data) => {\n console.log(`getAnalyticsReportingSettingsDashboardsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAnalyticsReportingSettingsDashboardsQuery\");\n console.error(err);\n });" + }, "getanalyticsreportingsettingsuserdashboards": { "operationId": "getanalyticsreportingsettingsuserdashboards", "functionName": "getAnalyticsReportingSettingsUserDashboards", @@ -1251,6 +1318,34 @@ "return": "ActionAggregateQueryResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet body = {}; // Object | query\n\n// Query for action aggregates\napiInstance.postAnalyticsActionsAggregatesQuery(body)\n .then((data) => {\n console.log(`postAnalyticsActionsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postAnalyticsActionsAggregatesQuery\");\n console.error(err);\n });" }, + "postanalyticsagentcopilotsaggregatesjobs": { + "operationId": "postanalyticsagentcopilotsaggregatesjobs", + "functionName": "postAnalyticsAgentcopilotsAggregatesJobs", + "signature": "postAnalyticsAgentcopilotsAggregatesJobs(body)", + "parameters": [ + { + "name": "body", + "type": "Object", + "required": "true" + } + ], + "return": "AsyncQueryResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet body = {}; // Object | query\n\n// Query for agent copilot aggregates asynchronously\napiInstance.postAnalyticsAgentcopilotsAggregatesJobs(body)\n .then((data) => {\n console.log(`postAnalyticsAgentcopilotsAggregatesJobs success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postAnalyticsAgentcopilotsAggregatesJobs\");\n console.error(err);\n });" + }, + "postanalyticsagentcopilotsaggregatesquery": { + "operationId": "postanalyticsagentcopilotsaggregatesquery", + "functionName": "postAnalyticsAgentcopilotsAggregatesQuery", + "signature": "postAnalyticsAgentcopilotsAggregatesQuery(body)", + "parameters": [ + { + "name": "body", + "type": "Object", + "required": "true" + } + ], + "return": "AgentCopilotAggregateQueryResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet body = {}; // Object | query\n\n// Query for agent copilot aggregates\napiInstance.postAnalyticsAgentcopilotsAggregatesQuery(body)\n .then((data) => {\n console.log(`postAnalyticsAgentcopilotsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postAnalyticsAgentcopilotsAggregatesQuery\");\n console.error(err);\n });" + }, "postanalyticsbotsaggregatesjobs": { "operationId": "postanalyticsbotsaggregatesjobs", "functionName": "postAnalyticsBotsAggregatesJobs", @@ -1596,7 +1691,7 @@ } ], "return": "RateLimitAggregateQueryResponse", - "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet body = {}; // Object | query\n\n// Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded\napiInstance.postAnalyticsRatelimitsAggregatesQuery(body)\n .then((data) => {\n console.log(`postAnalyticsRatelimitsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postAnalyticsRatelimitsAggregatesQuery\");\n console.error(err);\n });" + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.AnalyticsApi();\n\nlet body = {}; // Object | query\n\n// Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.\napiInstance.postAnalyticsRatelimitsAggregatesQuery(body)\n .then((data) => {\n console.log(`postAnalyticsRatelimitsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postAnalyticsRatelimitsAggregatesQuery\");\n console.error(err);\n });" }, "postanalyticsreportingdashboardsusersbulkremove": { "operationId": "postanalyticsreportingdashboardsusersbulkremove", @@ -9597,30 +9692,6 @@ "return": "MessagingSetting", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ConversationsApi();\n\n// Get the organization's default settings that will be used as the default when creating an integration.\napiInstance.getConversationsMessagingSettingsDefault()\n .then((data) => {\n console.log(`getConversationsMessagingSettingsDefault success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getConversationsMessagingSettingsDefault\");\n console.error(err);\n });" }, - "getconversationsmessagingsticker": { - "operationId": "getconversationsmessagingsticker", - "functionName": "getConversationsMessagingSticker", - "signature": "getConversationsMessagingSticker(messengerType, pageSize, pageNumber)", - "parameters": [ - { - "name": "messengerType", - "type": "String", - "required": "true" - }, - { - "name": "pageSize", - "type": "Number", - "required": "false" - }, - { - "name": "pageNumber", - "type": "Number", - "required": "false" - } - ], - "return": "MessagingStickerEntityListing", - "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ConversationsApi();\n\nlet messengerType = \"messengerType_example\"; // String | Messenger Type\nlet opts = { \n \"pageSize\": 25, // Number | Page size\n \"pageNumber\": 1 // Number | Page number\n};\n\n// Get a list of Messaging Stickers (Deprecated)\napiInstance.getConversationsMessagingSticker(messengerType, opts)\n .then((data) => {\n console.log(`getConversationsMessagingSticker success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getConversationsMessagingSticker\");\n console.error(err);\n });" - }, "getconversationsmessagingsupportedcontent": { "operationId": "getconversationsmessagingsupportedcontent", "functionName": "getConversationsMessagingSupportedcontent", @@ -11543,6 +11614,19 @@ ], "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ConversationsApi();\n\nlet conversationId = \"conversationId_example\"; // String | conversationId\nlet participantId = \"participantId_example\"; // String | participantId\nlet body = {}; // Object | Transfer request\n\n// Replace this participant with the specified user and/or address\napiInstance.postConversationsEmailParticipantReplace(conversationId, participantId, body)\n .then(() => {\n console.log(\"postConversationsEmailParticipantReplace returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling postConversationsEmailParticipantReplace\");\n console.error(err);\n });" }, + "postconversationsemailreconnect": { + "operationId": "postconversationsemailreconnect", + "functionName": "postConversationsEmailReconnect", + "signature": "postConversationsEmailReconnect(conversationId)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + } + ], + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ConversationsApi();\n\nlet conversationId = \"conversationId_example\"; // String | conversationId\n\n// Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation\napiInstance.postConversationsEmailReconnect(conversationId)\n .then(() => {\n console.log(\"postConversationsEmailReconnect returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling postConversationsEmailReconnect\");\n console.error(err);\n });" + }, "postconversationsemails": { "operationId": "postconversationsemails", "functionName": "postConversationsEmails", @@ -19131,7 +19215,7 @@ "operationId": "getjourneyviews", "functionName": "getJourneyViews", "signature": "getJourneyViews()", - "return": "AddressableEntityListing", + "return": "JourneyViewListing", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.JourneyApi();\n\n// Get a list of Journey Views\napiInstance.getJourneyViews()\n .then((data) => {\n console.log(`getJourneyViews success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getJourneyViews\");\n console.error(err);\n });" }, "getjourneyviewseventdefinition": { @@ -20640,7 +20724,7 @@ "getknowledgeknowledgebaseoperations": { "operationId": "getknowledgeknowledgebaseoperations", "functionName": "getKnowledgeKnowledgebaseOperations", - "signature": "getKnowledgeKnowledgebaseOperations(knowledgeBaseId, before, after, pageSize, userId, type, status, interval)", + "signature": "getKnowledgeKnowledgebaseOperations(knowledgeBaseId, before, after, pageSize, userId, type, status, interval, sourceId)", "parameters": [ { "name": "knowledgeBaseId", @@ -20681,10 +20765,15 @@ "name": "interval", "type": "String", "required": "false" + }, + { + "name": "sourceId", + "type": "[String]", + "required": "false" } ], "return": "OperationListing", - "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.KnowledgeApi();\n\nlet knowledgeBaseId = \"knowledgeBaseId_example\"; // String | Knowledge base ID\nlet opts = { \n \"before\": \"before_example\", // String | The cursor that points to the start of the set of entities that has been returned.\n \"after\": \"after_example\", // String | The cursor that points to the end of the set of entities that has been returned.\n \"pageSize\": \"pageSize_example\", // String | Number of entities to return. Maximum of 200.\n \"userId\": [\"userId_example\"], // [String] | If specified, retrieves operations associated with user ids, comma separated values expected.\n \"type\": [\"type_example\"], // [String] | If specified, retrieves operations with specified operation type, comma separated values expected.\n \"status\": [\"status_example\"], // [String] | If specified, retrieves operations with specified operation status, comma separated values expected.\n \"interval\": \"interval_example\" // String | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ\n};\n\n// Get operations\napiInstance.getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts)\n .then((data) => {\n console.log(`getKnowledgeKnowledgebaseOperations success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getKnowledgeKnowledgebaseOperations\");\n console.error(err);\n });" + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.KnowledgeApi();\n\nlet knowledgeBaseId = \"knowledgeBaseId_example\"; // String | Knowledge base ID\nlet opts = { \n \"before\": \"before_example\", // String | The cursor that points to the start of the set of entities that has been returned.\n \"after\": \"after_example\", // String | The cursor that points to the end of the set of entities that has been returned.\n \"pageSize\": \"pageSize_example\", // String | Number of entities to return. Maximum of 200.\n \"userId\": [\"userId_example\"], // [String] | If specified, retrieves operations associated with user ids, comma separated values expected.\n \"type\": [\"type_example\"], // [String] | If specified, retrieves operations with specified operation type, comma separated values expected.\n \"status\": [\"status_example\"], // [String] | If specified, retrieves operations with specified operation status, comma separated values expected.\n \"interval\": \"interval_example\", // String | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ\n \"sourceId\": [\"sourceId_example\"] // [String] | If specified, retrieves operations associated with source ids, comma separated values expected.\n};\n\n// Get operations\napiInstance.getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts)\n .then((data) => {\n console.log(`getKnowledgeKnowledgebaseOperations success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getKnowledgeKnowledgebaseOperations\");\n console.error(err);\n });" }, "getknowledgeknowledgebaseoperationsusersquery": { "operationId": "getknowledgeknowledgebaseoperationsusersquery", @@ -22848,6 +22937,35 @@ "return": "LearningAssignment", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet assignmentId = \"assignmentId_example\"; // String | The ID of Learning Assignment\nlet opts = { \n \"expand\": [\"expand_example\"] // [String] | Fields to expand in response\n};\n\n// Get Learning Assignment\napiInstance.getLearningAssignment(assignmentId, opts)\n .then((data) => {\n console.log(`getLearningAssignment success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningAssignment\");\n console.error(err);\n });" }, + "getlearningassignmentstep": { + "operationId": "getlearningassignmentstep", + "functionName": "getLearningAssignmentStep", + "signature": "getLearningAssignmentStep(assignmentId, stepId, shareableContentObjectId, expand)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + }, + { + "name": "stepId", + "type": "String", + "required": "true" + }, + { + "name": "shareableContentObjectId", + "type": "String", + "required": "false" + }, + { + "name": "expand", + "type": "[String]", + "required": "false" + } + ], + "return": "LearningAssignmentStep", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet assignmentId = \"assignmentId_example\"; // String | The ID of Learning Assignment\nlet stepId = \"stepId_example\"; // String | The ID of Learning Assignment Step\nlet opts = { \n \"shareableContentObjectId\": \"shareableContentObjectId_example\", // String | The ID of SCO to load\n \"expand\": [\"expand_example\"] // [String] | Fields to expand in response\n};\n\n// Get Learning Assignment Step\napiInstance.getLearningAssignmentStep(assignmentId, stepId, opts)\n .then((data) => {\n console.log(`getLearningAssignmentStep success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningAssignmentStep\");\n console.error(err);\n });" + }, "getlearningassignments": { "operationId": "getlearningassignments", "functionName": "getLearningAssignments", @@ -23049,6 +23167,20 @@ "return": "LearningModuleJobResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\nlet jobId = \"jobId_example\"; // String | The ID of the learning module job\n\n// Get a specific Learning Module job status\napiInstance.getLearningModuleJob(moduleId, jobId)\n .then((data) => {\n console.log(`getLearningModuleJob success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningModuleJob\");\n console.error(err);\n });" }, + "getlearningmodulepreview": { + "operationId": "getlearningmodulepreview", + "functionName": "getLearningModulePreview", + "signature": "getLearningModulePreview(moduleId)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + } + ], + "return": "LearningModulePreviewGetResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\n\n// Get a learning module preview\napiInstance.getLearningModulePreview(moduleId)\n .then((data) => {\n console.log(`getLearningModulePreview success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningModulePreview\");\n console.error(err);\n });" + }, "getlearningmodulerule": { "operationId": "getlearningmodulerule", "functionName": "getLearningModuleRule", @@ -23209,6 +23341,20 @@ "return": "LearningModuleCoverArtResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet coverArtId = \"coverArtId_example\"; // String | Key identifier for the cover art\n\n// Get a specific Learning Module cover art using ID\napiInstance.getLearningModulesCoverartCoverArtId(coverArtId)\n .then((data) => {\n console.log(`getLearningModulesCoverartCoverArtId success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningModulesCoverartCoverArtId\");\n console.error(err);\n });" }, + "getlearningscormscormid": { + "operationId": "getlearningscormscormid", + "functionName": "getLearningScormScormId", + "signature": "getLearningScormScormId(scormId)", + "parameters": [ + { + "name": "scormId", + "type": "String", + "required": "true" + } + ], + "return": "LearningScormResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet scormId = \"scormId_example\"; // String | The ID of the SCORM package\n\n// Get Learning SCORM Result\napiInstance.getLearningScormScormId(scormId)\n .then((data) => {\n console.log(`getLearningScormScormId success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningScormScormId\");\n console.error(err);\n });" + }, "patchlearningassignment": { "operationId": "patchlearningassignment", "functionName": "patchLearningAssignment", @@ -23247,6 +23393,30 @@ "return": "LearningAssignment", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet assignmentId = \"assignmentId_example\"; // String | The ID of Learning Assignment\nlet opts = { \n \"body\": {} // Object | The Learning assignment reschedule model\n};\n\n// Reschedule Learning Assignment\napiInstance.patchLearningAssignmentReschedule(assignmentId, opts)\n .then((data) => {\n console.log(`patchLearningAssignmentReschedule success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchLearningAssignmentReschedule\");\n console.error(err);\n });" }, + "patchlearningassignmentstep": { + "operationId": "patchlearningassignmentstep", + "functionName": "patchLearningAssignmentStep", + "signature": "patchLearningAssignmentStep(assignmentId, stepId, body)", + "parameters": [ + { + "name": "assignmentId", + "type": "String", + "required": "true" + }, + { + "name": "stepId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Object", + "required": "false" + } + ], + "return": "LearningAssignmentStep", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet assignmentId = \"assignmentId_example\"; // String | The ID of Learning Assignment\nlet stepId = \"stepId_example\"; // String | The ID of Learning Assignment Step\nlet opts = { \n \"body\": {} // Object | The Learning Assignment Step to be updated\n};\n\n// Update Learning Assignment Step\napiInstance.patchLearningAssignmentStep(assignmentId, stepId, opts)\n .then((data) => {\n console.log(`patchLearningAssignmentStep success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchLearningAssignmentStep\");\n console.error(err);\n });" + }, "patchlearningmoduleuserassignments": { "operationId": "patchlearningmoduleuserassignments", "functionName": "patchLearningModuleUserAssignments", @@ -23459,6 +23629,20 @@ "return": "LearningScheduleSlotsQueryResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet body = {}; // Object | The slot search request\n\n// Get list of possible slots where a learning activity can be scheduled.\napiInstance.postLearningScheduleslotsQuery(body)\n .then((data) => {\n console.log(`postLearningScheduleslotsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postLearningScheduleslotsQuery\");\n console.error(err);\n });" }, + "postlearningscorm": { + "operationId": "postlearningscorm", + "functionName": "postLearningScorm", + "signature": "postLearningScorm(body)", + "parameters": [ + { + "name": "body", + "type": "Object", + "required": "false" + } + ], + "return": "LearningScormUploadResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet opts = { \n \"body\": {} // Object | The SCORM package to be uploaded\n};\n\n// Create a SCORM package upload request\napiInstance.postLearningScorm(opts)\n .then((data) => {\n console.log(`postLearningScorm success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postLearningScorm\");\n console.error(err);\n });" + }, "putlearningmodule": { "operationId": "putlearningmodule", "functionName": "putLearningModule", @@ -23478,6 +23662,25 @@ "return": "LearningModule", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\nlet body = {}; // Object | The learning module to be updated\n\n// Update a learning module\napiInstance.putLearningModule(moduleId, body)\n .then((data) => {\n console.log(`putLearningModule success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putLearningModule\");\n console.error(err);\n });" }, + "putlearningmodulepreview": { + "operationId": "putlearningmodulepreview", + "functionName": "putLearningModulePreview", + "signature": "putLearningModulePreview(moduleId, body)", + "parameters": [ + { + "name": "moduleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Object", + "required": "true" + } + ], + "return": "LearningModulePreviewUpdateResponse", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\nlet body = {}; // Object | The learning module to be updated\n\n// Update a learning module preview\napiInstance.putLearningModulePreview(moduleId, body)\n .then((data) => {\n console.log(`putLearningModulePreview success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putLearningModulePreview\");\n console.error(err);\n });" + }, "putlearningmodulerule": { "operationId": "putlearningmodulerule", "functionName": "putLearningModuleRule", @@ -36474,6 +36677,19 @@ "return": "ExecutionDataGlobalSettingsResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SettingsApi();\n\nlet body = {}; // Object | New Execution Data Setting\n\n// Edit the execution history on off setting.\napiInstance.patchSettingsExecutiondata(body)\n .then((data) => {\n console.log(`patchSettingsExecutiondata success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchSettingsExecutiondata\");\n console.error(err);\n });" }, + "deletespeechandtextanalyticscategory": { + "operationId": "deletespeechandtextanalyticscategory", + "functionName": "deleteSpeechandtextanalyticsCategory", + "signature": "deleteSpeechandtextanalyticsCategory(categoryId)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + } + ], + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet categoryId = \"categoryId_example\"; // String | The id of the category\n\n// Delete a Speech and Text Analytics category by ID\napiInstance.deleteSpeechandtextanalyticsCategory(categoryId)\n .then(() => {\n console.log(\"deleteSpeechandtextanalyticsCategory returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteSpeechandtextanalyticsCategory\");\n console.error(err);\n });" + }, "deletespeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid": { "operationId": "deletespeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", "functionName": "deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", @@ -36537,6 +36753,59 @@ ], "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet topicId = \"topicId_example\"; // String | The id of the topic\n\n// Delete a Speech and Text Analytics topic by id\napiInstance.deleteSpeechandtextanalyticsTopic(topicId)\n .then(() => {\n console.log(\"deleteSpeechandtextanalyticsTopic returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteSpeechandtextanalyticsTopic\");\n console.error(err);\n });" }, + "getspeechandtextanalyticscategories": { + "operationId": "getspeechandtextanalyticscategories", + "functionName": "getSpeechandtextanalyticsCategories", + "signature": "getSpeechandtextanalyticsCategories(pageSize, pageNumber, name, sortOrder, sortBy, ids)", + "parameters": [ + { + "name": "pageSize", + "type": "Number", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Number", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "sortBy", + "type": "String", + "required": "false" + }, + { + "name": "ids", + "type": "[String]", + "required": "false" + } + ], + "return": "CategoriesEntityListing", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | The page size for the listing. The max that will be returned is 50.\n \"pageNumber\": 1, // Number | The page number for the listing\n \"name\": \"name_example\", // String | The category name filter applied to the listing\n \"sortOrder\": \"asc\", // String | The sort order for the listing\n \"sortBy\": \"name\", // String | The field to sort by for the listing\n \"ids\": [\"ids_example\"] // [String] | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.\n};\n\n// Get the list of Speech and Text Analytics categories\napiInstance.getSpeechandtextanalyticsCategories(opts)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsCategories success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsCategories\");\n console.error(err);\n });" + }, + "getspeechandtextanalyticscategory": { + "operationId": "getspeechandtextanalyticscategory", + "functionName": "getSpeechandtextanalyticsCategory", + "signature": "getSpeechandtextanalyticsCategory(categoryId)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + } + ], + "return": "StaCategory", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet categoryId = \"categoryId_example\"; // String | The id of the category\n\n// Get a Speech and Text Analytics Category by ID\napiInstance.getSpeechandtextanalyticsCategory(categoryId)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsCategory success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsCategory\");\n console.error(err);\n });" + }, "getspeechandtextanalyticsconversation": { "operationId": "getspeechandtextanalyticsconversation", "functionName": "getSpeechandtextanalyticsConversation", @@ -36551,6 +36820,30 @@ "return": "ConversationMetrics", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet conversationId = \"conversationId_example\"; // String | Conversation Id\n\n// Get Speech and Text Analytics for a specific conversation\napiInstance.getSpeechandtextanalyticsConversation(conversationId)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsConversation success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsConversation\");\n console.error(err);\n });" }, + "getspeechandtextanalyticsconversationcategories": { + "operationId": "getspeechandtextanalyticsconversationcategories", + "functionName": "getSpeechandtextanalyticsConversationCategories", + "signature": "getSpeechandtextanalyticsConversationCategories(conversationId, pageSize, pageNumber)", + "parameters": [ + { + "name": "conversationId", + "type": "String", + "required": "true" + }, + { + "name": "pageSize", + "type": "Number", + "required": "false" + }, + { + "name": "pageNumber", + "type": "Number", + "required": "false" + } + ], + "return": "ConversationCategoriesEntityListing", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet conversationId = \"conversationId_example\"; // String | The id of the conversation\nlet opts = { \n \"pageSize\": 25, // Number | The page size for the listing. The max that will be returned is 50.\n \"pageNumber\": 1 // Number | The page number for the listing\n};\n\n// Get the list of detected Speech and Text Analytics categories of conversation\napiInstance.getSpeechandtextanalyticsConversationCategories(conversationId, opts)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsConversationCategories success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsConversationCategories\");\n console.error(err);\n });" + }, "getspeechandtextanalyticsconversationcommunicationtranscripturl": { "operationId": "getspeechandtextanalyticsconversationcommunicationtranscripturl", "functionName": "getSpeechandtextanalyticsConversationCommunicationTranscripturl", @@ -36920,6 +37213,20 @@ "return": "SpeechTextAnalyticsSettingsResponse", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet body = {}; // Object | Speech And Text Analytics Settings\n\n// Patch Speech And Text Analytics Settings\napiInstance.patchSpeechandtextanalyticsSettings(body)\n .then((data) => {\n console.log(`patchSpeechandtextanalyticsSettings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchSpeechandtextanalyticsSettings\");\n console.error(err);\n });" }, + "postspeechandtextanalyticscategories": { + "operationId": "postspeechandtextanalyticscategories", + "functionName": "postSpeechandtextanalyticsCategories", + "signature": "postSpeechandtextanalyticsCategories(body)", + "parameters": [ + { + "name": "body", + "type": "Object", + "required": "true" + } + ], + "return": "StaCategory", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet body = {}; // Object | The category to create\n\n// Create new Speech and Text Analytics category\napiInstance.postSpeechandtextanalyticsCategories(body)\n .then((data) => {\n console.log(`postSpeechandtextanalyticsCategories success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postSpeechandtextanalyticsCategories\");\n console.error(err);\n });" + }, "postspeechandtextanalyticsdictionaryfeedback": { "operationId": "postspeechandtextanalyticsdictionaryfeedback", "functionName": "postSpeechandtextanalyticsDictionaryfeedback", @@ -37018,6 +37325,25 @@ "return": "TopicJob", "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet body = {}; // Object | The publish topics job to create\n\n// Create new Speech and Text Analytics publish topics job\napiInstance.postSpeechandtextanalyticsTopicsPublishjobs(body)\n .then((data) => {\n console.log(`postSpeechandtextanalyticsTopicsPublishjobs success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postSpeechandtextanalyticsTopicsPublishjobs\");\n console.error(err);\n });" }, + "putspeechandtextanalyticscategory": { + "operationId": "putspeechandtextanalyticscategory", + "functionName": "putSpeechandtextanalyticsCategory", + "signature": "putSpeechandtextanalyticsCategory(categoryId, body)", + "parameters": [ + { + "name": "categoryId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "Object", + "required": "true" + } + ], + "return": "StaCategory", + "example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.SpeechTextAnalyticsApi();\n\nlet categoryId = \"categoryId_example\"; // String | The id of the category\nlet body = {}; // Object | The updated category\n\n// Update a Speech and Text Analytics category by ID\napiInstance.putSpeechandtextanalyticsCategory(categoryId, body)\n .then((data) => {\n console.log(`putSpeechandtextanalyticsCategory success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putSpeechandtextanalyticsCategory\");\n console.error(err);\n });" + }, "putspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid": { "operationId": "putspeechandtextanalyticsdictionaryfeedbackdictionaryfeedbackid", "functionName": "putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId", diff --git a/build/README.md b/build/README.md index 393b58f4..69171925 100644 --- a/build/README.md +++ b/build/README.md @@ -31,7 +31,7 @@ For direct use in a browser script: ```html - + diff --git a/build/dist/node/purecloud-platform-client-v2.js b/build/dist/node/purecloud-platform-client-v2.js index df52eb74..8ff9d171 100644 --- a/build/dist/node/purecloud-platform-client-v2.js +++ b/build/dist/node/purecloud-platform-client-v2.js @@ -405,7 +405,7 @@ class Configuration { /** * @module purecloud-platform-client-v2/ApiClient - * @version 194.0.0 + * @version 195.0.0 */ class ApiClient { /** @@ -1480,6 +1480,9 @@ class ApiClient { if (param instanceof Date) { return param.toJSON(); } + if (param instanceof Boolean) { + return param.toString().toLowerCase(); + } return param.toString(); } @@ -1824,7 +1827,7 @@ class AlertingApi { /** * Alerting service. * @module purecloud-platform-client-v2/api/AlertingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -2485,7 +2488,7 @@ class AnalyticsApi { /** * Analytics service. * @module purecloud-platform-client-v2/api/AnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -2606,6 +2609,62 @@ class AnalyticsApi { ); } + /** + * Get status for async query for agent copilot aggregates + * + * @param {String} jobId jobId + * getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJob(jobId) { + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}', + 'GET', + { 'jobId': jobId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Fetch a page of results for an async aggregates query + * + * @param {String} jobId jobId + * @param {Object} opts Optional parameters + * @param {String} opts.cursor Cursor token to retrieve next page + * getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) { + opts = opts || {}; + + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results', + 'GET', + { 'jobId': jobId }, + { 'cursor': opts['cursor'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Reporting Turns (division aware). * Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. @@ -3364,6 +3423,42 @@ class AnalyticsApi { ); } + /** + * Get list of dashboard configurations + * + * @param {Object} dashboardType List dashboard of given type + * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard + * @param {Object} opts Optional parameters + * @param {String} opts.sortBy (default to desc) + * @param {Number} opts.pageNumber (default to 1) + * @param {Number} opts.pageSize (default to 9) + */ + getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) { + opts = opts || {}; + + // verify the required parameter 'dashboardType' is set + if (dashboardType === undefined || dashboardType === null) { + throw 'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + // verify the required parameter 'dashboardAccessFilter' is set + if (dashboardAccessFilter === undefined || dashboardAccessFilter === null) { + throw 'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/reporting/settings/dashboards/query', + 'GET', + { }, + { 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get list of dashboards for an user * @@ -3829,6 +3924,58 @@ class AnalyticsApi { ); } + /** + * Query for agent copilot aggregates asynchronously + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesJobs(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Query for agent copilot aggregates + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesQuery(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/query', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Query for bot aggregates asynchronously * @@ -4402,8 +4549,8 @@ class AnalyticsApi { } /** - * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded - * + * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + * The max property can be used to determine estimated rate limit value hit. * @param {Object} body query */ postAnalyticsRatelimitsAggregatesQuery(body) { @@ -4953,7 +5100,7 @@ class ArchitectApi { /** * Architect service. * @module purecloud-platform-client-v2/api/ArchitectApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -9099,7 +9246,7 @@ class AuditApi { /** * Audit service. * @module purecloud-platform-client-v2/api/AuditApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -9299,7 +9446,7 @@ class AuthorizationApi { /** * Authorization service. * @module purecloud-platform-client-v2/api/AuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10537,7 +10684,7 @@ class BillingApi { /** * Billing service. * @module purecloud-platform-client-v2/api/BillingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10617,7 +10764,7 @@ class CarrierServicesApi { /** * CarrierServices service. * @module purecloud-platform-client-v2/api/CarrierServicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10687,7 +10834,7 @@ class ChatApi { /** * Chat service. * @module purecloud-platform-client-v2/api/ChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -11623,7 +11770,7 @@ class CoachingApi { /** * Coaching service. * @module purecloud-platform-client-v2/api/CoachingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -12200,7 +12347,7 @@ class ContentManagementApi { /** * ContentManagement service. * @module purecloud-platform-client-v2/api/ContentManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -13282,7 +13429,7 @@ class ConversationsApi { /** * Conversations service. * @module purecloud-platform-client-v2/api/ConversationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -15690,37 +15837,6 @@ class ConversationsApi { ); } - /** - * Get a list of Messaging Stickers (Deprecated) - * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - * @param {Object} messengerType Messenger Type - * @param {Object} opts Optional parameters - * @param {Number} opts.pageSize Page size (default to 25) - * @param {Number} opts.pageNumber Page number (default to 1) - * @deprecated - */ - getConversationsMessagingSticker(messengerType, opts) { - opts = opts || {}; - - // verify the required parameter 'messengerType' is set - if (messengerType === undefined || messengerType === null) { - throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker'; - } - - return this.apiClient.callApi( - '/api/v2/conversations/messaging/stickers/{messengerType}', - 'GET', - { 'messengerType': messengerType }, - { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, - { }, - { }, - null, - ['PureCloud OAuth'], - ['application/json'], - ['application/json'] - ); - } - /** * Get a list of Supported Content profiles * @@ -18823,6 +18939,31 @@ class ConversationsApi { ); } + /** + * Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + * + * @param {String} conversationId conversationId + */ + postConversationsEmailReconnect(conversationId) { + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect'; + } + + return this.apiClient.callApi( + '/api/v2/conversations/emails/{conversationId}/reconnect', + 'POST', + { 'conversationId': conversationId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create an email conversation * If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. @@ -20239,7 +20380,7 @@ class DataExtensionsApi { /** * DataExtensions service. * @module purecloud-platform-client-v2/api/DataExtensionsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20325,7 +20466,7 @@ class DownloadsApi { /** * Downloads service. * @module purecloud-platform-client-v2/api/DownloadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20377,7 +20518,7 @@ class EmailsApi { /** * Emails service. * @module purecloud-platform-client-v2/api/EmailsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20442,7 +20583,7 @@ class EventsApi { /** * Events service. * @module purecloud-platform-client-v2/api/EventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20538,7 +20679,7 @@ class ExternalContactsApi { /** * ExternalContacts service. * @module purecloud-platform-client-v2/api/ExternalContactsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22496,7 +22637,7 @@ class FaxApi { /** * Fax service. * @module purecloud-platform-client-v2/api/FaxApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22711,7 +22852,7 @@ class FlowsApi { /** * Flows service. * @module purecloud-platform-client-v2/api/FlowsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22894,7 +23035,7 @@ class GamificationApi { /** * Gamification service. * @module purecloud-platform-client-v2/api/GamificationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -24980,7 +25121,7 @@ class GeneralDataProtectionRegulationApi { /** * GeneralDataProtectionRegulation service. * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25110,7 +25251,7 @@ class GeolocationApi { /** * Geolocation service. * @module purecloud-platform-client-v2/api/GeolocationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25241,7 +25382,7 @@ class GreetingsApi { /** * Greetings service. * @module purecloud-platform-client-v2/api/GreetingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25696,7 +25837,7 @@ class GroupsApi { /** * Groups service. * @module purecloud-platform-client-v2/api/GroupsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -26215,7 +26356,7 @@ class IdentityProviderApi { /** * IdentityProvider service. * @module purecloud-platform-client-v2/api/IdentityProviderApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -27076,7 +27217,7 @@ class InfrastructureAsCodeApi { /** * InfrastructureAsCode service. * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -27243,7 +27384,7 @@ class IntegrationsApi { /** * Integrations service. * @module purecloud-platform-client-v2/api/IntegrationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -29595,7 +29736,7 @@ class JourneyApi { /** * Journey service. * @module purecloud-platform-client-v2/api/JourneyApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -31184,7 +31325,7 @@ class KnowledgeApi { /** * Knowledge service. * @module purecloud-platform-client-v2/api/KnowledgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -32538,6 +32679,7 @@ class KnowledgeApi { * @param {Array.} opts.type If specified, retrieves operations with specified operation type, comma separated values expected. * @param {Array.} opts.status If specified, retrieves operations with specified operation status, comma separated values expected. * @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + * @param {Array.} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected. * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) { @@ -32552,7 +32694,7 @@ class KnowledgeApi { '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations', 'GET', { 'knowledgeBaseId': knowledgeBaseId }, - { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] }, + { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'],'sourceId': this.apiClient.buildCollectionParam(opts['sourceId'], 'multi') }, { }, { }, null, @@ -34427,7 +34569,7 @@ class LanguageUnderstandingApi { /** * LanguageUnderstanding service. * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35461,7 +35603,7 @@ class LanguagesApi { /** * Languages service. * @module purecloud-platform-client-v2/api/LanguagesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35683,7 +35825,7 @@ class LearningApi { /** * Learning service. * @module purecloud-platform-client-v2/api/LearningApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35777,6 +35919,41 @@ class LearningApi { ); } + /** + * Get Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {String} opts.shareableContentObjectId The ID of SCO to load + * @param {Array.} opts.expand Fields to expand in response + */ + getLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'GET', + { 'assignmentId': assignmentId,'stepId': stepId }, + { 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * List of Learning module Assignments * Either moduleId or user value is required @@ -35911,6 +36088,31 @@ class LearningApi { ); } + /** + * Get a learning module preview + * + * @param {String} moduleId The ID of the learning module + */ + getLearningModulePreview(moduleId) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'GET', + { 'moduleId': moduleId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get a learning module rule * @@ -36063,6 +36265,31 @@ class LearningApi { ); } + /** + * Get Learning SCORM Result + * + * @param {String} scormId The ID of the SCORM package + */ + getLearningScormScormId(scormId) { + // verify the required parameter 'scormId' is set + if (scormId === undefined || scormId === null) { + throw 'Missing the required parameter "scormId" when calling getLearningScormScormId'; + } + + return this.apiClient.callApi( + '/api/v2/learning/scorm/{scormId}', + 'GET', + { 'scormId': scormId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update Learning Assignment * @@ -36121,6 +36348,40 @@ class LearningApi { ); } + /** + * Update Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {Object} opts.body The Learning Assignment Step to be updated + */ + patchLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'PATCH', + { 'assignmentId': assignmentId,'stepId': stepId }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update an external assignment for a specific user * @@ -36472,6 +36733,30 @@ class LearningApi { ); } + /** + * Create a SCORM package upload request + * + * @param {Object} opts Optional parameters + * @param {Object} opts.body The SCORM package to be uploaded + */ + postLearningScorm(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/learning/scorm', + 'POST', + { }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module * This will update the name, description, completion time in days and inform steps for a learning module @@ -36502,6 +36787,36 @@ class LearningApi { ); } + /** + * Update a learning module preview + * This will update a learning module preview + * @param {String} moduleId The ID of the learning module + * @param {Object} body The learning module to be updated + */ + putLearningModulePreview(moduleId, body) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'PUT', + { 'moduleId': moduleId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module rule * This will update a learning module rule with the specified fields. @@ -36538,7 +36853,7 @@ class LicenseApi { /** * License service. * @module purecloud-platform-client-v2/api/LicenseApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -36776,7 +37091,7 @@ class LocationsApi { /** * Locations service. * @module purecloud-platform-client-v2/api/LocationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37012,7 +37327,7 @@ class LogCaptureApi { /** * LogCapture service. * @module purecloud-platform-client-v2/api/LogCaptureApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37212,7 +37527,7 @@ class MessagingApi { /** * Messaging service. * @module purecloud-platform-client-v2/api/MessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37571,7 +37886,7 @@ class MobileDevicesApi { /** * MobileDevices service. * @module purecloud-platform-client-v2/api/MobileDevicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37722,7 +38037,7 @@ class NotificationsApi { /** * Notifications service. * @module purecloud-platform-client-v2/api/NotificationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37955,7 +38270,7 @@ class OAuthApi { /** * OAuth service. * @module purecloud-platform-client-v2/api/OAuthApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38321,7 +38636,7 @@ class ObjectsApi { /** * Objects service. * @module purecloud-platform-client-v2/api/ObjectsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38591,7 +38906,7 @@ class OperationalEventsApi { /** * OperationalEvents service. * @module purecloud-platform-client-v2/api/OperationalEventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38657,7 +38972,7 @@ class OrganizationApi { /** * Organization service. * @module purecloud-platform-client-v2/api/OrganizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -39132,7 +39447,7 @@ class OrganizationAuthorizationApi { /** * OrganizationAuthorization service. * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -40479,7 +40794,7 @@ class OutboundApi { /** * Outbound service. * @module purecloud-platform-client-v2/api/OutboundApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -44845,7 +45160,7 @@ class PresenceApi { /** * Presence service. * @module purecloud-platform-client-v2/api/PresenceApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -45589,7 +45904,7 @@ class ProcessAutomationApi { /** * ProcessAutomation service. * @module purecloud-platform-client-v2/api/ProcessAutomationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -45828,7 +46143,7 @@ class QualityApi { /** * Quality service. * @module purecloud-platform-client-v2/api/QualityApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -47585,7 +47900,7 @@ class RecordingApi { /** * Recording service. * @module purecloud-platform-client-v2/api/RecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -49243,7 +49558,7 @@ class ResponseManagementApi { /** * ResponseManagement service. * @module purecloud-platform-client-v2/api/ResponseManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -49753,7 +50068,7 @@ class RoutingApi { /** * Routing service. * @module purecloud-platform-client-v2/api/RoutingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -50214,7 +50529,6 @@ class RoutingApi { * @param {String} labelId Utilization Label ID * @param {Object} opts Optional parameters * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false) - * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ deleteRoutingUtilizationLabel(labelId, opts) { opts = opts || {}; @@ -51733,7 +52047,6 @@ class RoutingApi { * Get details about this utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabel(labelId) { // verify the required parameter 'labelId' is set @@ -51759,7 +52072,6 @@ class RoutingApi { * Get list of agent ids associated with a utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabelAgents(labelId) { // verify the required parameter 'labelId' is set @@ -51789,7 +52101,6 @@ class RoutingApi { * @param {Number} opts.pageNumber Page number (default to 1) * @param {Object} opts.sortOrder Sort order by name (default to ascending) * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' - * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabels(opts) { opts = opts || {}; @@ -53212,7 +53523,6 @@ class RoutingApi { * Create a utilization label * * @param {Object} body UtilizationLabel - * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ postRoutingUtilizationLabels(body) { // verify the required parameter 'body' is set @@ -53605,7 +53915,6 @@ class RoutingApi { * * @param {String} labelId Utilization Label ID * @param {Object} body UtilizationLabel - * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ putRoutingUtilizationLabel(labelId, body) { // verify the required parameter 'labelId' is set @@ -53732,7 +54041,7 @@ class SCIMApi { /** * SCIM service. * @module purecloud-platform-client-v2/api/SCIMApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -54609,7 +54918,7 @@ class ScreenRecordingApi { /** * ScreenRecording service. * @module purecloud-platform-client-v2/api/ScreenRecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -54654,7 +54963,7 @@ class ScriptsApi { /** * Scripts service. * @module purecloud-platform-client-v2/api/ScriptsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55098,7 +55407,7 @@ class SearchApi { /** * Search service. * @module purecloud-platform-client-v2/api/SearchApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55787,7 +56096,7 @@ class SettingsApi { /** * Settings service. * @module purecloud-platform-client-v2/api/SettingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55899,7 +56208,7 @@ class SpeechTextAnalyticsApi { /** * SpeechTextAnalytics service. * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55914,6 +56223,31 @@ class SpeechTextAnalyticsApi { } + /** + * Delete a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + */ + deleteSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'DELETE', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Delete a Speech and Text Analytics DictionaryFeedback by Id * @@ -56038,6 +56372,60 @@ class SpeechTextAnalyticsApi { ); } + /** + * Get the list of Speech and Text Analytics categories + * + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + * @param {String} opts.name The category name filter applied to the listing + * @param {Object} opts.sortOrder The sort order for the listing (default to asc) + * @param {Object} opts.sortBy The field to sort by for the listing (default to name) + * @param {Array.} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. + */ + getSpeechandtextanalyticsCategories(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'GET', + { }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Get a Speech and Text Analytics Category by ID + * + * @param {String} categoryId The id of the category + */ + getSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'GET', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Speech and Text Analytics for a specific conversation * @@ -56063,6 +56451,36 @@ class SpeechTextAnalyticsApi { ); } + /** + * Get the list of detected Speech and Text Analytics categories of conversation + * + * @param {String} conversationId The id of the conversation + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + */ + getSpeechandtextanalyticsConversationCategories(conversationId, opts) { + opts = opts || {}; + + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/conversations/{conversationId}/categories', + 'GET', + { 'conversationId': conversationId }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation * @@ -56633,6 +57051,31 @@ class SpeechTextAnalyticsApi { ); } + /** + * Create new Speech and Text Analytics category + * + * @param {Object} body The category to create + */ + postSpeechandtextanalyticsCategories(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create a Speech and Text Analytics DictionaryFeedback * @@ -56833,6 +57276,36 @@ class SpeechTextAnalyticsApi { ); } + /** + * Update a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + * @param {Object} body The updated category + */ + putSpeechandtextanalyticsCategory(categoryId, body) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'PUT', + { 'categoryId': categoryId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update existing Speech and Text Analytics dictionary feedback by id * @@ -57013,7 +57486,7 @@ class StationsApi { /** * Stations service. * @module purecloud-platform-client-v2/api/StationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -57115,7 +57588,7 @@ class SuggestApi { /** * Suggest service. * @module purecloud-platform-client-v2/api/SuggestApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -57254,7 +57727,7 @@ class TaskManagementApi { /** * TaskManagement service. * @module purecloud-platform-client-v2/api/TaskManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -58602,7 +59075,7 @@ class TeamsApi { /** * Teams service. * @module purecloud-platform-client-v2/api/TeamsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -58903,7 +59376,7 @@ class TelephonyApi { /** * Telephony service. * @module purecloud-platform-client-v2/api/TelephonyApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -59085,7 +59558,7 @@ class TelephonyProvidersEdgeApi { /** * TelephonyProvidersEdge service. * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62413,7 +62886,7 @@ class TextbotsApi { /** * Textbots service. * @module purecloud-platform-client-v2/api/TextbotsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62541,7 +63014,7 @@ class TokensApi { /** * Tokens service. * @module purecloud-platform-client-v2/api/TokensApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62695,7 +63168,7 @@ class UploadsApi { /** * Uploads service. * @module purecloud-platform-client-v2/api/UploadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62964,7 +63437,7 @@ class UsageApi { /** * Usage service. * @module purecloud-platform-client-v2/api/UsageApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -63179,7 +63652,7 @@ class UserRecordingsApi { /** * UserRecordings service. * @module purecloud-platform-client-v2/api/UserRecordingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -63364,7 +63837,7 @@ class UsersApi { /** * Users service. * @module purecloud-platform-client-v2/api/UsersApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66022,7 +66495,7 @@ class UtilitiesApi { /** * Utilities service. * @module purecloud-platform-client-v2/api/UtilitiesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66133,7 +66606,7 @@ class VoicemailApi { /** * Voicemail service. * @module purecloud-platform-client-v2/api/VoicemailApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66800,7 +67273,7 @@ class WebChatApi { /** * WebChat service. * @module purecloud-platform-client-v2/api/WebChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67351,7 +67824,7 @@ class WebDeploymentsApi { /** * WebDeployments service. * @module purecloud-platform-client-v2/api/WebDeploymentsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67878,7 +68351,7 @@ class WebMessagingApi { /** * WebMessaging service. * @module purecloud-platform-client-v2/api/WebMessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67924,7 +68397,7 @@ class WidgetsApi { /** * Widgets service. * @module purecloud-platform-client-v2/api/WidgetsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -68070,7 +68543,7 @@ class WorkforceManagementApi { /** * WorkforceManagement service. * @module purecloud-platform-client-v2/api/WorkforceManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -73983,7 +74456,7 @@ class WorkforceManagementApi { * *

* @module purecloud-platform-client-v2/index - * @version 194.0.0 + * @version 195.0.0 */ class platformClient { constructor() { diff --git a/build/dist/web-amd/purecloud-platform-client-v2.js b/build/dist/web-amd/purecloud-platform-client-v2.js index 7db66055..428223e3 100644 --- a/build/dist/web-amd/purecloud-platform-client-v2.js +++ b/build/dist/web-amd/purecloud-platform-client-v2.js @@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * @module purecloud-platform-client-v2/ApiClient - * @version 194.0.0 + * @version 195.0.0 */ class ApiClient { /** @@ -1477,6 +1477,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form if (param instanceof Date) { return param.toJSON(); } + if (param instanceof Boolean) { + return param.toString().toLowerCase(); + } return param.toString(); } @@ -1821,7 +1824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Alerting service. * @module purecloud-platform-client-v2/api/AlertingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -2482,7 +2485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Analytics service. * @module purecloud-platform-client-v2/api/AnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -2603,6 +2606,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get status for async query for agent copilot aggregates + * + * @param {String} jobId jobId + * getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJob(jobId) { + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}', + 'GET', + { 'jobId': jobId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Fetch a page of results for an async aggregates query + * + * @param {String} jobId jobId + * @param {Object} opts Optional parameters + * @param {String} opts.cursor Cursor token to retrieve next page + * getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) { + opts = opts || {}; + + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results', + 'GET', + { 'jobId': jobId }, + { 'cursor': opts['cursor'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Reporting Turns (division aware). * Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. @@ -3361,6 +3420,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get list of dashboard configurations + * + * @param {Object} dashboardType List dashboard of given type + * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard + * @param {Object} opts Optional parameters + * @param {String} opts.sortBy (default to desc) + * @param {Number} opts.pageNumber (default to 1) + * @param {Number} opts.pageSize (default to 9) + */ + getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) { + opts = opts || {}; + + // verify the required parameter 'dashboardType' is set + if (dashboardType === undefined || dashboardType === null) { + throw 'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + // verify the required parameter 'dashboardAccessFilter' is set + if (dashboardAccessFilter === undefined || dashboardAccessFilter === null) { + throw 'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/reporting/settings/dashboards/query', + 'GET', + { }, + { 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get list of dashboards for an user * @@ -3826,6 +3921,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Query for agent copilot aggregates asynchronously + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesJobs(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Query for agent copilot aggregates + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesQuery(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/query', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Query for bot aggregates asynchronously * @@ -4399,8 +4546,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form } /** - * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded - * + * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + * The max property can be used to determine estimated rate limit value hit. * @param {Object} body query */ postAnalyticsRatelimitsAggregatesQuery(body) { @@ -4950,7 +5097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Architect service. * @module purecloud-platform-client-v2/api/ArchitectApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -9096,7 +9243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Audit service. * @module purecloud-platform-client-v2/api/AuditApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -9296,7 +9443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Authorization service. * @module purecloud-platform-client-v2/api/AuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10534,7 +10681,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Billing service. * @module purecloud-platform-client-v2/api/BillingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10614,7 +10761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * CarrierServices service. * @module purecloud-platform-client-v2/api/CarrierServicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -10684,7 +10831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Chat service. * @module purecloud-platform-client-v2/api/ChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -11620,7 +11767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Coaching service. * @module purecloud-platform-client-v2/api/CoachingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -12197,7 +12344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * ContentManagement service. * @module purecloud-platform-client-v2/api/ContentManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -13279,7 +13426,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Conversations service. * @module purecloud-platform-client-v2/api/ConversationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -15687,37 +15834,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } - /** - * Get a list of Messaging Stickers (Deprecated) - * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - * @param {Object} messengerType Messenger Type - * @param {Object} opts Optional parameters - * @param {Number} opts.pageSize Page size (default to 25) - * @param {Number} opts.pageNumber Page number (default to 1) - * @deprecated - */ - getConversationsMessagingSticker(messengerType, opts) { - opts = opts || {}; - - // verify the required parameter 'messengerType' is set - if (messengerType === undefined || messengerType === null) { - throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker'; - } - - return this.apiClient.callApi( - '/api/v2/conversations/messaging/stickers/{messengerType}', - 'GET', - { 'messengerType': messengerType }, - { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, - { }, - { }, - null, - ['PureCloud OAuth'], - ['application/json'], - ['application/json'] - ); - } - /** * Get a list of Supported Content profiles * @@ -18820,6 +18936,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + * + * @param {String} conversationId conversationId + */ + postConversationsEmailReconnect(conversationId) { + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect'; + } + + return this.apiClient.callApi( + '/api/v2/conversations/emails/{conversationId}/reconnect', + 'POST', + { 'conversationId': conversationId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create an email conversation * If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. @@ -20236,7 +20377,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * DataExtensions service. * @module purecloud-platform-client-v2/api/DataExtensionsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20322,7 +20463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Downloads service. * @module purecloud-platform-client-v2/api/DownloadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20374,7 +20515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Emails service. * @module purecloud-platform-client-v2/api/EmailsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20439,7 +20580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Events service. * @module purecloud-platform-client-v2/api/EventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20535,7 +20676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * ExternalContacts service. * @module purecloud-platform-client-v2/api/ExternalContactsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22493,7 +22634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Fax service. * @module purecloud-platform-client-v2/api/FaxApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22708,7 +22849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Flows service. * @module purecloud-platform-client-v2/api/FlowsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -22891,7 +23032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Gamification service. * @module purecloud-platform-client-v2/api/GamificationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -24977,7 +25118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * GeneralDataProtectionRegulation service. * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25107,7 +25248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Geolocation service. * @module purecloud-platform-client-v2/api/GeolocationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25238,7 +25379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Greetings service. * @module purecloud-platform-client-v2/api/GreetingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -25693,7 +25834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Groups service. * @module purecloud-platform-client-v2/api/GroupsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -26212,7 +26353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * IdentityProvider service. * @module purecloud-platform-client-v2/api/IdentityProviderApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -27073,7 +27214,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * InfrastructureAsCode service. * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -27240,7 +27381,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Integrations service. * @module purecloud-platform-client-v2/api/IntegrationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -29592,7 +29733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Journey service. * @module purecloud-platform-client-v2/api/JourneyApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -31181,7 +31322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Knowledge service. * @module purecloud-platform-client-v2/api/KnowledgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -32535,6 +32676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * @param {Array.} opts.type If specified, retrieves operations with specified operation type, comma separated values expected. * @param {Array.} opts.status If specified, retrieves operations with specified operation status, comma separated values expected. * @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + * @param {Array.} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected. * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) { @@ -32549,7 +32691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations', 'GET', { 'knowledgeBaseId': knowledgeBaseId }, - { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] }, + { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'],'sourceId': this.apiClient.buildCollectionParam(opts['sourceId'], 'multi') }, { }, { }, null, @@ -34424,7 +34566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * LanguageUnderstanding service. * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35458,7 +35600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Languages service. * @module purecloud-platform-client-v2/api/LanguagesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35680,7 +35822,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Learning service. * @module purecloud-platform-client-v2/api/LearningApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -35774,6 +35916,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {String} opts.shareableContentObjectId The ID of SCO to load + * @param {Array.} opts.expand Fields to expand in response + */ + getLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'GET', + { 'assignmentId': assignmentId,'stepId': stepId }, + { 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * List of Learning module Assignments * Either moduleId or user value is required @@ -35908,6 +36085,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get a learning module preview + * + * @param {String} moduleId The ID of the learning module + */ + getLearningModulePreview(moduleId) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'GET', + { 'moduleId': moduleId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get a learning module rule * @@ -36060,6 +36262,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get Learning SCORM Result + * + * @param {String} scormId The ID of the SCORM package + */ + getLearningScormScormId(scormId) { + // verify the required parameter 'scormId' is set + if (scormId === undefined || scormId === null) { + throw 'Missing the required parameter "scormId" when calling getLearningScormScormId'; + } + + return this.apiClient.callApi( + '/api/v2/learning/scorm/{scormId}', + 'GET', + { 'scormId': scormId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update Learning Assignment * @@ -36118,6 +36345,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Update Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {Object} opts.body The Learning Assignment Step to be updated + */ + patchLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'PATCH', + { 'assignmentId': assignmentId,'stepId': stepId }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update an external assignment for a specific user * @@ -36469,6 +36730,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Create a SCORM package upload request + * + * @param {Object} opts Optional parameters + * @param {Object} opts.body The SCORM package to be uploaded + */ + postLearningScorm(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/learning/scorm', + 'POST', + { }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module * This will update the name, description, completion time in days and inform steps for a learning module @@ -36499,6 +36784,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Update a learning module preview + * This will update a learning module preview + * @param {String} moduleId The ID of the learning module + * @param {Object} body The learning module to be updated + */ + putLearningModulePreview(moduleId, body) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'PUT', + { 'moduleId': moduleId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module rule * This will update a learning module rule with the specified fields. @@ -36535,7 +36850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * License service. * @module purecloud-platform-client-v2/api/LicenseApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -36773,7 +37088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Locations service. * @module purecloud-platform-client-v2/api/LocationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37009,7 +37324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * LogCapture service. * @module purecloud-platform-client-v2/api/LogCaptureApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37209,7 +37524,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Messaging service. * @module purecloud-platform-client-v2/api/MessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37568,7 +37883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * MobileDevices service. * @module purecloud-platform-client-v2/api/MobileDevicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37719,7 +38034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Notifications service. * @module purecloud-platform-client-v2/api/NotificationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -37952,7 +38267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * OAuth service. * @module purecloud-platform-client-v2/api/OAuthApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38318,7 +38633,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Objects service. * @module purecloud-platform-client-v2/api/ObjectsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38588,7 +38903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * OperationalEvents service. * @module purecloud-platform-client-v2/api/OperationalEventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -38654,7 +38969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Organization service. * @module purecloud-platform-client-v2/api/OrganizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -39129,7 +39444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * OrganizationAuthorization service. * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -40476,7 +40791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Outbound service. * @module purecloud-platform-client-v2/api/OutboundApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -44842,7 +45157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Presence service. * @module purecloud-platform-client-v2/api/PresenceApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -45586,7 +45901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * ProcessAutomation service. * @module purecloud-platform-client-v2/api/ProcessAutomationApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -45825,7 +46140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Quality service. * @module purecloud-platform-client-v2/api/QualityApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -47582,7 +47897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Recording service. * @module purecloud-platform-client-v2/api/RecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -49240,7 +49555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * ResponseManagement service. * @module purecloud-platform-client-v2/api/ResponseManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -49750,7 +50065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Routing service. * @module purecloud-platform-client-v2/api/RoutingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -50211,7 +50526,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * @param {String} labelId Utilization Label ID * @param {Object} opts Optional parameters * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false) - * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ deleteRoutingUtilizationLabel(labelId, opts) { opts = opts || {}; @@ -51730,7 +52044,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * Get details about this utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabel(labelId) { // verify the required parameter 'labelId' is set @@ -51756,7 +52069,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * Get list of agent ids associated with a utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabelAgents(labelId) { // verify the required parameter 'labelId' is set @@ -51786,7 +52098,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * @param {Number} opts.pageNumber Page number (default to 1) * @param {Object} opts.sortOrder Sort order by name (default to ascending) * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' - * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabels(opts) { opts = opts || {}; @@ -53209,7 +53520,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * Create a utilization label * * @param {Object} body UtilizationLabel - * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ postRoutingUtilizationLabels(body) { // verify the required parameter 'body' is set @@ -53602,7 +53912,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * * @param {String} labelId Utilization Label ID * @param {Object} body UtilizationLabel - * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ putRoutingUtilizationLabel(labelId, body) { // verify the required parameter 'labelId' is set @@ -53729,7 +54038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * SCIM service. * @module purecloud-platform-client-v2/api/SCIMApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -54606,7 +54915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * ScreenRecording service. * @module purecloud-platform-client-v2/api/ScreenRecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -54651,7 +54960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Scripts service. * @module purecloud-platform-client-v2/api/ScriptsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55095,7 +55404,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Search service. * @module purecloud-platform-client-v2/api/SearchApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55784,7 +56093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Settings service. * @module purecloud-platform-client-v2/api/SettingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55896,7 +56205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * SpeechTextAnalytics service. * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -55911,6 +56220,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form } + /** + * Delete a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + */ + deleteSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'DELETE', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Delete a Speech and Text Analytics DictionaryFeedback by Id * @@ -56035,6 +56369,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get the list of Speech and Text Analytics categories + * + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + * @param {String} opts.name The category name filter applied to the listing + * @param {Object} opts.sortOrder The sort order for the listing (default to asc) + * @param {Object} opts.sortBy The field to sort by for the listing (default to name) + * @param {Array.} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. + */ + getSpeechandtextanalyticsCategories(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'GET', + { }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Get a Speech and Text Analytics Category by ID + * + * @param {String} categoryId The id of the category + */ + getSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'GET', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Speech and Text Analytics for a specific conversation * @@ -56060,6 +56448,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Get the list of detected Speech and Text Analytics categories of conversation + * + * @param {String} conversationId The id of the conversation + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + */ + getSpeechandtextanalyticsConversationCategories(conversationId, opts) { + opts = opts || {}; + + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/conversations/{conversationId}/categories', + 'GET', + { 'conversationId': conversationId }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation * @@ -56630,6 +57048,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Create new Speech and Text Analytics category + * + * @param {Object} body The category to create + */ + postSpeechandtextanalyticsCategories(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create a Speech and Text Analytics DictionaryFeedback * @@ -56830,6 +57273,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form ); } + /** + * Update a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + * @param {Object} body The updated category + */ + putSpeechandtextanalyticsCategory(categoryId, body) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'PUT', + { 'categoryId': categoryId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update existing Speech and Text Analytics dictionary feedback by id * @@ -57010,7 +57483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Stations service. * @module purecloud-platform-client-v2/api/StationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -57112,7 +57585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Suggest service. * @module purecloud-platform-client-v2/api/SuggestApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -57251,7 +57724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * TaskManagement service. * @module purecloud-platform-client-v2/api/TaskManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -58599,7 +59072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Teams service. * @module purecloud-platform-client-v2/api/TeamsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -58900,7 +59373,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Telephony service. * @module purecloud-platform-client-v2/api/TelephonyApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -59082,7 +59555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * TelephonyProvidersEdge service. * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62410,7 +62883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Textbots service. * @module purecloud-platform-client-v2/api/TextbotsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62538,7 +63011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Tokens service. * @module purecloud-platform-client-v2/api/TokensApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62692,7 +63165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Uploads service. * @module purecloud-platform-client-v2/api/UploadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -62961,7 +63434,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Usage service. * @module purecloud-platform-client-v2/api/UsageApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -63176,7 +63649,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * UserRecordings service. * @module purecloud-platform-client-v2/api/UserRecordingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -63361,7 +63834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Users service. * @module purecloud-platform-client-v2/api/UsersApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66019,7 +66492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Utilities service. * @module purecloud-platform-client-v2/api/UtilitiesApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66130,7 +66603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Voicemail service. * @module purecloud-platform-client-v2/api/VoicemailApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -66797,7 +67270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * WebChat service. * @module purecloud-platform-client-v2/api/WebChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67348,7 +67821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * WebDeployments service. * @module purecloud-platform-client-v2/api/WebDeploymentsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67875,7 +68348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * WebMessaging service. * @module purecloud-platform-client-v2/api/WebMessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -67921,7 +68394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * Widgets service. * @module purecloud-platform-client-v2/api/WidgetsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -68067,7 +68540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form /** * WorkforceManagement service. * @module purecloud-platform-client-v2/api/WorkforceManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -73980,7 +74453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form * *

* @module purecloud-platform-client-v2/index - * @version 194.0.0 + * @version 195.0.0 */ class platformClient { constructor() { diff --git a/build/dist/web-amd/purecloud-platform-client-v2.min.js b/build/dist/web-amd/purecloud-platform-client-v2.min.js index cfb838ce..97a5cd37 100644 --- a/build/dist/web-amd/purecloud-platform-client-v2.min.js +++ b/build/dist/web-amd/purecloud-platform-client-v2.min.js @@ -1 +1 @@ -define(["axios","qs"],function(e,i){"use strict";function t(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var n=t(e),a=t(i),o={us_east_1:"mypurecloud.com",eu_west_1:"mypurecloud.ie",ap_southeast_2:"mypurecloud.com.au",ap_northeast_1:"mypurecloud.jp",eu_central_1:"mypurecloud.de",us_west_2:"usw2.pure.cloud",ca_central_1:"cac1.pure.cloud",ap_northeast_2:"apne2.pure.cloud",eu_west_2:"euw2.pure.cloud",ap_south_1:"aps1.pure.cloud",us_east_2:"use2.us-gov-pure.cloud",sa_east_1:"sae1.pure.cloud",me_central_1:"mec1.pure.cloud",ap_northeast_3:"apne3.pure.cloud",eu_central_2:"euc2.pure.cloud"};const r={levels:{none:0,error:1,debug:2,trace:3}},l={level:{LNone:"none",LError:"error",LDebug:"debug",LTrace:"trace"}},s={formats:{JSON:"json",TEXT:"text"}};class p{get logLevelEnum(){return l}get logFormatEnum(){return s}constructor(){this.log_level=l.level.LNone,this.log_format=s.formats.TEXT,this.log_to_console=!0,this.log_file_path,this.log_response_body=!1,this.log_request_body=!1,this.setLogger()}setLogger(){if("undefined"==typeof window){const e=require("winston");this.logger=e.createLogger({levels:r.levels,level:this.log_level}),this.log_file_path&&""!==this.log_file_path&&(this.log_format===s.formats.JSON?this.logger.add(new e.transports.File({format:e.format.json(),filename:this.log_file_path})):this.logger.add(new e.transports.File({format:e.format.combine(e.format(e=>(e.level=e.level.toUpperCase(),e))(),e.format.simple()),filename:this.log_file_path}))),this.log_to_console&&(this.log_format===s.formats.JSON?this.logger.add(new e.transports.Console({format:e.format.json()})):this.logger.add(new e.transports.Console({format:e.format.combine(e.format(e=>(e.level=e.level.toUpperCase(),e))(),e.format.simple())})))}}log(e,i,t,n,a,o,r,l){var s=this.formatLog(e,i,t,n,a,o,r,l);"undefined"!=typeof window?this.calculateLogLevel(e)>0&&!0===this.log_to_console&&(this.log_format===this.logFormatEnum.formats.JSON?console.log(s):console.log(`${e.toUpperCase()}: ${s}`)):this.logger.transports.length>0&&this.logger.log(e,s)}calculateLogLevel(e){switch(this.log_level){case this.logLevelEnum.level.LError:return e!==this.logLevelEnum.level.LError?-1:1;case this.logLevelEnum.level.LDebug:return e===this.logLevelEnum.level.LTrace?-1:1;case this.logLevelEnum.level.LTrace:return 1;default:return-1}}formatLog(e,i,t,n,a,o,r,l){var p,u=a?JSON.parse(JSON.stringify(a)):null,d=o?JSON.parse(JSON.stringify(o)):null,c=r?JSON.parse(JSON.stringify(r)):null,g=l?JSON.parse(JSON.stringify(l)):null;return a&&(u.Authorization="[REDACTED]"),this.log_request_body||(c=void 0),this.log_response_body||(g=void 0),this.log_format&&this.log_format===s.formats.JSON?(p={level:e,date:(new Date).toISOString(),method:t,url:decodeURIComponent(n),correlationId:d&&d["inin-correlation-id"]?d["inin-correlation-id"]:"",statusCode:i},u&&(p.requestHeaders=u),d&&(p.responseHeaders=d),c&&(p.requestBody=c),g&&(p.responseBody=g)):p=`${(new Date).toISOString()}\n=== REQUEST === \n${this.formatValue("URL",decodeURIComponent(n))}${this.formatValue("Method",t)}${this.formatValue("Headers",this.formatHeaderString(u))}${this.formatValue("Body",c?JSON.stringify(c,null,2):"")}\n=== RESPONSE ===\n${this.formatValue("Status",i)}${this.formatValue("Headers",this.formatHeaderString(d))}${this.formatValue("CorrelationId",d&&d["inin-correlation-id"]?d["inin-correlation-id"]:"")}${this.formatValue("Body",g?JSON.stringify(g,null,2):"")}`,p}formatHeaderString(e){var i="";if(!e)return i;for(const[t,n]of Object.entries(e))i+=`\n\t${t}: ${n}`;return i}formatValue(e,i){return i&&""!==i&&"{}"!==i?`${e}: ${i}\n`:""}getLogLevel(e){switch(e){case"error":return l.level.LError;case"debug":return l.level.LDebug;case"trace":return l.level.LTrace;default:return l.level.LNone}}getLogFormat(e){switch(e){case"json":return s.formats.JSON;default:return s.formats.TEXT}}}class u{get instance(){return u.instance}set instance(e){u.instance=e}constructor(){if(u.instance||(u.instance=this),"undefined"!=typeof window)this.configPath="";else{const e=require("os"),i=require("path");this.configPath=i.join(e.homedir(),".genesyscloudjavascript","config")}this.refresh_access_token=!0,this.refresh_token_wait_max=10,this.live_reload_config=!0,this.host,this.environment,this.basePath,this.authUrl,this.config,this.logger=new p,this.setEnvironment(),this.liveLoadConfig()}liveLoadConfig(){if("undefined"!=typeof window)this.configPath="";else if(this.updateConfigFromFile(),this.live_reload_config&&!0===this.live_reload_config)try{const e=require("fs");e.watchFile(this.configPath,{persistent:!1},(i,t)=>{this.updateConfigFromFile(),this.live_reload_config||e.unwatchFile(this.configPath)})}catch(e){}}setConfigPath(e){e&&e!==this.configPath&&(this.configPath=e,this.liveLoadConfig())}updateConfigFromFile(){if("undefined"==typeof window){const t=require("configparser");try{var e=new t;e.read(this.configPath),this.config=e}catch(e){if(e.name&&"MissingSectionHeaderError"===e.name){var i=require("fs").readFileSync(this.configPath,"utf8");this.config={_sections:JSON.parse(i)}}}this.config&&this.updateConfigValues()}}updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString("logging","log_level")),this.logger.log_format=this.logger.getLogFormat(this.getConfigString("logging","log_format")),this.logger.log_to_console=void 0!==this.getConfigBoolean("logging","log_to_console")?this.getConfigBoolean("logging","log_to_console"):this.logger.log_to_console,this.logger.log_file_path=void 0!==this.getConfigString("logging","log_file_path")?this.getConfigString("logging","log_file_path"):this.logger.log_file_path,this.logger.log_response_body=void 0!==this.getConfigBoolean("logging","log_response_body")?this.getConfigBoolean("logging","log_response_body"):this.logger.log_response_body,this.logger.log_request_body=void 0!==this.getConfigBoolean("logging","log_request_body")?this.getConfigBoolean("logging","log_request_body"):this.logger.log_request_body,this.refresh_access_token=void 0!==this.getConfigBoolean("reauthentication","refresh_access_token")?this.getConfigBoolean("reauthentication","refresh_access_token"):this.refresh_access_token,this.refresh_token_wait_max=void 0!==this.getConfigInt("reauthentication","refresh_token_wait_max")?this.getConfigInt("reauthentication","refresh_token_wait_max"):this.refresh_token_wait_max,this.live_reload_config=void 0!==this.getConfigBoolean("general","live_reload_config")?this.getConfigBoolean("general","live_reload_config"):this.live_reload_config,this.host=void 0!==this.getConfigString("general","host")?this.getConfigString("general","host"):this.host,this.setEnvironment(),this.logger.setLogger()}setEnvironment(e){this.environment=e||(this.host?this.host:"mypurecloud.com"),this.environment=this.environment.replace(/\/+$/,""),this.environment.startsWith("https://")&&(this.environment=this.environment.substring(8)),this.environment.startsWith("http://")&&(this.environment=this.environment.substring(7)),this.environment.startsWith("api.")&&(this.environment=this.environment.substring(4)),this.basePath=`https://api.${this.environment}`,this.authUrl=`https://login.${this.environment}`}getConfigString(e,i){if(this.config._sections[e])return this.config._sections[e][i]}getConfigBoolean(e,i){if(this.config._sections[e]&&void 0!==this.config._sections[e][i])return"string"==typeof this.config._sections[e][i]?"true"===this.config._sections[e][i]:this.config._sections[e][i]}getConfigInt(e,i){if(this.config._sections[e]&&this.config._sections[e][i])return"string"==typeof this.config._sections[e][i]?parseInt(this.config._sections[e][i]):this.config._sections[e][i]}}class d{get instance(){return d.instance}set instance(e){d.instance=e}constructor(){d.instance||(d.instance=this),this.CollectionFormatEnum={CSV:",",SSV:" ",TSV:"\t",PIPES:"|",MULTI:"multi"};try{localStorage.setItem("purecloud_local_storage_test","purecloud_local_storage_test"),localStorage.removeItem("purecloud_local_storage_test"),this.hasLocalStorage=!0}catch(e){this.hasLocalStorage=!1}this.authentications={"Guest Chat JWT":{type:"apiKey",in:"header",name:"Authorization"},"PureCloud OAuth":{type:"oauth2"}},this.defaultHeaders={},this.timeout=16e3,this.authData={},this.settingsPrefix="purecloud",this.refreshInProgress=!1,this.config=new u,"undefined"!=typeof window&&(window.ApiClient=this)}setReturnExtendedResponses(e){this.returnExtended=e}setPersistSettings(e,i){this.persistSettings=e,this.settingsPrefix=i?i.replace(/\W+/g,"_"):"purecloud"}_saveSettings(e){try{if(this.authData.accessToken=e.accessToken,this.authentications["PureCloud OAuth"].accessToken=e.accessToken,e.state&&(this.authData.state=e.state),this.authData.error=e.error,this.authData.error_description=e.error_description,e.tokenExpiryTime&&(this.authData.tokenExpiryTime=e.tokenExpiryTime,this.authData.tokenExpiryTimeString=e.tokenExpiryTimeString),!0!==this.persistSettings)return;if(!this.hasLocalStorage)return;let i=JSON.parse(JSON.stringify(this.authData));delete i.state,localStorage.setItem(`${this.settingsPrefix}_auth_data`,JSON.stringify(i))}catch(e){console.error(e)}}_loadSettings(){if(!0!==this.persistSettings)return;if(!this.hasLocalStorage)return;const e=this.authData.state;this.authData=localStorage.getItem(`${this.settingsPrefix}_auth_data`),this.authData?this.authData=JSON.parse(this.authData):this.authData={},this.authData.accessToken&&this.setAccessToken(this.authData.accessToken),this.authData.state=e}setEnvironment(e){this.config.setEnvironment(e)}loginImplicitGrant(e,i,t){const n=this._setValuesFromUrlHash();return this.clientId=e,this.redirectUri=i,t||(t={}),new Promise((e,i)=>{if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),n&&n.error)return n.accessToken=void 0,this._saveSettings(n),i(new Error(`[${n.error}] ${n.error_description}`));this._testTokenAccess().then(()=>{!this.authData.state&&t.state&&(this.authData.state=t.state),e(this.authData)}).catch(e=>{var i={client_id:encodeURIComponent(this.clientId),redirect_uri:encodeURIComponent(this.redirectUri),response_type:"token"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=this._buildAuthUrl("oauth/authorize",i);window.location.replace(n)})})}loginClientCredentialsGrant(e,i){this.clientId=e;var t=Buffer.from(`${e}:${i}`).toString("base64");return new Promise((e,i)=>{if("undefined"!=typeof window)return void i(new Error("The client credentials grant is not supported in a browser."));const a={Authorization:`Basic ${t}`};n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:a,data:"grant_type=client_credentials",httpsAgent:this.proxyAgent}).then(i=>{this.config.logger.log("trace",i.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,i.headers,{grant_type:"client_credentials"},void 0),this.config.logger.log("debug",i.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,void 0,{grant_type:"client_credentials"},void 0),this.setAccessToken(i.data.access_token),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*i.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),e(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,e.response.headers,{grant_type:"client_credentials"},e.response.data),i(e)})})}loginSaml2BearerGrant(e,i,t,n){return this.clientId=e,new Promise((a,o)=>{if("undefined"==typeof window){var r=Buffer.from(e+":"+i).toString("base64"),l=this._formAuthRequest(r,{grant_type:"urn:ietf:params:oauth:grant-type:saml2-bearer",orgName:t,assertion:n});l.proxy=this.proxy;var s={grant_type:"urn:ietf:params:oauth:grant-type:saml2-bearer",orgName:t,assertion:n};l.then(e=>{this.config.logger.log("trace",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,e.headers,s,void 0),this.config.logger.log("debug",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,void 0,s,void 0);var i=e.data.access_token;this.setAccessToken(i),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*e.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),a(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,e.response.headers,s,e.response.data),o(e)})}else o(new Error("The saml2bearer grant is not supported in a browser."))})}authorizePKCEGrant(e,i,t,o){return this.clientId=e,new Promise((r,l)=>{var s=n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:{"Content-Type":"application/x-www-form-urlencoded"},data:a.default.stringify({grant_type:"authorization_code",code:t,code_verifier:i,client_id:e,redirect_uri:o})});s.proxy=this.proxy;var p={grant_type:"authorization_code",code:t,code_verifier:i,client_id:e,redirect_uri:o};s.then(e=>{this.config.logger.log("trace",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,e.headers,p,void 0),this.config.logger.log("debug",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,void 0,p,void 0);var i=e.data.access_token;this.setAccessToken(i),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*e.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),r(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,e.response.headers,p,e.response.data),l(e)})})}generatePKCECodeVerifier(e){if(e<43||e>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");if("undefined"!=typeof window){const i="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(crypto.getRandomValues(new Uint32Array(e))).map(e=>i[e%i.length]).join("")}try{const i=require("crypto").getRandomValues,t="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(i(new Uint32Array(e))).map(e=>t[e%t.length]).join("")}catch(e){throw new Error("Crypto module is missing/not supported.")}}computePKCECodeChallenge(e){if(e.length<43||e.length>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");if("undefined"!=typeof window){const i=(new TextEncoder).encode(e);return new Promise((e,t)=>{window.crypto.subtle.digest("SHA-256",i).then(i=>{let t=Buffer.from(i).toString("base64").replaceAll("+","-").replaceAll("/","_");t=t.split("=")[0],e(t)}).catch(e=>t(new Error(`Code Challenge Error ${e}`)))})}try{const i=require("crypto").createHash,t=(new TextEncoder).encode(e);return new Promise((e,n)=>{const a=i("sha256").update(t).digest();e(Buffer.from(a).toString("base64url"))})}catch(e){throw new Error("Crypto module is missing/not supported.")}}loginPKCEGrant(e,i,t,n){if(!this.hasLocalStorage&&!n)throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");const a=this._setValuesFromUrlQuery();return this.clientId=e,this.redirectUri=i,this.codeVerifier=n,t||(t={}),new Promise((e,i)=>{if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),a&&a.error)return this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),this._saveSettings({accessToken:void 0}),i(new Error(`[${a.error}] ${a.error_description}`));a&&a.code?(this.codeVerifier||this.hasLocalStorage&&(this.codeVerifier=sessionStorage.getItem("genesys_cloud_sdk_pkce_code_verifier")),this.authorizePKCEGrant(this.clientId,this.codeVerifier,a.code,this.redirectUri).then(()=>{this._testTokenAccess().then(()=>{!this.authData.state&&a.state&&(this.authData.state=a.state),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),e(this.authData)}).catch(e=>(this._saveSettings({accessToken:void 0}),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error(`[${e.name}] ${e.msg}`))))}).catch(e=>(this._saveSettings({accessToken:void 0}),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error(`[${e.name}] ${e.msg}`))))):this._testTokenAccess().then(()=>{!this.authData.state&&t.state&&(this.authData.state=t.state),e(this.authData)}).catch(e=>{this.codeVerifier||(this.codeVerifier=this.generatePKCECodeVerifier(128),this.hasLocalStorage&&sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",this.codeVerifier)),this.computePKCECodeChallenge(this.codeVerifier).then(e=>{var i={client_id:encodeURIComponent(this.clientId),redirect_uri:encodeURIComponent(this.redirectUri),code_challenge:encodeURIComponent(e),response_type:"code",code_challenge_method:"S256"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=this._buildAuthUrl("oauth/authorize",i);window.location.replace(n)}).catch(e=>i(new Error(`[${e.name}]`)))})})}_setValuesFromUrlQuery(){if("undefined"==typeof window||!window.location.search)return;let e={},i=new URLSearchParams(window.location.search),t=i.get("code"),n=i.get("error"),a=i.get("error_description"),o=i.get("state");if(n)return e.error=n,a&&(e.error_description=a),e;t&&(e.code=t,o&&(e.state=o));var r,l,s=window.location;return"replaceState"in history?history.replaceState("",document.title,s.pathname):(r=document.body.scrollTop,l=document.body.scrollLeft,history.pushState("",document.title,s.pathname),document.body.scrollTop=r,document.body.scrollLeft=l),e}loginCodeAuthorizationGrant(e,i,t,n){return this.clientId=e,this.clientSecret=i,new Promise((a,o)=>{if("undefined"==typeof window){var r=Buffer.from(e+":"+i).toString("base64"),l=this._formAuthRequest(r,{grant_type:"authorization_code",code:t,redirect_uri:n});l.proxy=this.proxy;var s={grant_type:"authorization_code",code:t,redirect_uri:n};this._handleCodeAuthorizationResponse(l,s,a,o)}else o(new Error("The Code Authorization grant is not supported in a browser."))})}refreshCodeAuthorizationGrant(e,i,t){return new Promise((n,a)=>{if("undefined"==typeof window){var o=Buffer.from(e+":"+i).toString("base64"),r=this._formAuthRequest(o,{grant_type:"refresh_token",refresh_token:t});r.proxy=this.proxy;var l={grant_type:"refresh_token",refresh_token:t};this._handleCodeAuthorizationResponse(r,l,n,a)}else a(new Error("The Code Authorization grant is not supported in a browser."))})}_handleCodeAuthorizationResponse(e,i,t,n){e.then(n=>{this.config.logger.log("trace",n.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,n.headers,i,void 0),this.config.logger.log("debug",n.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,void 0,i,void 0);var a=n.data.access_token,o=n.data.refresh_token;this.setAccessToken(a),this.authData.refreshToken=o,this.authData.tokenExpiryTime=(new Date).getTime()+1e3*n.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),t(this.authData)}).catch(t=>{t.response&&this.config.logger.log("error",t.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,t.response.headers,i,t.response.data),n(t)})}_formAuthRequest(e,i){return n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:{Authorization:"Basic "+e,"Content-Type":"application/x-www-form-urlencoded"},data:a.default.stringify(i)})}_handleExpiredAccessToken(){return new Promise((e,i)=>{"undefined"==typeof window?this.refreshInProgress?this._sleep(this.config.refresh_token_wait_max).then(()=>{this.refreshInProgress?i(new Error(`Token refresh took longer than ${this.config.refresh_token_wait_max} seconds`)):e()}):(this.refreshInProgress=!0,this.refreshCodeAuthorizationGrant(this.clientId,this.clientSecret,this.authData.refreshToken).then(()=>{this.refreshInProgress=!1,e()}).catch(e=>{this.refreshInProgress=!1,i(e)})):i(new Error("This method is not supported in a browser."))})}_sleep(e){return new Promise(i=>setTimeout(i,e))}_testTokenAccess(){return new Promise((e,i)=>{this._loadSettings(),this.authentications["PureCloud OAuth"].accessToken?this.callApi("/api/v2/tokens/me","GET",null,null,null,null,null,["PureCloud OAuth"],["application/json"],["application/json"]).then(()=>{e()}).catch(e=>{this._saveSettings({accessToken:void 0}),i(e)}):i(new Error("Token is not set"))})}_setValuesFromUrlHash(){if("undefined"==typeof window||!window.location.hash)return;const e=new RegExp("^#*(.+?)=(.+?)$","i");let i={};if(window.location.hash.split("&").forEach(t=>{const n=e.exec(t);n&&(i[n[1]]=decodeURIComponent(decodeURIComponent(n[2].replace(/\+/g,"%20"))))}),i.error)return i;if(i.access_token){let e={};i.state&&(e.state=i.state),i.expires_in&&(e.tokenExpiryTime=(new Date).getTime()+1e3*parseInt(i.expires_in.replace(/\+/g,"%20")),e.tokenExpiryTimeString=new Date(e.tokenExpiryTime).toUTCString()),e.accessToken=i.access_token.replace(/\+/g,"%20");var t,n,a=window.location;"replaceState"in history?history.replaceState("",document.title,a.pathname+a.search):(t=document.body.scrollTop,n=document.body.scrollLeft,a.hash="",document.body.scrollTop=t,document.body.scrollLeft=n),this._saveSettings(e)}}setAccessToken(e){this._saveSettings({accessToken:e})}setStorageKey(e){this.storageKey=e,this.setAccessToken(this.authentications["PureCloud OAuth"].accessToken)}logout(e){this.hasLocalStorage&&this._saveSettings({accessToken:void 0,state:void 0,tokenExpiryTime:void 0,tokenExpiryTimeString:void 0});var i={client_id:encodeURIComponent(this.clientId)};e&&(i.redirect_uri=encodeURI(e));var t=this._buildAuthUrl("logout",i);window.location.replace(t)}_buildAuthUrl(e,i){return i||(i={}),Object.keys(i).reduce((e,t)=>i[t]?`${e}&${t}=${i[t]}`:e,`${this.config.authUrl}/${e}?`)}paramToString(e){return e?e instanceof Date?e.toJSON():e.toString():""}serialize(e){var i={};for(var t in e)e.hasOwnProperty(t)&&void 0!==e[t]&&(i[encodeURIComponent(t)]=Array.isArray(e[t])?e[t].join(","):this.paramToString(e[t]));return i}addHeaders(e,...i){return e=e?Object.assign(e,...i):Object.assign(...i)}buildUrl(e,i){e.match(/^\//)||(e=`/${e}`);var t=this.config.basePath+e;return t=t.replace(/\{([\w-]+)\}/g,(e,t)=>{var n;return n=i.hasOwnProperty(t)?this.paramToString(i[t]):e,encodeURIComponent(n)})}isJsonMime(e){return Boolean(e&&e.match(/^application\/json(;.*)?$/i))}jsonPreferredMime(e){for(var i=0;i{var t=this.authentications[i];switch(t.type){case"basic":(t.username||t.password)&&(e.auth={username:t.username||"",password:t.password||""});break;case"apiKey":if(t.apiKey){var n={};t.apiKeyPrefix?n[t.name]=`${t.apiKeyPrefix} ${t.apiKey}`:n[t.name]=t.apiKey,"header"===t.in?e.headers=this.addHeaders(e.headers,n):e.params=this.serialize(n)}break;case"oauth2":t.accessToken&&(e.headers=this.addHeaders(e.headers,{Authorization:`Bearer ${t.accessToken}`}));break;default:throw new Error(`Unknown authentication type: ${t.type}`)}})}setProxyAgent(e){this.proxyAgent=e}callApi(e,i,t,a,o,r,l,s,p,u){return new Promise((d,c)=>{!function g(h){var m=h.buildUrl(e,t);var v={method:i,url:m,httpsAgent:h.proxyAgent,timeout:h.timeout,params:h.serialize(a)};h.applyAuthToRequest(v,s);const w=h.defaultHeaders;const C=h.normalizeParams(o);v.headers=h.addHeaders(v.headers,w,C);var I=h.jsonPreferredMime(p);I?v.headers["Content-Type"]=I:v.headers["Content-Type"]||(v.headers["Content-Type"]="application/json");if("application/x-www-form-urlencoded"===I)v.data=h.normalizeParams(r);else if("multipart/form-data"==I){var f=h.normalizeParams(r);for(var A in f)if(f.hasOwnProperty(A)){var b=new FormData;b.set(A,f[A]),v.data=b}}else l&&(v.data=l);var j=h.jsonPreferredMime(u);j&&(v.headers.Accept=j);n.default.request(v).then(e=>{var t=!0===h.returnExtended?{status:e.status,statusText:e.statusText,headers:e.headers,body:e.data,text:e.text,error:null}:e.data?e.data:e.text;h.config.logger.log("trace",e.status,i,m,v.headers,e.headers,l,void 0),h.config.logger.log("debug",e.status,i,m,v.headers,void 0,l,void 0),d(t)}).catch(e=>{var t=e;e.response&&401==e.response.status&&h.config.refresh_access_token&&""!==h.authData.refreshToken?h._handleExpiredAccessToken().then(()=>{g(h)}).catch(e=>{c(e)}):e.response&&(h.config.logger.log("error",e.response.status,i,m,v.headers,e.response.headers,l,e.response.data),t=!0===h.returnExtended?{status:e.response.status,statusText:e.response.statusText,headers:e.response.headers,body:e.response.data,text:e.response.text,error:e}:e.response.data?e.response.data:e.response.text),c(t)})}(this)})}}class c{constructor(e){this.apiClient=e||d.instance}deleteAlertingAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling deleteAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","DELETE",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingInteractionstatsAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","DELETE",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingInteractionstatsRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","DELETE",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling deleteAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","DELETE",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling getAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","GET",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingAlertsActive(){return this.apiClient.callApi("/api/v2/alerting/alerts/active","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","GET",{alertId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlerts(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/unread","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsRule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","GET",{ruleId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsRules(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/interactionstats/rules","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling getAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","GET",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling patchAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","PATCH",{alertId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingAlertsBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAlertingAlertsBulk';return this.apiClient.callApi("/api/v2/alerting/alerts/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingRulesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAlertingRulesBulk';return this.apiClient.callApi("/api/v2/alerting/rules/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingAlertsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/alerts/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingInteractionstatsRules(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingRules';return this.apiClient.callApi("/api/v2/alerting/rules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRulesBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';return this.apiClient.callApi("/api/v2/alerting/rules/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRulesQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/rules/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling putAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","PUT",{alertId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingInteractionstatsAlert(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","PUT",{alertId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingInteractionstatsRule(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","PUT",{ruleId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingRule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling putAlertingRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","PUT",{ruleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class g{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsActionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsActionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowDivisionsReportingturns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,actionId:i.actionId,sessionId:i.sessionId,language:i.language,askActionResults:i.askActionResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowReportingturns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowReportingturns';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/reportingturns","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,actionId:i.actionId,sessionId:i.sessionId,language:i.language,askActionResults:i.askActionResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowSessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowSessions';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/sessions","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,botResultCategories:i.botResultCategories,endLanguage:i.endLanguage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getAnalyticsConversationDetails';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetails(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/conversations/details","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsDataretentionSettings(){return this.apiClient.callApi("/api/v2/analytics/dataretention/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowexecutionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowexecutionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsKnowledgeAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsKnowledgeAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingDashboardsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';return this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingDashboardsUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users","GET",{},{sortBy:e.sortBy,pageNumber:e.pageNumber,pageSize:e.pageSize,id:this.apiClient.buildCollectionParam(e.id,"multi"),state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingExports(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/reporting/exports","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingExportsMetadata(){return this.apiClient.callApi("/api/v2/analytics/reporting/exports/metadata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingSettings(){return this.apiClient.callApi("/api/v2/analytics/reporting/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingSettingsUserDashboards(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/users/{userId}/dashboards","GET",{userId:e},{sortBy:i.sortBy,pageNumber:i.pageNumber,pageSize:i.pageSize,publicOnly:i.publicOnly,favoriteOnly:i.favoriteOnly,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsResolutionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsResolutionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTaskmanagementAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTaskmanagementAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTranscriptsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTranscriptsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAnalyticsReportingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';return this.apiClient.callApi("/api/v2/analytics/reporting/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsActionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsActionsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsBotsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsBotsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationDetailsProperties(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details/properties","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsTranscriptsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/transcripts/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowexecutionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowexecutionsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/flows/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/flows/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsKnowledgeAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsKnowledgeAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsQueuesObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/queues/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRatelimitsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/ratelimits/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingDashboardsUsersBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';return this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingExports(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';return this.apiClient.callApi("/api/v2/analytics/reporting/exports","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingSettingsDashboardsBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/dashboards/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingSettingsDashboardsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/dashboards/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsResolutionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRoutingActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';return this.apiClient.callApi("/api/v2/analytics/routing/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTaskmanagementAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTaskmanagementAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTeamsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTeamsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/teams/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTranscriptsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTranscriptsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersActivityQuery';return this.apiClient.callApi("/api/v2/analytics/users/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/users/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/users/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putAnalyticsDataretentionSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';return this.apiClient.callApi("/api/v2/analytics/dataretention/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class h{constructor(e){this.apiClient=e||d.instance}deleteArchitectEmergencygroup(e){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling deleteArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","DELETE",{emergencyGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammar(e){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","DELETE",{grammarId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguageFilesDtmf(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguageFilesVoice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectIvr(e){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling deleteArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","DELETE",{ivrId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPrompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","DELETE",{promptId:e},{allResources:i.allResources},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPromptResourceAudio(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPromptResourceAudio';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectPromptResourceAudio';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPrompts(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteArchitectPrompts';return this.apiClient.callApi("/api/v2/architect/prompts","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSchedule(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling deleteArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","DELETE",{scheduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSchedulegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling deleteArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","DELETE",{scheduleGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSystempromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlow(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling deleteFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","DELETE",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowInstancesSettingsLoglevels(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling deleteFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","DELETE",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlows(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteFlows';return this.apiClient.callApi("/api/v2/flows","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsDatatable(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling deleteFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","DELETE",{datatableId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsDatatableRow(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling deleteFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling deleteFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","DELETE",{datatableId:e,rowId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsInstancesSettingsLoglevelsDefault(){return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsMilestone(e){if(void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling deleteFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","DELETE",{milestoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytracking(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "name" when calling getArchitectDependencytracking';return this.apiClient.callApi("/api/v2/architect/dependencytracking","GET",{},{pageNumber:i.pageNumber,pageSize:i.pageSize,name:e,objectType:this.apiClient.buildCollectionParam(i.objectType,"multi"),consumedResources:i.consumedResources,consumingResources:i.consumingResources,consumedResourceType:this.apiClient.buildCollectionParam(i.consumedResourceType,"multi"),consumingResourceType:this.apiClient.buildCollectionParam(i.consumingResourceType,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingBuild(){return this.apiClient.callApi("/api/v2/architect/dependencytracking/build","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingConsumedresources(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingConsumedresources';if(void 0===i||null===i)throw'Missing the required parameter "version" when calling getArchitectDependencytrackingConsumedresources';if(void 0===t||null===t)throw'Missing the required parameter "objectType" when calling getArchitectDependencytrackingConsumedresources';return this.apiClient.callApi("/api/v2/architect/dependencytracking/consumedresources","GET",{},{id:e,version:i,objectType:t,resourceType:this.apiClient.buildCollectionParam(n.resourceType,"multi"),pageNumber:n.pageNumber,pageSize:n.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingConsumingresources(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingConsumingresources';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling getArchitectDependencytrackingConsumingresources';return this.apiClient.callApi("/api/v2/architect/dependencytracking/consumingresources","GET",{},{id:e,objectType:i,resourceType:this.apiClient.buildCollectionParam(t.resourceType,"multi"),version:t.version,pageNumber:t.pageNumber,pageSize:t.pageSize,flowFilter:t.flowFilter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingDeletedresourceconsumers(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/deletedresourceconsumers","GET",{},{name:e.name,objectType:this.apiClient.buildCollectionParam(e.objectType,"multi"),flowFilter:e.flowFilter,consumedResources:e.consumedResources,consumedResourceType:this.apiClient.buildCollectionParam(e.consumedResourceType,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingObject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingObject';return this.apiClient.callApi("/api/v2/architect/dependencytracking/object","GET",{},{id:e,version:i.version,objectType:i.objectType,consumedResources:i.consumedResources,consumingResources:i.consumingResources,consumedResourceType:this.apiClient.buildCollectionParam(i.consumedResourceType,"multi"),consumingResourceType:this.apiClient.buildCollectionParam(i.consumingResourceType,"multi"),consumedResourceRequest:i.consumedResourceRequest},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingType(e){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getArchitectDependencytrackingType';return this.apiClient.callApi("/api/v2/architect/dependencytracking/types/{typeId}","GET",{typeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingTypes(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/types","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingUpdatedresourceconsumers(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/updatedresourceconsumers","GET",{},{name:e.name,objectType:this.apiClient.buildCollectionParam(e.objectType,"multi"),consumedResources:e.consumedResources,consumedResourceType:this.apiClient.buildCollectionParam(e.consumedResourceType,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroup(e){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling getArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","GET",{emergencyGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroups(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/emergencygroups","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroupsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/emergencygroups/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammar(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling getArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","GET",{grammarId:e},{includeFileUrls:i.includeFileUrls},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammarLanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","GET",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammars(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/grammars","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,includeFileUrls:e.includeFileUrls},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvr(e){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling getArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","GET",{ivrId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvrs(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/ivrs","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,dnis:e.dnis,scheduleGroup:e.scheduleGroup},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvrsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/ivrs/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPrompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","GET",{promptId:e},{includeMediaUris:i.includeMediaUris,includeResources:i.includeResources,language:this.apiClient.buildCollectionParam(i.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getArchitectPromptHistoryHistoryId';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/history/{historyId}","GET",{promptId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","GET",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptResources(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptResources';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources","GET",{promptId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPrompts(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/prompts","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:this.apiClient.buildCollectionParam(e.name,"multi"),description:e.description,nameOrDescription:e.nameOrDescription,sortBy:e.sortBy,sortOrder:e.sortOrder,includeMediaUris:e.includeMediaUris,includeResources:e.includeResources,language:this.apiClient.buildCollectionParam(e.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedule(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling getArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","GET",{scheduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling getArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","GET",{scheduleGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroups(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedulegroups","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,scheduleIds:e.scheduleIds,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroupsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedulegroups/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedules(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedules","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedules/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystemprompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystemprompt';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}","GET",{promptId:e},{includeMediaUris:i.includeMediaUris,includeResources:i.includeResources,language:this.apiClient.buildCollectionParam(i.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getArchitectSystempromptHistoryHistoryId';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/history/{historyId}","GET",{promptId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","GET",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptResources(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptResources';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources","GET",{promptId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystemprompts(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/systemprompts","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,includeMediaUris:e.includeMediaUris,includeResources:e.includeResources,language:this.apiClient.buildCollectionParam(e.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlow(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","GET",{flowId:e},{deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getFlowHistoryHistoryId';return this.apiClient.callApi("/api/v2/flows/{flowId}/history/{historyId}","GET",{flowId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowInstancesSettingsLoglevels(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","GET",{flowId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowLatestconfiguration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowLatestconfiguration';return this.apiClient.callApi("/api/v2/flows/{flowId}/latestconfiguration","GET",{flowId:e},{deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersion';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}","GET",{flowId:e,versionId:i},{deleted:t.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionConfiguration(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionConfiguration';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionConfiguration';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/configuration","GET",{flowId:e,versionId:i},{deleted:t.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionHealth(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/health","GET",{flowId:e,versionId:i},{language:t.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionIntentHealth(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';if(void 0===t||null===t)throw'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';if(void 0===n||null===n)throw'Missing the required parameter "language" when calling getFlowVersionIntentHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health","GET",{flowId:e,versionId:i,intentId:t},{language:n},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionIntentUtteranceHealth(e,i,t,n,a){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===t||null===t)throw'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===n||null===n)throw'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===a||null===a)throw'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health","GET",{flowId:e,versionId:i,intentId:t,utteranceId:n},{language:a},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersions';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions","GET",{flowId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlows(e){return e=e||{},this.apiClient.callApi("/api/v2/flows","GET",{},{type:this.apiClient.buildCollectionParam(e.type,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,publishVersionId:e.publishVersionId,editableBy:e.editableBy,lockedBy:e.lockedBy,lockedByClientId:e.lockedByClientId,secure:e.secure,deleted:e.deleted,includeSchemas:e.includeSchemas,publishedAfter:e.publishedAfter,publishedBefore:e.publishedBefore,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatable(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","GET",{datatableId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling getFlowsDatatableExportJob';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}","GET",{datatableId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableImportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling getFlowsDatatableImportJob';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}","GET",{datatableId:e,importJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableImportJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableImportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs","GET",{datatableId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableRow(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling getFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","GET",{datatableId:e,rowId:i},{showbrief:t.showbrief},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableRows(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableRows';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows","GET",{datatableId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,showbrief:i.showbrief,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatables(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/datatables","GET",{},{expand:e.expand,pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatablesDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatablesDivisionview';return this.apiClient.callApi("/api/v2/flows/datatables/divisionviews/{datatableId}","GET",{datatableId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatablesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/datatables/divisionviews","GET",{},{expand:e.expand,pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/divisionviews","GET",{},{type:this.apiClient.buildCollectionParam(e.type,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,publishVersionId:e.publishVersionId,publishedAfter:e.publishedAfter,publishedBefore:e.publishedBefore,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),includeSchemas:e.includeSchemas},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsExecution(e){if(void 0===e||null===e)throw'Missing the required parameter "flowExecutionId" when calling getFlowsExecution';return this.apiClient.callApi("/api/v2/flows/executions/{flowExecutionId}","GET",{flowExecutionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstance(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "instanceId" when calling getFlowsInstance';return this.apiClient.callApi("/api/v2/flows/instances/{instanceId}","GET",{instanceId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getFlowsInstancesJob';return this.apiClient.callApi("/api/v2/flows/instances/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesQuerycapabilities(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/querycapabilities","GET",{},{expand:e.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsExecutiondata(){return this.apiClient.callApi("/api/v2/flows/instances/settings/executiondata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevels(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevelsCharacteristics(){return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/characteristics","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevelsDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsJob(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getFlowsJob';return this.apiClient.callApi("/api/v2/flows/jobs/{jobId}","GET",{jobId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestone(e){if(void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling getFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","GET",{milestoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestones(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestonesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "flowOutcomeId" when calling getFlowsOutcome';return this.apiClient.callApi("/api/v2/flows/outcomes/{flowOutcomeId}","GET",{flowOutcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcomesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchArchitectGrammar(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling patchArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","PATCH",{grammarId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchArchitectGrammarLanguage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling patchArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","PATCH",{grammarId:e,languageCode:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchFlowsInstancesSettingsExecutiondata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchFlowsInstancesSettingsExecutiondata';return this.apiClient.callApi("/api/v2/flows/instances/settings/executiondata","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectDependencytrackingBuild(){return this.apiClient.callApi("/api/v2/architect/dependencytracking/build","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectEmergencygroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectEmergencygroups';return this.apiClient.callApi("/api/v2/architect/emergencygroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguageFilesDtmf(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf","POST",{grammarId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguageFilesVoice(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice","POST",{grammarId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguages';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages","POST",{grammarId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammars(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectGrammars';return this.apiClient.callApi("/api/v2/architect/grammars","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectIvrs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectIvrs';return this.apiClient.callApi("/api/v2/architect/ivrs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPromptHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectPromptHistory';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/history","POST",{promptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPromptResources(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectPromptResources';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectPromptResources';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources","POST",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPrompts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectPrompts';return this.apiClient.callApi("/api/v2/architect/prompts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSchedulegroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectSchedulegroups';return this.apiClient.callApi("/api/v2/architect/schedulegroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSchedules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectSchedules';return this.apiClient.callApi("/api/v2/architect/schedules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSystempromptHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectSystempromptHistory';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/history","POST",{promptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSystempromptResources(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectSystempromptResources';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectSystempromptResources';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources","POST",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowHistory';return this.apiClient.callApi("/api/v2/flows/{flowId}/history","POST",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowInstancesSettingsLoglevels(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowInstancesSettingsLoglevels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","POST",{flowId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowVersions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowVersions';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions","POST",{flowId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlows(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlows';return this.apiClient.callApi("/api/v2/flows","POST",{},{language:i.language},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsCheckin(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsCheckin';return this.apiClient.callApi("/api/v2/flows/actions/checkin","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsCheckout(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsCheckout';return this.apiClient.callApi("/api/v2/flows/actions/checkout","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsDeactivate(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsDeactivate';return this.apiClient.callApi("/api/v2/flows/actions/deactivate","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsPublish(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsPublish';return this.apiClient.callApi("/api/v2/flows/actions/publish","POST",{},{flow:e,version:i.version},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsRevert(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsRevert';return this.apiClient.callApi("/api/v2/flows/actions/revert","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsUnlock(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsUnlock';return this.apiClient.callApi("/api/v2/flows/actions/unlock","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableExportJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableExportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/export/jobs","POST",{datatableId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableImportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowsDatatableImportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs","POST",{datatableId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableRows(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableRows';if(void 0===i||null===i)throw'Missing the required parameter "dataTableRow" when calling postFlowsDatatableRows';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows","POST",{datatableId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatables(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsDatatables';return this.apiClient.callApi("/api/v2/flows/datatables","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsExecutions(e){if(void 0===e||null===e)throw'Missing the required parameter "flowLaunchRequest" when calling postFlowsExecutions';return this.apiClient.callApi("/api/v2/flows/executions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsInstancesJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsInstancesJobs';return this.apiClient.callApi("/api/v2/flows/instances/jobs","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsInstancesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsInstancesQuery';return this.apiClient.callApi("/api/v2/flows/instances/query","POST",{},{indexOnly:i.indexOnly,pageSize:i.pageSize},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsJobs(){return this.apiClient.callApi("/api/v2/flows/jobs","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsMilestones(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectEmergencygroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling putArchitectEmergencygroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","PUT",{emergencyGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectIvr(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling putArchitectIvr';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","PUT",{ivrId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectPrompt(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectPrompt';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","PUT",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectPromptResource(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling putArchitectPromptResource';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","PUT",{promptId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSchedule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling putArchitectSchedule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","PUT",{scheduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSchedulegroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling putArchitectSchedulegroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","PUT",{scheduleGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSystempromptResource(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling putArchitectSystempromptResource';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","PUT",{promptId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putFlow(e,i){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling putFlow';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","PUT",{flowId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowInstancesSettingsLoglevels(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling putFlowInstancesSettingsLoglevels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","PUT",{flowId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsDatatable(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","PUT",{datatableId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsDatatableRow(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling putFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling putFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","PUT",{datatableId:e,rowId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsInstancesSettingsLoglevelsDefault(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling putFlowsInstancesSettingsLoglevelsDefault';return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","PUT",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsMilestone(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling putFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","PUT",{milestoneId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsOutcome(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';return this.apiClient.callApi("/api/v2/flows/outcomes/{flowOutcomeId}","PUT",{flowOutcomeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class m{constructor(e){this.apiClient=e||d.instance}getAuditsQueryRealtimeServicemapping(){return this.apiClient.callApi("/api/v2/audits/query/realtime/servicemapping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryServicemapping(){return this.apiClient.callApi("/api/v2/audits/query/servicemapping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryTransactionId(e){if(void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getAuditsQueryTransactionId';return this.apiClient.callApi("/api/v2/audits/query/{transactionId}","GET",{transactionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryTransactionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getAuditsQueryTransactionIdResults';return this.apiClient.callApi("/api/v2/audits/query/{transactionId}/results","GET",{transactionId:e},{cursor:i.cursor,pageSize:i.pageSize,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQuery';return this.apiClient.callApi("/api/v2/audits/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQueryRealtime(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';return this.apiClient.callApi("/api/v2/audits/query/realtime","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQueryRealtimeRelated(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';return this.apiClient.callApi("/api/v2/audits/query/realtime/related","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class v{constructor(e){this.apiClient=e||d.instance}deleteAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","DELETE",{divisionId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationRole(e){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling deleteAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","DELETE",{roleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationSubjectDivisionRole(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling deleteAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","DELETE",{subjectId:e,divisionId:i,roleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","GET",{divisionId:e},{objectCount:i.objectCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionGrants(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivisionGrants';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/grants","GET",{divisionId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/divisions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,objectCount:e.objectCount,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsHome(){return this.apiClient.callApi("/api/v2/authorization/divisions/home","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsLimit(){return this.apiClient.callApi("/api/v2/authorization/divisions/limit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/me","GET",{},{name:i.name,permission:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/me","GET",{},{permission:e,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedSubjectId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationDivisionspermittedPagedSubjectId';if(void 0===i||null===i)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedSubjectId';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/{subjectId}","GET",{subjectId:e},{permission:i,pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationPermissions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/permissions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,queryType:e.queryType,query:e.query},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationProducts(){return this.apiClient.callApi("/api/v2/authorization/products","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRole(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","GET",{roleId:e},{userCount:i.userCount,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleComparedefaultRightRoleId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "leftRoleId" when calling getAuthorizationRoleComparedefaultRightRoleId';if(void 0===i||null===i)throw'Missing the required parameter "rightRoleId" when calling getAuthorizationRoleComparedefaultRightRoleId';return this.apiClient.callApi("/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}","GET",{leftRoleId:e,rightRoleId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleSubjectgrants(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRoleSubjectgrants';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/subjectgrants","GET",{roleId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRoleUsers';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users","GET",{roleId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoles(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/roles","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,permission:this.apiClient.buildCollectionParam(e.permission,"multi"),defaultRoleId:this.apiClient.buildCollectionParam(e.defaultRoleId,"multi"),userCount:e.userCount,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSettings(){return this.apiClient.callApi("/api/v2/authorization/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}","GET",{subjectId:e},{includeDuplicates:i.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/me","GET",{},{includeDuplicates:e.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsRolecounts(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/rolecounts","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","GET",{subjectId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAuthorizationRole(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling patchAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","PATCH",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchAuthorizationSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAuthorizationSettings';return this.apiClient.callApi("/api/v2/authorization/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionObject(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionObject';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling postAuthorizationDivisionObject';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationDivisionObject';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/objects/{objectType}","POST",{divisionId:e,objectType:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionRestore(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/restore","POST",{divisionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationDivisions';return this.apiClient.callApi("/api/v2/authorization/divisions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRole(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling postAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","POST",{roleId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRoleComparedefaultRightRoleId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "leftRoleId" when calling postAuthorizationRoleComparedefaultRightRoleId';if(void 0===i||null===i)throw'Missing the required parameter "rightRoleId" when calling postAuthorizationRoleComparedefaultRightRoleId';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationRoleComparedefaultRightRoleId';return this.apiClient.callApi("/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}","POST",{leftRoleId:e,rightRoleId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationRoles';return this.apiClient.callApi("/api/v2/authorization/roles","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRolesDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/roles/default","POST",{},{force:e.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkadd(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkadd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkadd';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkadd","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkremove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkremove';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkremove","POST",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkreplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkreplace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkreplace';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkreplace","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectDivisionRole(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling postAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling postAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","POST",{subjectId:e,divisionId:i,roleId:t},{subjectType:n.subjectType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationDivision(e,i){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","PUT",{divisionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRole(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRoleUsersAdd(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRoleUsersAdd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRoleUsersAdd';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users/add","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRoleUsersRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRoleUsersRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRoleUsersRemove';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users/remove","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRolesDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putAuthorizationRolesDefault';return this.apiClient.callApi("/api/v2/authorization/roles/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling putUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","PUT",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class w{constructor(e){this.apiClient=e||d.instance}getBillingReportsBillableusage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "startDate" when calling getBillingReportsBillableusage';if(void 0===i||null===i)throw'Missing the required parameter "endDate" when calling getBillingReportsBillableusage';return this.apiClient.callApi("/api/v2/billing/reports/billableusage","GET",{},{startDate:e,endDate:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getBillingTrusteebillingoverviewTrustorOrgId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';return this.apiClient.callApi("/api/v2/billing/trusteebillingoverview/{trustorOrgId}","GET",{trustorOrgId:e},{billingPeriodIndex:i.billingPeriodIndex},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class C{constructor(e){this.apiClient=e||d.instance}getCarrierservicesIntegrationsEmergencylocationsMe(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneNumber" when calling getCarrierservicesIntegrationsEmergencylocationsMe';return this.apiClient.callApi("/api/v2/carrierservices/integrations/emergencylocations/me","GET",{},{phoneNumber:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postCarrierservicesIntegrationsEmergencylocationsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/carrierservices/integrations/emergencylocations/me","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class I{constructor(e){this.apiClient=e||d.instance}deleteChatsRoomMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageId}","DELETE",{roomJid:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsRoomMessagesPin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';if(void 0===i||null===i)throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}","DELETE",{roomJid:e,pinnedMessageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{userId}","DELETE",{roomJid:e,userId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsUserMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling deleteChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageId}","DELETE",{userId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsUserMessagesPin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';if(void 0===i||null===i)throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}","DELETE",{userId:e,pinnedMessageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getChatsMessage';return this.apiClient.callApi("/api/v2/chats/messages/{messageId}","GET",{messageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoom(e){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoom';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}","GET",{roomJid:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageIds" when calling getChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageIds}","GET",{roomJid:e,messageIds:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomMessages';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages","GET",{roomJid:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{participantJid}","GET",{roomJid:e,participantJid:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomParticipants(e){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants","GET",{roomJid:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsSettings(){return this.apiClient.callApi("/api/v2/chats/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsThreadMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "threadId" when calling getChatsThreadMessages';return this.apiClient.callApi("/api/v2/chats/threads/{threadId}/messages","GET",{threadId:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUser';return this.apiClient.callApi("/api/v2/chats/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageIds" when calling getChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageIds}","GET",{userId:e,messageIds:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserMessages';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages","GET",{userId:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserSettings';return this.apiClient.callApi("/api/v2/chats/users/{userId}/settings","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUsersMeSettings(){return this.apiClient.callApi("/api/v2/chats/users/me/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsRoom(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling patchChatsRoom';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchChatsRoom';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}","PATCH",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsRoomMessage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling patchChatsRoomMessage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageId}","PATCH",{roomJid:e,messageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchChatsSettings';return this.apiClient.callApi("/api/v2/chats/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUserMessage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageId}","PATCH",{userId:e,messageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUserSettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchChatsUserSettings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchChatsUserSettings';return this.apiClient.callApi("/api/v2/chats/users/{userId}/settings","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUsersMeSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchChatsUsersMeSettings';return this.apiClient.callApi("/api/v2/chats/users/me/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsRoomMessages';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages","POST",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomMessagesPins(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsRoomMessagesPins';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/pins","POST",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{userId}","POST",{roomJid:e,userId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRooms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postChatsRooms';return this.apiClient.callApi("/api/v2/chats/rooms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsUserMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postChatsUserMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsUserMessages';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsUserMessagesPins(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsUserMessagesPins';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/pins","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putChatsMessageReactions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling putChatsMessageReactions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putChatsMessageReactions';return this.apiClient.callApi("/api/v2/chats/messages/{messageId}/reactions","PUT",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putChatsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putChatsSettings';return this.apiClient.callApi("/api/v2/chats/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class f{constructor(e){this.apiClient=e||d.instance}deleteCoachingAppointment(e){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling deleteCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","DELETE",{appointmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteCoachingAppointmentAnnotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling deleteCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling deleteCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","DELETE",{appointmentId:e,annotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointment(e){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","GET",{appointmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentAnnotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling getCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","GET",{appointmentId:e,annotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentAnnotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentAnnotations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations","GET",{appointmentId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentStatuses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentStatuses';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/statuses","GET",{appointmentId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userIds" when calling getCoachingAppointments';return this.apiClient.callApi("/api/v2/coaching/appointments","GET",{},{userIds:this.apiClient.buildCollectionParam(e,"multi"),interval:i.interval,pageNumber:i.pageNumber,pageSize:i.pageSize,statuses:this.apiClient.buildCollectionParam(i.statuses,"multi"),facilitatorIds:this.apiClient.buildCollectionParam(i.facilitatorIds,"multi"),sortOrder:i.sortOrder,relationships:this.apiClient.buildCollectionParam(i.relationships,"multi"),completionInterval:i.completionInterval,overdue:i.overdue,intervalCondition:i.intervalCondition},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/coaching/appointments/me","GET",{},{interval:e.interval,pageNumber:e.pageNumber,pageSize:e.pageSize,statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),facilitatorIds:this.apiClient.buildCollectionParam(e.facilitatorIds,"multi"),sortOrder:e.sortOrder,relationships:this.apiClient.buildCollectionParam(e.relationships,"multi"),completionInterval:e.completionInterval,overdue:e.overdue,intervalCondition:e.intervalCondition},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingNotification(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "notificationId" when calling getCoachingNotification';return this.apiClient.callApi("/api/v2/coaching/notifications/{notificationId}","GET",{notificationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingNotifications(e){return e=e||{},this.apiClient.callApi("/api/v2/coaching/notifications","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","PATCH",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointmentAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling patchCoachingAppointmentAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","PATCH",{appointmentId:e,annotationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointmentStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointmentStatus';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingAppointmentStatus';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/status","PATCH",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingNotification(e,i){if(void 0===e||null===e)throw'Missing the required parameter "notificationId" when calling patchCoachingNotification';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingNotification';return this.apiClient.callApi("/api/v2/coaching/notifications/{notificationId}","PATCH",{notificationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentAnnotations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling postCoachingAppointmentAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postCoachingAppointmentAnnotations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations","POST",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentConversations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling postCoachingAppointmentConversations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postCoachingAppointmentConversations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/conversations","POST",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingAppointments';return this.apiClient.callApi("/api/v2/coaching/appointments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingAppointmentsAggregatesQuery';return this.apiClient.callApi("/api/v2/coaching/appointments/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingScheduleslotsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';return this.apiClient.callApi("/api/v2/coaching/scheduleslots/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class A{constructor(e){this.apiClient=e||d.instance}deleteContentmanagementDocument(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","DELETE",{documentId:e},{override:i.override},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementShare(e){if(void 0===e||null===e)throw'Missing the required parameter "shareId" when calling deleteContentmanagementShare';return this.apiClient.callApi("/api/v2/contentmanagement/shares/{shareId}","DELETE",{shareId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling deleteContentmanagementStatusStatusId';return this.apiClient.callApi("/api/v2/contentmanagement/status/{statusId}","DELETE",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspace(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","DELETE",{workspaceId:e},{moveChildrenToWorkspaceId:i.moveChildrenToWorkspaceId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspaceMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","DELETE",{workspaceId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspaceTagvalue(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling deleteContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","DELETE",{workspaceId:e,tagId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocument(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","GET",{documentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocumentContent(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getContentmanagementDocumentContent';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}/content","GET",{documentId:e},{disposition:i.disposition,contentType:i.contentType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/documents","GET",{},{workspaceId:e,name:i.name,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queryPhrase" when calling getContentmanagementQuery';return this.apiClient.callApi("/api/v2/contentmanagement/query","GET",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder,queryPhrase:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSecurityprofile(e){if(void 0===e||null===e)throw'Missing the required parameter "securityProfileId" when calling getContentmanagementSecurityprofile';return this.apiClient.callApi("/api/v2/contentmanagement/securityprofiles/{securityProfileId}","GET",{securityProfileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSecurityprofiles(){return this.apiClient.callApi("/api/v2/contentmanagement/securityprofiles","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementShare(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "shareId" when calling getContentmanagementShare';return this.apiClient.callApi("/api/v2/contentmanagement/shares/{shareId}","GET",{shareId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSharedSharedId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';return this.apiClient.callApi("/api/v2/contentmanagement/shared/{sharedId}","GET",{sharedId:e},{redirect:i.redirect,disposition:i.disposition,contentType:i.contentType,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementShares(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/shares","GET",{},{entityId:e.entityId,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementStatus(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/status","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling getContentmanagementStatusStatusId';return this.apiClient.callApi("/api/v2/contentmanagement/status/{statusId}","GET",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementUsage(){return this.apiClient.callApi("/api/v2/contentmanagement/usage","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspace(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","GET",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/documents","GET",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceMember(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling getContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","GET",{workspaceId:e,memberId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceMembers';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members","GET",{workspaceId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceTagvalue(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling getContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","GET",{workspaceId:e,tagId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceTagvalues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceTagvalues';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues","GET",{workspaceId:e},{value:i.value,pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaces(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/workspaces","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,access:this.apiClient.buildCollectionParam(e.access,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocument(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postContentmanagementDocument';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","POST",{documentId:e},{expand:t.expand,override:t.override},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocumentContent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postContentmanagementDocumentContent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementDocumentContent';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}/content","POST",{documentId:e},{override:t.override},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/documents","POST",{},{copySource:i.copySource,moveSource:i.moveSource,override:i.override},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementQuery';return this.apiClient.callApi("/api/v2/contentmanagement/query","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementShares(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementShares';return this.apiClient.callApi("/api/v2/contentmanagement/shares","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaceTagvalues(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling postContentmanagementWorkspaceTagvalues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaceTagvalues';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues","POST",{workspaceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaceTagvaluesQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling postContentmanagementWorkspaceTagvaluesQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaceTagvaluesQuery';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query","POST",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaces(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaces';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspace(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","PUT",{workspaceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspaceMember(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling putContentmanagementWorkspaceMember';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","PUT",{workspaceId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspaceTagvalue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling putContentmanagementWorkspaceTagvalue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","PUT",{workspaceId:e,tagId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class b{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationParticipantCode(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationParticipantCode';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationParticipantCode';if(void 0===t||null===t)throw'Missing the required parameter "addCommunicationCode" when calling deleteConversationParticipantCode';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}","DELETE",{conversationId:e,participantId:i,addCommunicationCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationParticipantFlaggedreason(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationParticipantFlaggedreason';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationParticipantFlaggedreason';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason","DELETE",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsCallParticipantConsult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","DELETE",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsEmailMessagesDraftAttachment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationsEmailMessagesDraftAttachment';if(void 0===i||null===i)throw'Missing the required parameter "attachmentId" when calling deleteConversationsEmailMessagesDraftAttachment';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}","DELETE",{conversationId:e,attachmentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagesCachedmediaCachedMediaItemId(e){if(void 0===e||null===e)throw'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';return this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}","DELETE",{cachedMediaItemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsFacebookIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsInstagramIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsOpenIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsWhatsappIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","DELETE",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","DELETE",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getAnalyticsConversationDetails';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetails(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/conversations/details","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantSecureivrsession(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantSecureivrsession';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantSecureivrsession';if(void 0===t||null===t)throw'Missing the required parameter "secureSessionId" when calling getConversationParticipantSecureivrsession';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}","GET",{conversationId:e,participantId:i,secureSessionId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantSecureivrsessions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantSecureivrsessions';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantSecureivrsessions';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationSecureattributes(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversations(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations","GET",{},{communicationType:e.communicationType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCall(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCallParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallback(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallback';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCallbackParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbacks(){return this.apiClient.callApi("/api/v2/conversations/callbacks","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCalls(){return this.apiClient.callApi("/api/v2/conversations/calls","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallsHistory(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/calls/history","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,interval:e.interval,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallsMaximumconferenceparties(){return this.apiClient.callApi("/api/v2/conversations/calls/maximumconferenceparties","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChat(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChat';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsChatMessage';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatMessages';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/messages","GET",{conversationId:e},{after:i.after,before:i.before,sortOrder:i.sortOrder,maxResults:i.maxResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsChatParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChats(){return this.apiClient.callApi("/api/v2/conversations/chats","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesession(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesession';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessions(){return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmail(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmail';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsEmailMessage';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessages(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessagesDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsEmailParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailSettings';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/settings","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmails(){return this.apiClient.callApi("/api/v2/conversations/emails","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsKeyconfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/{keyconfigurationsId}","GET",{keyconfigurationsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsKeyconfigurations(){return this.apiClient.callApi("/api/v2/conversations/keyconfigurations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageCommunicationMessagesMediaMediaId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';if(void 0===t||null===t)throw'Missing the required parameter "mediaId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}","GET",{conversationId:e,communicationId:i,mediaId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageDetails(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getConversationsMessageDetails';return this.apiClient.callApi("/api/v2/conversations/messages/{messageId}/details","GET",{messageId:e},{useNormalizedMessage:i.useNormalizedMessage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageMessage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsMessageMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{useNormalizedMessage:t.useNormalizedMessage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsMessageParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessages(){return this.apiClient.callApi("/api/v2/conversations/messages","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagesCachedmedia(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,url:e.url},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagesCachedmediaCachedMediaItemId(e){if(void 0===e||null===e)throw'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';return this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}","GET",{cachedMediaItemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingFacebookApp(){return this.apiClient.callApi("/api/v2/conversations/messaging/facebook/app","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingFacebookPermissions(){return this.apiClient.callApi("/api/v2/conversations/messaging/facebook/permissions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsFacebook(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsFacebookIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsInstagram(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsInstagramIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsOpen(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsOpenIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsWhatsapp(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsWhatsappIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","GET",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/settings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSticker(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';return this.apiClient.callApi("/api/v2/conversations/messaging/stickers/{messengerType}","GET",{messengerType:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontent(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontentDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","GET",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingThreadingtimeline(){return this.apiClient.callApi("/api/v2/conversations/messaging/threadingtimeline","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsScreenshareParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsScreenshareParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsSettings(){return this.apiClient.callApi("/api/v2/conversations/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsSocialParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsSocialParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsSocialParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsSocialParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideoDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conferenceId" when calling getConversationsVideoDetails';return this.apiClient.callApi("/api/v2/conversations/videos/{conferenceId}/details","GET",{conferenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideoParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsVideoParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsVideoParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsVideoParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideosMeeting(e){if(void 0===e||null===e)throw'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';return this.apiClient.callApi("/api/v2/conversations/videos/meetings/{meetingId}","GET",{meetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationParticipant';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationSecureattributes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationUtilizationlabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationUtilizationlabel';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationUtilizationlabel';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/utilizationlabel","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsAftercallworkConversationIdParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCall(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCall';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipant';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCallParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantConsult(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantConsult';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallback(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallback';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCallback';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipant';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbacks(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchConversationsCallbacks';return this.apiClient.callApi("/api/v2/conversations/callbacks","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChat(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChat';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsChat';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsChatParticipant';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsChatParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsChatParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsChatParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesession(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesession';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCobrowsesession';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipant(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipant';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipantAttributes(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCobrowsesessionParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmail(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmail';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsEmail';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailMessagesDraft(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","PATCH",{conversationId:e},{autoFill:i.autoFill,discard:i.discard},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipant';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsEmailParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipant(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipant';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipantAttributes(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsMessageParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsMessageParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsFacebookIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsFacebookIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsInstagramIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsOpenIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsWhatsappIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingSetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","PATCH",{messageSettingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingSupportedcontentSupportedContentId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","PATCH",{supportedContentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchConversationsSettings';return this.apiClient.callApi("/api/v2/conversations/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationDetailsProperties(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details/properties","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationAssign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationAssign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationAssign';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/assign","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationBarge(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationBarge';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/barge","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationCobrowse(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationCobrowse';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/cobrowse","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationDisconnect';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/disconnect","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantCallbacks(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantCallbacks';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantCallbacks';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantDigits(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantDigits';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantDigits';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/digits","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceExternal(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantSecureivrsessions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantSecureivrsessions';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantSecureivrsessions';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationSummaryFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';if(void 0===i||null===i)throw'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback","POST",{conversationId:e,summaryId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCall(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCall';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantBarge(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantCoach(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCoach';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCoach';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCallParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsult(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsult';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultExternal(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantMonitor(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantMonitor';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantMonitor';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipants(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipants';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsCallParticipants';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbackParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallbackParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallbackParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCallbackParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbackParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallbackParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallbackParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallbackParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacks(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacks';return this.apiClient.callApi("/api/v2/conversations/callbacks","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacksBulkDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacksBulkDisconnect';return this.apiClient.callApi("/api/v2/conversations/callbacks/bulk/disconnect","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacksBulkUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacksBulkUpdate';return this.apiClient.callApi("/api/v2/conversations/callbacks/bulk/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCalls(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCalls';return this.apiClient.callApi("/api/v2/conversations/calls","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatCommunicationMessages(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationMessages';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsChatCommunicationMessages';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages","POST",{conversationId:e,communicationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatCommunicationTyping(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationTyping';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationTyping';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing","POST",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsChatParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsChatParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChats(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsChats';return this.apiClient.callApi("/api/v2/conversations/chats","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCobrowsesessionParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCobrowsesessionParticipantReplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailInboundmessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailInboundmessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailInboundmessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/inboundmessages","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailMessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailMessagesDraftAttachmentsCopy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailMessagesDraftAttachmentsCopy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailMessagesDraftAttachmentsCopy';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsEmailParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsEmailParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmails(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsEmails';return this.apiClient.callApi("/api/v2/conversations/emails","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailsAgentless(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsEmailsAgentless';return this.apiClient.callApi("/api/v2/conversations/emails/agentless","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsFaxes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsFaxes';return this.apiClient.callApi("/api/v2/conversations/faxes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsKeyconfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsKeyconfigurations';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsKeyconfigurationsValidate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/validate","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationMessages(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessages';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages","POST",{conversationId:e,communicationId:i},{useNormalizedMessage:n.useNormalizedMessage},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationMessagesMedia(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMedia';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMedia';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media","POST",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationTyping(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing","POST",{conversationId:e,communicationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenEvent(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/event","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/message","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenReceipt(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/receipt","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageMessagesBulk(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageMessagesBulk';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/messages/bulk","POST",{conversationId:e},{useNormalizedMessage:i.useNormalizedMessage},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsMessageParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantMonitor(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantMonitor';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantMonitor';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessages';return this.apiClient.callApi("/api/v2/conversations/messages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagesAgentless(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagesAgentless';return this.apiClient.callApi("/api/v2/conversations/messages/agentless","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagesInboundOpen(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagesInboundOpen';return this.apiClient.callApi("/api/v2/conversations/messages/inbound/open","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsFacebook(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsInstagram(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsOpen(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsWhatsapp(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingSettings';return this.apiClient.callApi("/api/v2/conversations/messaging/settings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingSupportedcontent(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsParticipantsAttributesSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';return this.apiClient.callApi("/api/v2/conversations/participants/attributes/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsScreenshareParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsScreenshareParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsSocialParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsVideoParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsVideosMeetings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsVideosMeetings';return this.apiClient.callApi("/api/v2/conversations/videos/meetings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationParticipantFlaggedreason(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationParticipantFlaggedreason';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling putConversationParticipantFlaggedreason';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason","PUT",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationSecureattributes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationSecureattributes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationTags(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationTags';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationTags';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/tags","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallParticipantCommunicationUuidata(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling putConversationsCallParticipantCommunicationUuidata';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata","PUT",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCallRecordingstate';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallbackRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsChatRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsChatRecordingstate';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCobrowsesessionRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsEmailMessagesDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsEmailMessagesDraft';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsEmailRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsKeyconfiguration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsKeyconfiguration';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/{keyconfigurationsId}","PUT",{keyconfigurationsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessageRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingSettingsDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingSupportedcontentDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingThreadingtimeline(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingThreadingtimeline';return this.apiClient.callApi("/api/v2/conversations/messaging/threadingtimeline","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsScreenshareRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsSocialRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsVideoRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class j{constructor(e){this.apiClient=e||d.instance}getDataextensionsCoretype(e){if(void 0===e||null===e)throw'Missing the required parameter "coretypeName" when calling getDataextensionsCoretype';return this.apiClient.callApi("/api/v2/dataextensions/coretypes/{coretypeName}","GET",{coretypeName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDataextensionsCoretypes(){return this.apiClient.callApi("/api/v2/dataextensions/coretypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDataextensionsLimits(){return this.apiClient.callApi("/api/v2/dataextensions/limits","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class P{constructor(e){this.apiClient=e||d.instance}getDownload(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "downloadId" when calling getDownload';return this.apiClient.callApi("/api/v2/downloads/{downloadId}","GET",{downloadId:e},{contentDisposition:i.contentDisposition,issueRedirect:i.issueRedirect,redirectToAuth:i.redirectToAuth},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class y{constructor(e){this.apiClient=e||d.instance}getEmailsSettings(){return this.apiClient.callApi("/api/v2/emails/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmailsSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/emails/settings","PATCH",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class O{constructor(e){this.apiClient=e||d.instance}postEventsConversations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsConversations';return this.apiClient.callApi("/api/v2/events/conversations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postEventsUsersPresence(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsUsersPresence';return this.apiClient.callApi("/api/v2/events/users/presence","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postEventsUsersRoutingstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';return this.apiClient.callApi("/api/v2/events/users/routingstatus","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class M{constructor(e){this.apiClient=e||d.instance}deleteExternalcontactsContact(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling deleteExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","DELETE",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsContactNote(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling deleteExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling deleteExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","DELETE",{contactId:e,noteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsContactsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling deleteExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","DELETE",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganization(e){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","DELETE",{externalOrganizationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganizationNote(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling deleteExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","DELETE",{externalOrganizationId:e,noteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationTrustor';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor","DELETE",{externalOrganizationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsRelationship(e){if(void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling deleteExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","DELETE",{relationshipId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContact(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","GET",{contactId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactIdentifiers(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/identifiers","GET",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactJourneySessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/journey/sessions","GET",{contactId:e},{pageSize:i.pageSize,after:i.after,includeMerged:i.includeMerged},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactNote(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling getExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","GET",{contactId:e,noteId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactNotes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactNotes';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes","GET",{contactId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactUnresolved(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/unresolved","GET",{contactId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContacts(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/contacts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,q:e.q,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getExternalcontactsContactsSchemaVersion';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemas(){return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganization(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","GET",{externalOrganizationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),includeTrustors:i.includeTrustors},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationContacts(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationContacts';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,q:i.q,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationNote(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling getExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","GET",{externalOrganizationId:e,noteId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationNotes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationNotes';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationRelationships(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizations(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/organizations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,q:e.q,trustorId:this.apiClient.buildCollectionParam(e.trustorId,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),includeTrustors:e.includeTrustors},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getExternalcontactsOrganizationsSchemaVersion';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersions';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemas(){return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsRelationship(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling getExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","GET",{relationshipId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsReversewhitepageslookup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "lookupVal" when calling getExternalcontactsReversewhitepageslookup';return this.apiClient.callApi("/api/v2/externalcontacts/reversewhitepageslookup","GET",{},{lookupVal:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanContacts(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/contacts","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanNotes(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/notes","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanOrganizations(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/organizations","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanRelationships(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/relationships","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchExternalcontactsContactIdentifiers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/identifiers","PATCH",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContacts';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsUnresolved(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/unresolved","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotes';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizations';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationships(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactNotes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling postExternalcontactsContactNotes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postExternalcontactsContactNotes';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes","POST",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactPromotion(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/promotion","POST",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsContacts';return this.apiClient.callApi("/api/v2/externalcontacts/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsContactsSchemas';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsIdentifierlookup(e){if(void 0===e||null===e)throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';return this.apiClient.callApi("/api/v2/externalcontacts/identifierlookup","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsMergeContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';return this.apiClient.callApi("/api/v2/externalcontacts/merge/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizationNotes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling postExternalcontactsOrganizationNotes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationNotes';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes","POST",{externalOrganizationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizations';return this.apiClient.callApi("/api/v2/externalcontacts/organizations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizationsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationsSchemas';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsRelationships(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/relationships","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling putExternalcontactsContact';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","PUT",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContactNote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling putExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling putExternalcontactsContactNote';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","PUT",{contactId:e,noteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContactsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putExternalcontactsContactsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsConversation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putExternalcontactsConversation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsConversation';return this.apiClient.callApi("/api/v2/externalcontacts/conversations/{conversationId}","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","PUT",{externalOrganizationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationNote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling putExternalcontactsOrganizationNote';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","PUT",{externalOrganizationId:e,noteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationTrustorTrustorId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationTrustorTrustorId';if(void 0===i||null===i)throw'Missing the required parameter "trustorId" when calling putExternalcontactsOrganizationTrustorTrustorId';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}","PUT",{externalOrganizationId:e,trustorId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putExternalcontactsOrganizationsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsOrganizationsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsRelationship(e,i){if(void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling putExternalcontactsRelationship';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","PUT",{relationshipId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class T{constructor(e){this.apiClient=e||d.instance}deleteFaxDocument(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","DELETE",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocument(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","GET",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocumentContent(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getFaxDocumentContent';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}/content","GET",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocuments(e){return e=e||{},this.apiClient.callApi("/api/v2/fax/documents","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxSettings(){return this.apiClient.callApi("/api/v2/fax/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxSummary(){return this.apiClient.callApi("/api/v2/fax/summary","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putFaxDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling putFaxDocument';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","PUT",{documentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFaxSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/fax/settings","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class q{constructor(e){this.apiClient=e||d.instance}getAnalyticsFlowsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/flows/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/flows/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class S{constructor(e){this.apiClient=e||d.instance}deleteEmployeeperformanceExternalmetricsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","DELETE",{metricId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getEmployeeperformanceExternalmetricsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling getEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","GET",{metricId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getEmployeeperformanceExternalmetricsDefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsights(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsights';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsights';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsights';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';if(void 0===a||null===a)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';return this.apiClient.callApi("/api/v2/gamification/insights","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,primaryPeriodStartWorkday:a,pageSize:o.pageSize,pageNumber:o.pageNumber,sortKey:o.sortKey,sortMetricId:o.sortMetricId,sortOrder:o.sortOrder,userIds:o.userIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsDetails(e,i,t,n,a){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';if(void 0===a||null===a)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';return this.apiClient.callApi("/api/v2/gamification/insights/details","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,primaryPeriodStartWorkday:a},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsGroupsTrends(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';return this.apiClient.callApi("/api/v2/gamification/insights/groups/trends","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsGroupsTrendsAll(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';return this.apiClient.callApi("/api/v2/gamification/insights/groups/trends/all","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsMembers(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';return this.apiClient.callApi("/api/v2/gamification/insights/members","GET",{},{filterType:e,filterId:i,granularity:t,startWorkday:n},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsTrends(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';return this.apiClient.callApi("/api/v2/gamification/insights/trends","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsUserDetails(e,i,t,n,a,o){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';if(void 0===i||null===i)throw'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';if(void 0===t||null===t)throw'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';if(void 0===n||null===n)throw'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';return this.apiClient.callApi("/api/v2/gamification/insights/users/{userId}/details","GET",{userId:e},{filterType:i,filterId:t,granularity:n,comparativePeriodStartWorkday:a,primaryPeriodStartWorkday:o},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsUserTrends(e,i,t,n,a,o,r,l){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';if(void 0===t||null===t)throw'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';if(void 0===n||null===n)throw'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';if(void 0===o||null===o)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';if(void 0===l||null===l)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';return this.apiClient.callApi("/api/v2/gamification/insights/users/{userId}/trends","GET",{userId:e},{filterType:i,filterId:t,granularity:n,comparativePeriodStartWorkday:a,comparativePeriodEndWorkday:o,primaryPeriodStartWorkday:r,primaryPeriodEndWorkday:l},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboard(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationLeaderboard';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationLeaderboard';return this.apiClient.callApi("/api/v2/gamification/leaderboard","GET",{},{startWorkday:e,endWorkday:i,metricId:t.metricId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardAll(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationLeaderboardAll';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationLeaderboardAll';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationLeaderboardAll';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationLeaderboardAll';return this.apiClient.callApi("/api/v2/gamification/leaderboard/all","GET",{},{filterType:e,filterId:i,startWorkday:t,endWorkday:n,metricId:a.metricId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardAllBestpoints(e,i){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationLeaderboardAllBestpoints';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationLeaderboardAllBestpoints';return this.apiClient.callApi("/api/v2/gamification/leaderboard/all/bestpoints","GET",{},{filterType:e,filterId:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardBestpoints(){return this.apiClient.callApi("/api/v2/gamification/leaderboard/bestpoints","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationMetricdefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricDefinitionId" when calling getGamificationMetricdefinition';return this.apiClient.callApi("/api/v2/gamification/metricdefinitions/{metricDefinitionId}","GET",{metricDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationMetricdefinitions(){return this.apiClient.callApi("/api/v2/gamification/metricdefinitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfile(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfile';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}","GET",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMembers(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMembers';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members","GET",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetric(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetric';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationProfileMetric';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/{metricId}","GET",{profileId:e,metricId:i},{workday:t.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetrics(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetrics';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics","GET",{profileId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),workday:i.workday,metricIds:i.metricIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetricsObjectivedetails(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetricsObjectivedetails';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails","GET",{profileId:e},{workday:i.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfiles(){return this.apiClient.callApi("/api/v2/gamification/profiles","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfilesUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationProfilesUser';return this.apiClient.callApi("/api/v2/gamification/profiles/users/{userId}","GET",{userId:e},{workday:i.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfilesUsersMe(e){return e=e||{},this.apiClient.callApi("/api/v2/gamification/profiles/users/me","GET",{},{workday:e.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecards(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecards';return this.apiClient.callApi("/api/v2/gamification/scorecards","GET",{},{workday:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsAttendance(e,i){if(void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsAttendance';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsAttendance';return this.apiClient.callApi("/api/v2/gamification/scorecards/attendance","GET",{},{startWorkday:e,endWorkday:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsBestpoints(){return this.apiClient.callApi("/api/v2/gamification/scorecards/bestpoints","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsAlltime(e){if(void 0===e||null===e)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsPointsAlltime';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/alltime","GET",{},{endWorkday:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsAverage(e){if(void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecardsPointsAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/average","GET",{},{workday:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsTrends(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsPointsTrends';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsPointsTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/trends","GET",{},{startWorkday:e,endWorkday:i,dayOfWeek:t.dayOfWeek},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricUserValuesTrends(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===a||null===a)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends","GET",{profileId:e,metricId:i,userId:t},{startWorkday:n,endWorkday:a,referenceWorkday:o.referenceWorkday,timeZone:o.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricUsersValuesTrends(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===a||null===a)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends","GET",{profileId:e,metricId:i},{filterType:t,filterId:o.filterId,startWorkday:n,endWorkday:a,referenceWorkday:o.referenceWorkday,timeZone:o.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricValuesTrends(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends","GET",{profileId:e,metricId:i},{filterType:a.filterType,startWorkday:t,endWorkday:n,referenceWorkday:a.referenceWorkday,timeZone:a.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUser';if(void 0===i||null===i)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUser';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}","GET",{userId:e},{workday:i,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserAttendance(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserAttendance';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserAttendance';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserAttendance';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/attendance","GET",{userId:e},{startWorkday:i,endWorkday:t},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserBestpoints(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserBestpoints';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/bestpoints","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserPointsAlltime(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserPointsAlltime';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserPointsAlltime';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/points/alltime","GET",{userId:e},{endWorkday:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserPointsTrends(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserPointsTrends';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserPointsTrends';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserPointsTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/points/trends","GET",{userId:e},{startWorkday:i,endWorkday:t,dayOfWeek:n.dayOfWeek},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserValuesTrends(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/values/trends","GET",{userId:e},{startWorkday:i,endWorkday:t,timeZone:n.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersPointsAverage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersPointsAverage';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersPointsAverage';if(void 0===t||null===t)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUsersPointsAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/points/average","GET",{},{filterType:e,filterId:i,workday:t},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersValuesAverage(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersValuesAverage';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersValuesAverage';if(void 0===t||null===t)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUsersValuesAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/values/average","GET",{},{filterType:e,filterId:i,workday:t,timeZone:n.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersValuesTrends(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUsersValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/values/trends","GET",{},{filterType:e,filterId:i,startWorkday:t,endWorkday:n,timeZone:a.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsValuesAverage(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecardsValuesAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/values/average","GET",{},{workday:e,timeZone:i.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsValuesTrends(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/values/trends","GET",{},{filterType:t.filterType,referenceWorkday:t.referenceWorkday,startWorkday:e,endWorkday:i,timeZone:t.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationStatus(){return this.apiClient.callApi("/api/v2/gamification/status","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "templateId" when calling getGamificationTemplate';return this.apiClient.callApi("/api/v2/gamification/templates/{templateId}","GET",{templateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationTemplates(){return this.apiClient.callApi("/api/v2/gamification/templates","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmployeeperformanceExternalmetricsDefinition(e,i){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","PATCH",{metricId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postEmployeeperformanceExternalmetricsData(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/data","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postEmployeeperformanceExternalmetricsDefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileActivate(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileActivate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/activate","POST",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileDeactivate(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/deactivate","POST",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMembers';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMembersValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members/validate","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMetricLink(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';if(void 0===i||null===i)throw'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postGamificationProfileMetricLink';return this.apiClient.callApi("/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link","POST",{sourceProfileId:e,sourceMetricId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMetrics(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMetrics';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMetrics';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfiles(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postGamificationProfiles';return this.apiClient.callApi("/api/v2/gamification/profiles","POST",{},{copyMetrics:i.copyMetrics},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfilesUserQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';return this.apiClient.callApi("/api/v2/gamification/profiles/users/{userId}/query","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfilesUsersMeQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';return this.apiClient.callApi("/api/v2/gamification/profiles/users/me/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling putGamificationProfile';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}","PUT",{profileId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationProfileMetric(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling putGamificationProfileMetric';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling putGamificationProfileMetric';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putGamificationProfileMetric';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/{metricId}","PUT",{profileId:e,metricId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationStatus(e){if(void 0===e||null===e)throw'Missing the required parameter "status" when calling putGamificationStatus';return this.apiClient.callApi("/api/v2/gamification/status","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class k{constructor(e){this.apiClient=e||d.instance}getGdprRequest(e){if(void 0===e||null===e)throw'Missing the required parameter "requestId" when calling getGdprRequest';return this.apiClient.callApi("/api/v2/gdpr/requests/{requestId}","GET",{requestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGdprRequests(e){return e=e||{},this.apiClient.callApi("/api/v2/gdpr/requests","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGdprSubjects(e,i){if(void 0===e||null===e)throw'Missing the required parameter "searchType" when calling getGdprSubjects';if(void 0===i||null===i)throw'Missing the required parameter "searchValue" when calling getGdprSubjects';return this.apiClient.callApi("/api/v2/gdpr/subjects","GET",{},{searchType:e,searchValue:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGdprRequests(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postGdprRequests';return this.apiClient.callApi("/api/v2/gdpr/requests","POST",{},{deleteConfirmed:i.deleteConfirmed},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class E{constructor(e){this.apiClient=e||d.instance}getGeolocationsSettings(){return this.apiClient.callApi("/api/v2/geolocations/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGeolocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","GET",{userId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchGeolocationsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchGeolocationsSettings';return this.apiClient.callApi("/api/v2/geolocations/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserGeolocation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling patchUserGeolocation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","PATCH",{userId:e,clientId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class G{constructor(e){this.apiClient=e||d.instance}deleteGreeting(e){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling deleteGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","DELETE",{greetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreeting(e){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling getGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","GET",{greetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling getGreetingMedia';return this.apiClient.callApi("/api/v2/greetings/{greetingId}/media","GET",{greetingId:e},{formatId:i.formatId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetings(e){return e=e||{},this.apiClient.callApi("/api/v2/greetings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetingsDefaults(){return this.apiClient.callApi("/api/v2/greetings/defaults","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupGreetings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupGreetings';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupGreetingsDefaults';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings/defaults","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGreetings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGreetings';return this.apiClient.callApi("/api/v2/users/{userId}/greetings","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGreetingsDefaults';return this.apiClient.callApi("/api/v2/users/{userId}/greetings/defaults","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGreetings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGreetings';return this.apiClient.callApi("/api/v2/greetings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupGreetings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling postGroupGreetings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGroupGreetings';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings","POST",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserGreetings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserGreetings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserGreetings';return this.apiClient.callApi("/api/v2/users/{userId}/greetings","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putGreeting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling putGreeting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","PUT",{greetingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putGreetingsDefaults';return this.apiClient.callApi("/api/v2/greetings/defaults","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGroupGreetingsDefaults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroupGreetingsDefaults';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGroupGreetingsDefaults';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings/defaults","PUT",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserGreetingsDefaults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserGreetingsDefaults';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';return this.apiClient.callApi("/api/v2/users/{userId}/greetings/defaults","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class U{constructor(e){this.apiClient=e||d.instance}deleteGroup(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","DELETE",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteGroupDynamicsettings(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","DELETE",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteGroupMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroupMembers';if(void 0===i||null===i)throw'Missing the required parameter "ids" when calling deleteGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","DELETE",{groupId:e},{ids:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroup(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupDynamicsettings(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupIndividuals(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupIndividuals';return this.apiClient.callApi("/api/v2/groups/{groupId}/individuals","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupProfile';return this.apiClient.callApi("/api/v2/groups/{groupId}/profile","GET",{groupId:e},{fields:i.fields},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/groups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProfilesGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/profiles/groups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling postGroupMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","POST",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroups';return this.apiClient.callApi("/api/v2/groups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsDynamicsettingsPreview(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsDynamicsettingsPreview';return this.apiClient.callApi("/api/v2/groups/dynamicsettings/preview","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","PUT",{groupId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putGroupDynamicsettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroupDynamicsettings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","PUT",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class D{constructor(e){this.apiClient=e||d.instance}deleteIdentityprovider(e){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling deleteIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","DELETE",{providerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersAdfs(){return this.apiClient.callApi("/api/v2/identityproviders/adfs","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersCic(){return this.apiClient.callApi("/api/v2/identityproviders/cic","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersGeneric(){return this.apiClient.callApi("/api/v2/identityproviders/generic","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersGsuite(){return this.apiClient.callApi("/api/v2/identityproviders/gsuite","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersIdentitynow(){return this.apiClient.callApi("/api/v2/identityproviders/identitynow","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersOkta(){return this.apiClient.callApi("/api/v2/identityproviders/okta","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersOnelogin(){return this.apiClient.callApi("/api/v2/identityproviders/onelogin","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPing(){return this.apiClient.callApi("/api/v2/identityproviders/ping","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPurecloud(){return this.apiClient.callApi("/api/v2/identityproviders/purecloud","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPureengage(){return this.apiClient.callApi("/api/v2/identityproviders/pureengage","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersSalesforce(){return this.apiClient.callApi("/api/v2/identityproviders/salesforce","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovider(e){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling getIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","GET",{providerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityproviders(){return this.apiClient.callApi("/api/v2/identityproviders","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersAdfs(){return this.apiClient.callApi("/api/v2/identityproviders/adfs","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersCic(){return this.apiClient.callApi("/api/v2/identityproviders/cic","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersGeneric(){return this.apiClient.callApi("/api/v2/identityproviders/generic","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersGsuite(){return this.apiClient.callApi("/api/v2/identityproviders/gsuite","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersIdentitynow(){return this.apiClient.callApi("/api/v2/identityproviders/identitynow","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersOkta(){return this.apiClient.callApi("/api/v2/identityproviders/okta","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersOnelogin(){return this.apiClient.callApi("/api/v2/identityproviders/onelogin","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPing(){return this.apiClient.callApi("/api/v2/identityproviders/ping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPurecloud(){return this.apiClient.callApi("/api/v2/identityproviders/purecloud","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPureengage(){return this.apiClient.callApi("/api/v2/identityproviders/pureengage","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersSalesforce(){return this.apiClient.callApi("/api/v2/identityproviders/salesforce","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIdentityproviders(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIdentityproviders';return this.apiClient.callApi("/api/v2/identityproviders","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovider(e,i){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling putIdentityprovider';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","PUT",{providerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersAdfs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersAdfs';return this.apiClient.callApi("/api/v2/identityproviders/adfs","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersCic(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersCic';return this.apiClient.callApi("/api/v2/identityproviders/cic","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersGeneric(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersGeneric';return this.apiClient.callApi("/api/v2/identityproviders/generic","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersGsuite(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersGsuite';return this.apiClient.callApi("/api/v2/identityproviders/gsuite","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersIdentitynow(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersIdentitynow';return this.apiClient.callApi("/api/v2/identityproviders/identitynow","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersOkta(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersOkta';return this.apiClient.callApi("/api/v2/identityproviders/okta","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersOnelogin(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersOnelogin';return this.apiClient.callApi("/api/v2/identityproviders/onelogin","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPing(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPing';return this.apiClient.callApi("/api/v2/identityproviders/ping","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPurecloud(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPurecloud';return this.apiClient.callApi("/api/v2/identityproviders/purecloud","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPureengage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPureengage';return this.apiClient.callApi("/api/v2/identityproviders/pureengage","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersSalesforce(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';return this.apiClient.callApi("/api/v2/identityproviders/salesforce","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class R{constructor(e){this.apiClient=e||d.instance}getInfrastructureascodeAccelerator(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "acceleratorId" when calling getInfrastructureascodeAccelerator';return this.apiClient.callApi("/api/v2/infrastructureascode/accelerators/{acceleratorId}","GET",{acceleratorId:e},{preferredLanguage:i.preferredLanguage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeAccelerators(e){return e=e||{},this.apiClient.callApi("/api/v2/infrastructureascode/accelerators","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,description:e.description,origin:e.origin,type:e.type,classification:e.classification,tags:e.tags},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeJob(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getInfrastructureascodeJob';return this.apiClient.callApi("/api/v2/infrastructureascode/jobs/{jobId}","GET",{jobId:e},{details:i.details},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/infrastructureascode/jobs","GET",{},{maxResults:e.maxResults,includeErrors:e.includeErrors,sortBy:e.sortBy,sortOrder:e.sortOrder,acceleratorId:e.acceleratorId,submittedBy:e.submittedBy,status:e.status},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postInfrastructureascodeJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';return this.apiClient.callApi("/api/v2/infrastructureascode/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class x{constructor(e){this.apiClient=e||d.instance}deleteIntegration(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsAction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling deleteIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","DELETE",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsActionDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling deleteIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","DELETE",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsCredential(e){if(void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling deleteIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","DELETE",{credentialId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","GET",{integrationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationConfigCurrent(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationConfigCurrent';return this.apiClient.callApi("/api/v2/integrations/{integrationId}/config/current","GET",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsAction(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","GET",{actionId:e},{expand:i.expand,includeConfig:i.includeConfig},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraft(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","GET",{actionId:e},{expand:i.expand,includeConfig:i.includeConfig},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftFunction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftTemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftTemplate';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftTemplate';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["text/plain"])}getIntegrationsActionDraftValidation(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftValidation';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/validation","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionFunction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/function","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/schemas/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionTemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionTemplate';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionTemplate';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/templates/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["text/plain"])}getIntegrationsActions(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,category:e.category,name:e.name,ids:e.ids,secure:e.secure,includeAuthActions:e.includeAuthActions},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsCategories(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/categories","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,secure:e.secure},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsCertificates(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/certificates","GET",{},{status:e.status,type:e.type},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsDrafts(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/drafts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,category:e.category,name:e.name,ids:e.ids,secure:e.secure,includeAuthActions:e.includeAuthActions},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsFunctionsRuntimes(){return this.apiClient.callApi("/api/v2/integrations/actions/functions/runtimes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBot(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBot';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsBotconnectorIntegrationIdBot';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/{botId}","GET",{integrationId:e,botId:i},{version:t.version},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBotVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBotVersions';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsBotconnectorIntegrationIdBotVersions';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions","GET",{integrationId:e,botId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBots(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots","GET",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBotsSummaries(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBotsSummaries';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/summaries","GET",{integrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsClientapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/clientapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsClientappsUnifiedcommunications(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/clientapps/unifiedcommunications","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredential(e){if(void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling getIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","GET",{credentialId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredentials(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/credentials","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredentialsTypes(){return this.apiClient.callApi("/api/v2/integrations/credentials/types","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowAgent(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowAgent';return this.apiClient.callApi("/api/v2/integrations/speech/dialogflow/agents/{agentId}","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/dialogflow/agents","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowcxAgent(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowcxAgent';return this.apiClient.callApi("/api/v2/integrations/speech/dialogflowcx/agents/{agentId}","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowcxAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/dialogflowcx/agents","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBotAlias(e){if(void 0===e||null===e)throw'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexBotAlias';return this.apiClient.callApi("/api/v2/integrations/speech/lex/bot/alias/{aliasId}","GET",{aliasId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBotBotIdAliases(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechLexBotBotIdAliases';return this.apiClient.callApi("/api/v2/integrations/speech/lex/bot/{botId}/aliases","GET",{botId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,status:i.status,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBots(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/lex/bots","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2BotAlias(e){if(void 0===e||null===e)throw'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexv2BotAlias';return this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}","GET",{aliasId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2BotBotIdAliases(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechLexv2BotBotIdAliases';return this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bot/{botId}/aliases","GET",{botId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,status:i.status,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2Bots(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bots","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBot(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}","GET",{nuanceIntegrationId:e,botId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi"),targetChannel:t.targetChannel},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}","GET",{nuanceIntegrationId:e,botId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results","GET",{nuanceIntegrationId:e,botId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBots(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots","GET",{nuanceIntegrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,onlyRegisteredBots:i.onlyRegisteredBots},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}","GET",{nuanceIntegrationId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results","GET",{nuanceIntegrationId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechSttEngine(e){if(void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechSttEngine';return this.apiClient.callApi("/api/v2/integrations/speech/stt/engines/{engineId}","GET",{engineId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechSttEngines(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/stt/engines","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngine(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngine';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}","GET",{engineId:e},{includeVoices:i.includeVoices},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngineVoice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngineVoice';if(void 0===i||null===i)throw'Missing the required parameter "voiceId" when calling getIntegrationsSpeechTtsEngineVoice';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}","GET",{engineId:e,voiceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngineVoices(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngineVoices';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}/voices","GET",{engineId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngines(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/tts/engines","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,includeVoices:e.includeVoices,name:e.name,language:e.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsSettings(){return this.apiClient.callApi("/api/v2/integrations/speech/tts/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsType(e){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getIntegrationsType';return this.apiClient.callApi("/api/v2/integrations/types/{typeId}","GET",{typeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsTypeConfigschema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getIntegrationsTypeConfigschema';if(void 0===i||null===i)throw'Missing the required parameter "configType" when calling getIntegrationsTypeConfigschema';return this.apiClient.callApi("/api/v2/integrations/types/{typeId}/configschemas/{configType}","GET",{typeId:e,configType:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsTypes(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/types","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUnifiedcommunicationsClientapp(e){if(void 0===e||null===e)throw'Missing the required parameter "ucIntegrationId" when calling getIntegrationsUnifiedcommunicationsClientapp';return this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}","GET",{ucIntegrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUnifiedcommunicationsClientapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/clientapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUserapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/userapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,appHost:e.appHost},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","PATCH",{integrationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegrationsAction(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling patchIntegrationsAction';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","PATCH",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegrationsActionDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling patchIntegrationsActionDraft';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","PATCH",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","POST",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftFunctionUpload(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function/upload","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftPublish(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftPublish';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftPublish';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/publish","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftTest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/test","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionExecute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/execute","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionTest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionTest';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/test","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIntegrationsActions';return this.apiClient.callApi("/api/v2/integrations/actions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionsDrafts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIntegrationsActionsDrafts';return this.apiClient.callApi("/api/v2/integrations/actions/drafts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsCredentials(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/credentials","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs","POST",{nuanceIntegrationId:e,botId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs","POST",{nuanceIntegrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,onlyRegisteredBots:i.onlyRegisteredBots},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';if(void 0===i||null===i)throw'Missing the required parameter "settings" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate","POST",{nuanceIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationConfigCurrent(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling putIntegrationConfigCurrent';return this.apiClient.callApi("/api/v2/integrations/{integrationId}/config/current","PUT",{integrationId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsActionDraftFunction(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function","PUT",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsBotconnectorIntegrationIdBots(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling putIntegrationsBotconnectorIntegrationIdBots';if(void 0===i||null===i)throw'Missing the required parameter "botList" when calling putIntegrationsBotconnectorIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots","PUT",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsCredential(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling putIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","PUT",{credentialId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';if(void 0===i||null===i)throw'Missing the required parameter "settings" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings","PUT",{nuanceIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsSpeechTtsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIntegrationsSpeechTtsSettings';return this.apiClient.callApi("/api/v2/integrations/speech/tts/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsUnifiedcommunicationThirdpartypresences(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';return this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences","PUT",{ucIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class z{constructor(e){this.apiClient=e||d.instance}deleteJourneyActionmap(e){if(void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling deleteJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","DELETE",{actionMapId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyActiontemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling deleteJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","DELETE",{actionTemplateId:e},{hardDelete:i.hardDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling deleteJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","DELETE",{outcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyOutcomesPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';return this.apiClient.callApi("/api/v2/journey/outcomes/predictors/{predictorId}","DELETE",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneySegment(e){if(void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling deleteJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","DELETE",{segmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyView(e){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling deleteJourneyView';return this.apiClient.callApi("/api/v2/journey/views/{viewId}","DELETE",{viewId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactJourneySessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/journey/sessions","GET",{contactId:e},{pageSize:i.pageSize,after:i.after,includeMerged:i.includeMerged},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmap(e){if(void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling getJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","GET",{actionMapId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmaps(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actionmaps","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,filterField:e.filterField,filterValue:e.filterValue,actionMapIds:this.apiClient.buildCollectionParam(e.actionMapIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmapsEstimatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmapsEstimatesJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontarget(e){if(void 0===e||null===e)throw'Missing the required parameter "actionTargetId" when calling getJourneyActiontarget';return this.apiClient.callApi("/api/v2/journey/actiontargets/{actionTargetId}","GET",{actionTargetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontargets(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontargets","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling getJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","GET",{actionTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontemplates","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,mediaType:e.mediaType,state:e.state,queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyDeploymentCustomerPing(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';if(void 0===i||null===i)throw'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping","GET",{deploymentId:e,customerCookieId:i},{dl:t.dl,dt:t.dt,appNamespace:t.appNamespace,sessionId:t.sessionId,sinceLastBeaconMilliseconds:t.sinceLastBeaconMilliseconds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling getJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","GET",{outcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,outcomeIds:this.apiClient.buildCollectionParam(e.outcomeIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesAttributionsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJob';return this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesAttributionsJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJobResults';return this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';return this.apiClient.callApi("/api/v2/journey/outcomes/predictors/{predictorId}","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesPredictors(){return this.apiClient.callApi("/api/v2/journey/outcomes/predictors","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySegment(e){if(void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling getJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","GET",{segmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySegments(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/segments","GET",{},{sortBy:e.sortBy,pageSize:e.pageSize,pageNumber:e.pageNumber,isActive:e.isActive,segmentIds:this.apiClient.buildCollectionParam(e.segmentIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySession(e){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySession';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}","GET",{sessionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySessionEvents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySessionEvents';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}/events","GET",{sessionId:e},{pageSize:i.pageSize,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySessionOutcomescores(e){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySessionOutcomescores';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}/outcomescores","GET",{sessionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyView(e){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyView';return this.apiClient.callApi("/api/v2/journey/views/{viewId}","GET",{viewId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{versionId}","GET",{viewId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}","GET",{viewId:e,journeyVersionId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJobResults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';if(void 0===i||null===i)throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results","GET",{viewId:e,journeyViewVersion:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJobsLatest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest","GET",{viewId:e,journeyVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViews(){return this.apiClient.callApi("/api/v2/journey/views","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewsEventdefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';return this.apiClient.callApi("/api/v2/journey/views/eventdefinitions/{eventDefinitionId}","GET",{eventDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewsEventdefinitions(){return this.apiClient.callApi("/api/v2/journey/views/eventdefinitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActionmap(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling patchJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","PATCH",{actionMapId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActiontarget(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTargetId" when calling patchJourneyActiontarget';return this.apiClient.callApi("/api/v2/journey/actiontargets/{actionTargetId}","PATCH",{actionTargetId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActiontemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling patchJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","PATCH",{actionTemplateId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyOutcome(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling patchJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","PATCH",{outcomeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneySegment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling patchJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","PATCH",{segmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActionmaps(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actionmaps","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActionmapsEstimatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActiontemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontemplates","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyDeploymentActionevent(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/actionevent","POST",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyDeploymentAppevents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/appevents","POST",{deploymentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyFlowsPathsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/flows/paths/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomesAttributionsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomesPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes/predictors","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneySegments(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/segments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewVersionJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs","POST",{viewId:e,journeyVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewVersions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling postJourneyViewVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postJourneyViewVersions';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions","POST",{viewId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViews(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postJourneyViews';return this.apiClient.callApi("/api/v2/journey/views","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewsEncodingsValidate(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/views/encodings/validate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class W{constructor(e){this.apiClient=e||d.instance}deleteKnowledgeKnowledgebase(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","DELETE",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseCategory(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","DELETE",{knowledgeBaseId:e,categoryId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","DELETE",{knowledgeBaseId:e,documentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseDocumentVariation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","DELETE",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}","DELETE",{knowledgeBaseId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseImportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","DELETE",{knowledgeBaseId:e,importJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","DELETE",{knowledgeBaseId:e,labelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","DELETE",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","DELETE",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","DELETE",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionCategories(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/categories","GET",{sessionId:e},{before:i.before,after:i.after,pageSize:i.pageSize,parentId:i.parentId,isRoot:i.isRoot,name:i.name,sortBy:i.sortBy,expand:i.expand,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}","GET",{sessionId:e,documentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents","GET",{sessionId:e},{categoryId:this.apiClient.buildCollectionParam(i.categoryId,"multi"),pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebase(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","GET",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseCategories(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,parentId:i.parentId,isRoot:i.isRoot,name:i.name,sortBy:i.sortBy,expand:i.expand,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseCategory(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","GET",{knowledgeBaseId:e,categoryId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocument(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","GET",{knowledgeBaseId:e,documentId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi"),state:t.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,onlyCommented:t.onlyCommented,documentVersionId:t.documentVersionId,documentVariationId:t.documentVariationId,appType:t.appType,queryType:t.queryType,userId:t.userId,queueId:t.queueId,state:t.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';if(void 0===t||null===t)throw'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}","GET",{knowledgeBaseId:e,documentId:i,feedbackId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVariation(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","GET",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{documentState:n.documentState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVariations(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,documentState:t.documentState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersion(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}","GET",{knowledgeBaseId:e,documentId:i,versionId:t},{expand:this.apiClient.buildCollectionParam(n.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersionVariation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===n||null===n)throw'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}","GET",{knowledgeBaseId:e,documentId:i,versionId:t,variationId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersionVariations(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations","GET",{knowledgeBaseId:e,documentId:i,versionId:t},{before:n.before,after:n.after,pageSize:n.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,interval:i.interval,documentId:this.apiClient.buildCollectionParam(i.documentId,"multi"),categoryId:this.apiClient.buildCollectionParam(i.categoryId,"multi"),includeSubcategories:i.includeSubcategories,includeDrafts:i.includeDrafts,labelIds:this.apiClient.buildCollectionParam(i.labelIds,"multi"),expand:this.apiClient.buildCollectionParam(i.expand,"multi"),externalIds:this.apiClient.buildCollectionParam(i.externalIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}","GET",{knowledgeBaseId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseImportJob(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","GET",{knowledgeBaseId:e,importJobId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","GET",{knowledgeBaseId:e,labelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLabels(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,name:i.name,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageCategories(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,name:t.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","GET",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","GET",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocumentUpload(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===n||null===n)throw'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}","GET",{documentId:e,knowledgeBaseId:i,languageCode:t,uploadId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,categories:t.categories,title:t.title,sortBy:t.sortBy,sortOrder:t.sortOrder,documentIds:this.apiClient.buildCollectionParam(t.documentIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","GET",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageTraining(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';if(void 0===t||null===t)throw'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}","GET",{knowledgeBaseId:e,languageCode:i,trainingId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageTrainings(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,knowledgeDocumentsState:t.knowledgeDocumentsState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseOperations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,userId:this.apiClient.buildCollectionParam(i.userId,"multi"),type:this.apiClient.buildCollectionParam(i.type,"multi"),status:this.apiClient.buildCollectionParam(i.status,"multi"),interval:i.interval},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseOperationsUsersQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query","GET",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseParseJob(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}","GET",{knowledgeBaseId:e,parseJobId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}","GET",{knowledgeBaseId:e,groupId:i},{app:t.app,dateStart:t.dateStart,dateEnd:t.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===t||null===t)throw'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}","GET",{knowledgeBaseId:e,groupId:i,phraseGroupId:t},{app:n.app,dateStart:n.dateStart,dateEnd:n.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups","GET",{knowledgeBaseId:e},{app:i.app,dateStart:i.dateStart,dateEnd:i.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUploadsUrlsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}","GET",{knowledgeBaseId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebases(e){return e=e||{},this.apiClient.callApi("/api/v2/knowledge/knowledgebases","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,name:e.name,coreLanguage:e.coreLanguage,published:e.published,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeGuestSessionDocumentsSearchSearchId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';if(void 0===i||null===i)throw'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}","PATCH",{sessionId:e,searchId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebase(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebase';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","PATCH",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","PATCH",{knowledgeBaseId:e,categoryId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","PATCH",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocumentVariation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","PATCH",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocumentsSearchSearchId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';if(void 0===i||null===i)throw'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}","PATCH",{knowledgeBaseId:e,searchId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseImportJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","PATCH",{knowledgeBaseId:e,importJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLabel(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","PATCH",{knowledgeBaseId:e,labelId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageCategory(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","PATCH",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocument(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","PATCH",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","PATCH",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","PATCH",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseParseJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseParseJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}","PATCH",{knowledgeBaseId:e,parseJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===t||null===t)throw'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}","PATCH",{knowledgeBaseId:e,groupId:i,phraseGroupId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeDocumentuploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';return this.apiClient.callApi("/api/v2/knowledge/documentuploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentCopies(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentCopies';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentCopies';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentViews(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentViews';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentViews';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsPresentations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsPresentations';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations","POST",{sessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search","POST",{sessionId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsSearchSuggestions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions","POST",{sessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeGuestSessions';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseCategories(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentCopies(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentCopies';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentCopies';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentVariations(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentVersions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentViews(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocuments(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsBulkRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsBulkUpdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsPresentations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsPresentations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search","POST",{knowledgeBaseId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsSearchSuggestions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseExportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseImportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLabels(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageCategories(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocumentUploads(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads","POST",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocumentsImports(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageTrainingPromote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';if(void 0===t||null===t)throw'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote","POST",{knowledgeBaseId:e,languageCode:i,trainingId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageTrainings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseParseJobImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import","POST",{knowledgeBaseId:e,parseJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseParseJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseUploadsUrlsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebases(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class B{constructor(e){this.apiClient=e||d.instance}deleteLanguageunderstandingDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingDomainFeedbackFeedbackId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomainFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "feedbackId" when calling deleteLanguageunderstandingDomainFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}","DELETE",{domainId:e,feedbackId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingDomainVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling deleteLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","DELETE",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingMiner(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling deleteLanguageunderstandingMiner';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}","DELETE",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingMinerDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling deleteLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling deleteLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","DELETE",{minerId:e,draftId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainFeedback(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainFeedback';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback","GET",{domainId:e},{intentName:i.intentName,assessment:i.assessment,dateStart:i.dateStart,dateEnd:i.dateEnd,includeDeleted:i.includeDeleted,language:i.language,pageNumber:i.pageNumber,pageSize:i.pageSize,enableCursorPagination:i.enableCursorPagination,includeTrainingUtterances:i.includeTrainingUtterances,after:i.after,fields:this.apiClient.buildCollectionParam(i.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainFeedbackFeedbackId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "feedbackId" when calling getLanguageunderstandingDomainFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}","GET",{domainId:e,feedbackId:i},{fields:this.apiClient.buildCollectionParam(t.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling getLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","GET",{domainId:e,domainVersionId:i},{includeUtterances:t.includeUtterances},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersionReport(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersionReport';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling getLanguageunderstandingDomainVersionReport';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report","GET",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersions';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions","GET",{domainId:e},{includeUtterances:i.includeUtterances,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/languageunderstanding/domains","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMiner(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMiner';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerDraft(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling getLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","GET",{minerId:e,draftId:i},{draftIntentId:t.draftIntentId,draftTopicId:t.draftTopicId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerDrafts(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDrafts';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerIntent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerIntent';if(void 0===i||null===i)throw'Missing the required parameter "intentId" when calling getLanguageunderstandingMinerIntent';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}","GET",{minerId:e,intentId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerIntents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerIntents';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/intents","GET",{minerId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopic(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopic';if(void 0===i||null===i)throw'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopic';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}","GET",{minerId:e,topicId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopicPhrase(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopicPhrase';if(void 0===i||null===i)throw'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopicPhrase';if(void 0===t||null===t)throw'Missing the required parameter "phraseId" when calling getLanguageunderstandingMinerTopicPhrase';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}","GET",{minerId:e,topicId:i,phraseId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopics(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopics';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMiners(e){return e=e||{},this.apiClient.callApi("/api/v2/languageunderstanding/miners","GET",{},{minerType:e.minerType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingSettings(){return this.apiClient.callApi("/api/v2/languageunderstanding/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLanguageunderstandingDomain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchLanguageunderstandingDomain';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchLanguageunderstandingMinerDraft(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling patchLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling patchLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","PATCH",{minerId:e,draftId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainFeedback(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainFeedback';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainFeedback';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback","POST",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionDetect(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionDetect';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionDetect';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainVersionDetect';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect","POST",{domainId:e,domainVersionId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionPublish(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionPublish';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionPublish';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish","POST",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionTrain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionTrain';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionTrain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train","POST",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainVersions';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions","POST",{domainId:e},{includeUtterances:t.includeUtterances},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomains';return this.apiClient.callApi("/api/v2/languageunderstanding/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerDrafts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerDrafts';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingMinerDrafts';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts","POST",{minerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerExecute(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerExecute';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/execute","POST",{minerId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMiners(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguageunderstandingMiners';return this.apiClient.callApi("/api/v2/languageunderstanding/miners","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putLanguageunderstandingDomainVersion(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling putLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling putLanguageunderstandingDomainVersion';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","PUT",{domainId:e,domainVersionId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class L{constructor(e){this.apiClient=e||d.instance}deleteLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling deleteLanguage';return this.apiClient.callApi("/api/v2/languages/{languageId}","DELETE",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling getLanguage';return this.apiClient.callApi("/api/v2/languages/{languageId}","GET",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguages(e){return e=e||{},this.apiClient.callApi("/api/v2/languages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslations(){return this.apiClient.callApi("/api/v2/languages/translations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsBuiltin(e){if(void 0===e||null===e)throw'Missing the required parameter "language" when calling getLanguagesTranslationsBuiltin';return this.apiClient.callApi("/api/v2/languages/translations/builtin","GET",{},{language:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsOrganization(e){if(void 0===e||null===e)throw'Missing the required parameter "language" when calling getLanguagesTranslationsOrganization';return this.apiClient.callApi("/api/v2/languages/translations/organization","GET",{},{language:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getLanguagesTranslationsUser';return this.apiClient.callApi("/api/v2/languages/translations/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguages';return this.apiClient.callApi("/api/v2/languages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class N{constructor(e){this.apiClient=e||d.instance}deleteLearningAssignment(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling deleteLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","DELETE",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLearningModule(e){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling deleteLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","DELETE",{moduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling getLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","GET",{assignmentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignments(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pageSize:e.pageSize,pageNumber:e.pageNumber,pass:e.pass,minPercentageScore:e.minPercentageScore,maxPercentageScore:e.maxPercentageScore,sortOrder:e.sortOrder,sortBy:e.sortBy,userId:this.apiClient.buildCollectionParam(e.userId,"multi"),types:this.apiClient.buildCollectionParam(e.types,"multi"),states:this.apiClient.buildCollectionParam(e.states,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignmentsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/me","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pageSize:e.pageSize,pageNumber:e.pageNumber,pass:e.pass,minPercentageScore:e.minPercentageScore,maxPercentageScore:e.maxPercentageScore,sortOrder:e.sortOrder,sortBy:e.sortBy,types:this.apiClient.buildCollectionParam(e.types,"multi"),states:this.apiClient.buildCollectionParam(e.states,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","GET",{moduleId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getLearningModuleJob';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/jobs/{jobId}","GET",{moduleId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleRule(e){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleRule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/rule","GET",{moduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getLearningModuleVersion';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/versions/{versionId}","GET",{moduleId:e,versionId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModules(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/modules","GET",{},{isArchived:e.isArchived,types:this.apiClient.buildCollectionParam(e.types,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,sortBy:e.sortBy,searchTerm:e.searchTerm,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),isPublished:e.isPublished,statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),externalIds:this.apiClient.buildCollectionParam(e.externalIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModulesAssignments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userIds" when calling getLearningModulesAssignments';return this.apiClient.callApi("/api/v2/learning/modules/assignments","GET",{},{userIds:this.apiClient.buildCollectionParam(e,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,searchTerm:i.searchTerm,overdue:i.overdue,assignmentStates:this.apiClient.buildCollectionParam(i.assignmentStates,"multi"),expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModulesCoverartCoverArtId(e){if(void 0===e||null===e)throw'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';return this.apiClient.callApi("/api/v2/learning/modules/coverart/{coverArtId}","GET",{coverArtId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningAssignment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling patchLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","PATCH",{assignmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningAssignmentReschedule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reschedule","PATCH",{assignmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningModuleUserAssignments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/users/{userId}/assignments","PATCH",{moduleId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssessmentsScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningAssessmentsScoring';return this.apiClient.callApi("/api/v2/learning/assessments/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentReassign(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reassign","POST",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentReset(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reset","POST",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignments(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningAssignmentsAggregatesQuery';return this.apiClient.callApi("/api/v2/learning/assignments/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsBulkadd(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/bulkadd","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsBulkremove(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/bulkremove","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModuleJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling postLearningModuleJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLearningModuleJobs';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/jobs","POST",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModulePublish(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling postLearningModulePublish';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/publish","POST",{moduleId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningModules';return this.apiClient.callApi("/api/v2/learning/modules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningRulesQuery(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "pageSize" when calling postLearningRulesQuery';if(void 0===i||null===i)throw'Missing the required parameter "pageNumber" when calling postLearningRulesQuery';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postLearningRulesQuery';return this.apiClient.callApi("/api/v2/learning/rules/query","POST",{},{pageSize:e,pageNumber:i},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningScheduleslotsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';return this.apiClient.callApi("/api/v2/learning/scheduleslots/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putLearningModule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling putLearningModule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","PUT",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putLearningModuleRule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling putLearningModuleRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putLearningModuleRule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/rule","PUT",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class K{constructor(e){this.apiClient=e||d.instance}getLicenseDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "licenseId" when calling getLicenseDefinition';return this.apiClient.callApi("/api/v2/license/definitions/{licenseId}","GET",{licenseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseDefinitions(){return this.apiClient.callApi("/api/v2/license/definitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseToggle(e){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling getLicenseToggle';return this.apiClient.callApi("/api/v2/license/toggles/{featureName}","GET",{featureName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getLicenseUser';return this.apiClient.callApi("/api/v2/license/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/license/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseInfer(e){return e=e||{},this.apiClient.callApi("/api/v2/license/infer","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseOrganization(e){return e=e||{},this.apiClient.callApi("/api/v2/license/organization","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseToggle(e){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling postLicenseToggle';return this.apiClient.callApi("/api/v2/license/toggles/{featureName}","POST",{featureName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/license/users","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class J{constructor(e){this.apiClient=e||d.instance}deleteLocation(e){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling deleteLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","DELETE",{locationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocation(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "locationId" when calling getLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","GET",{locationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationSublocations(e){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling getLocationSublocations';return this.apiClient.callApi("/api/v2/locations/{locationId}/sublocations","GET",{locationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocations(e){return e=e||{},this.apiClient.callApi("/api/v2/locations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling patchLocation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","PATCH",{locationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLocations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocations';return this.apiClient.callApi("/api/v2/locations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLocationsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class V{constructor(e){this.apiClient=e||d.instance}deleteDiagnosticsLogcaptureBrowserUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserEntriesDownloadJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users","GET",{},{includeExpired:e.includeExpired},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/download/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserEntriesQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/query","POST",{},{before:e.before,after:e.after,pageSize:e.pageSize},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","POST",{userId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class F{constructor(e){this.apiClient=e||d.instance}deleteMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","DELETE",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/messaging/settings/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","DELETE",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling getMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","GET",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/messaging/settings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/messaging/settings/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSupportedcontent(e){return e=e||{},this.apiClient.callApi("/api/v2/messaging/supportedcontent","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","GET",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchMessagingSetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","PATCH",{messageSettingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchMessagingSupportedcontentSupportedContentId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","PATCH",{supportedContentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postMessagingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMessagingSettings';return this.apiClient.callApi("/api/v2/messaging/settings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postMessagingSupportedcontent(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMessagingSupportedcontent';return this.apiClient.callApi("/api/v2/messaging/supportedcontent","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putMessagingSettingsDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';return this.apiClient.callApi("/api/v2/messaging/settings/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Q{constructor(e){this.apiClient=e||d.instance}deleteMobiledevice(e){if(void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling deleteMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","DELETE",{deviceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMobiledevice(e){if(void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling getMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","GET",{deviceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMobiledevices(e){return e=e||{},this.apiClient.callApi("/api/v2/mobiledevices","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postMobiledevices(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMobiledevices';return this.apiClient.callApi("/api/v2/mobiledevices","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putMobiledevice(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling putMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","PUT",{deviceId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class _{constructor(e){this.apiClient=e||d.instance}deleteNotificationsChannelSubscriptions(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling deleteNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","DELETE",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsAvailabletopics(e){return e=e||{},this.apiClient.callApi("/api/v2/notifications/availabletopics","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),includePreview:e.includePreview},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsChannelSubscriptions(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling getNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","GET",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsChannels(e){return e=e||{},this.apiClient.callApi("/api/v2/notifications/channels","GET",{},{includechannels:e.includechannels},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}headNotificationsChannel(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling headNotificationsChannel';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}","HEAD",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postNotificationsChannelSubscriptions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "channelId" when calling postNotificationsChannelSubscriptions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","POST",{channelId:e},{ignoreErrors:t.ignoreErrors},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postNotificationsChannels(){return this.apiClient.callApi("/api/v2/notifications/channels","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putNotificationsChannelSubscriptions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "channelId" when calling putNotificationsChannelSubscriptions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","PUT",{channelId:e},{ignoreErrors:t.ignoreErrors},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class H{constructor(e){this.apiClient=e||d.instance}deleteOauthClient(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling deleteOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","DELETE",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthAuthorization(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthAuthorization';return this.apiClient.callApi("/api/v2/oauth/authorizations/{clientId}","GET",{clientId:e},{},{"Accept-Language":i.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthAuthorizations(e){return e=e||{},this.apiClient.callApi("/api/v2/oauth/authorizations","GET",{},{},{"Accept-Language":e.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClient(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","GET",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageQueryResult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getOauthClientUsageQueryResult';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}","GET",{executionId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageSummary(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClientUsageSummary';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/summary","GET",{clientId:e},{days:i.days},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClients(){return this.apiClient.callApi("/api/v2/oauth/clients","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthScope(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scopeId" when calling getOauthScope';return this.apiClient.callApi("/api/v2/oauth/scopes/{scopeId}","GET",{scopeId:e},{},{"Accept-Language":i.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthScopes(e){return e=e||{},this.apiClient.callApi("/api/v2/oauth/scopes","GET",{},{},{"Accept-Language":e.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientSecret(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientSecret';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/secret","POST",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientUsageQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOauthClientUsageQuery';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query","POST",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClients(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOauthClients';return this.apiClient.callApi("/api/v2/oauth/clients","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOauthClient(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling putOauthClient';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","PUT",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ${constructor(e){this.apiClient=e||d.instance}deleteAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","DELETE",{divisionId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","GET",{divisionId:e},{objectCount:i.objectCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/divisions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,objectCount:e.objectCount,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsHome(){return this.apiClient.callApi("/api/v2/authorization/divisions/home","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsLimit(){return this.apiClient.callApi("/api/v2/authorization/divisions/limit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionObject(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionObject';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling postAuthorizationDivisionObject';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationDivisionObject';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/objects/{objectType}","POST",{divisionId:e,objectType:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionRestore(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/restore","POST",{divisionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationDivisions';return this.apiClient.callApi("/api/v2/authorization/divisions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationDivision(e,i){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","PUT",{divisionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Z{constructor(e){this.apiClient=e||d.instance}getUsageEventsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';return this.apiClient.callApi("/api/v2/usage/events/definitions/{eventDefinitionId}","GET",{eventDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageEventsDefinitions(){return this.apiClient.callApi("/api/v2/usage/events/definitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class X{constructor(e){this.apiClient=e||d.instance}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsAuthenticationSettings(){return this.apiClient.callApi("/api/v2/organizations/authentication/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsEmbeddedintegration(){return this.apiClient.callApi("/api/v2/organizations/embeddedintegration","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsIpaddressauthentication(){return this.apiClient.callApi("/api/v2/organizations/ipaddressauthentication","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsChangerequest(e){if(void 0===e||null===e)throw'Missing the required parameter "requestId" when calling getOrganizationsLimitsChangerequest';return this.apiClient.callApi("/api/v2/organizations/limits/changerequests/{requestId}","GET",{requestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsChangerequests(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/limits/changerequests","GET",{},{after:e.after,before:e.before,status:e.status,pageSize:e.pageSize,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsDocs(){return this.apiClient.callApi("/api/v2/organizations/limits/docs","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsDocsFreetrial(){return this.apiClient.callApi("/api/v2/organizations/limits/docs/freetrial","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespace(e){if(void 0===e||null===e)throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespace';return this.apiClient.callApi("/api/v2/organizations/limits/namespaces/{namespaceName}","GET",{namespaceName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespaceDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceDefaults';return this.apiClient.callApi("/api/v2/organizations/limits/namespaces/{namespaceName}/defaults","GET",{namespaceName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespaces(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/limits/namespaces","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsMe(){return this.apiClient.callApi("/api/v2/organizations/me","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsWhitelist(){return this.apiClient.callApi("/api/v2/organizations/whitelist","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchOrganizationsAuthenticationSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';return this.apiClient.callApi("/api/v2/organizations/authentication/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchOrganizationsFeature(e,i){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling patchOrganizationsFeature';if(void 0===i||null===i)throw'Missing the required parameter "enabled" when calling patchOrganizationsFeature';return this.apiClient.callApi("/api/v2/organizations/features/{featureName}","PATCH",{featureName:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsEmbeddedintegration(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsEmbeddedintegration';return this.apiClient.callApi("/api/v2/organizations/embeddedintegration","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsIpaddressauthentication(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsIpaddressauthentication';return this.apiClient.callApi("/api/v2/organizations/ipaddressauthentication","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/me","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsWhitelist(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';return this.apiClient.callApi("/api/v2/organizations/whitelist","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Y{constructor(e){this.apiClient=e||d.instance}deleteOrgauthorizationTrustee(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","DELETE",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroup';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}","DELETE",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeGroupRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","DELETE",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustees(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOrgauthorizationTrustees';return this.apiClient.callApi("/api/v2/orgauthorization/trustees","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustor';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}","DELETE",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","DELETE",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling deleteOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","DELETE",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","DELETE",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustors(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOrgauthorizationTrustors';return this.apiClient.callApi("/api/v2/orgauthorization/trustors","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationPairing(e){if(void 0===e||null===e)throw'Missing the required parameter "pairingId" when calling getOrgauthorizationPairing';return this.apiClient.callApi("/api/v2/orgauthorization/pairings/{pairingId}","GET",{pairingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustee(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","GET",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeClonedusers(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers","GET",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroup';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}","GET",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroupRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","GET",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups","GET",{trusteeOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrusteeUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}","GET",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","GET",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users","GET",{trusteeOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustees(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustees","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi("/api/v2/orgauthorization/trustees/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustor';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}","GET",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","GET",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorClonedusers(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers","GET",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling getOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","GET",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups","GET",{trustorOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","GET",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users","GET",{trustorOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustors(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustors","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationPairings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationPairings';return this.apiClient.callApi("/api/v2/orgauthorization/pairings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteeGroups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeGroups';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteeGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups","POST",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteeUsers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteeUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users","POST",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrustees(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrustees';return this.apiClient.callApi("/api/v2/orgauthorization/trustees","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteesAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteesAudits';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteesDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustees/default","POST",{},{assignDefaultRole:e.assignDefaultRole,autoExpire:e.autoExpire},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrustorAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrustorAudits';return this.apiClient.callApi("/api/v2/orgauthorization/trustor/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustee(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrustee';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","PUT",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeGroupRoledivisions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoledivisions';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoledivisions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoledivisions';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions","PUT",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeGroupRoles(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoles';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","PUT",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeUserRoledivisions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeUserRoledivisions';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrusteeUserRoledivisions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeUserRoledivisions';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions","PUT",{trusteeOrgId:e,trusteeUserId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeUserRoles(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrusteeUserRoles';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","PUT",{trusteeOrgId:e,trusteeUserId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","PUT",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling putOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","PUT",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","PUT",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class ee{constructor(e){this.apiClient=e||d.instance}deleteOutboundAttemptlimit(e){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling deleteOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","DELETE",{attemptLimitsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCallabletimeset(e){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling deleteOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","DELETE",{callableTimeSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCallanalysisresponseset(e){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling deleteOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","DELETE",{callAnalysisSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundCampaignProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/progress","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaignrule(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling deleteOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","DELETE",{campaignRuleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlist(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","DELETE",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling deleteOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","DELETE",{contactListId:e,contactId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistContacts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContacts';if(void 0===i||null===i)throw'Missing the required parameter "contactIds" when calling deleteOutboundContactlistContacts';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts","DELETE",{contactListId:e},{contactIds:this.apiClient.buildCollectionParam(i,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistfilter(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling deleteOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","DELETE",{contactListFilterId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlists(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundContactlists';return this.apiClient.callApi("/api/v2/outbound/contactlists","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlisttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","DELETE",{contactListTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlisttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDigitalruleset(e){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","DELETE",{digitalRuleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclist(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","DELETE",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistCustomexclusioncolumns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistCustomexclusioncolumns';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistEmailaddresses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistPhonenumbers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundFilespecificationtemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","DELETE",{fileSpecificationTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundFilespecificationtemplatesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/bulk","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundImporttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","DELETE",{importTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundImporttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundImporttemplates';return this.apiClient.callApi("/api/v2/outbound/importtemplates","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundMessagingcampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundRuleset(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling deleteOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","DELETE",{ruleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesEmailcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","DELETE",{emailCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling deleteOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","DELETE",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling deleteOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","DELETE",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundAttemptlimit(e){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling getOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","GET",{attemptLimitsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundAttemptlimits(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/attemptlimits","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallabletimeset(e){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling getOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","GET",{callableTimeSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallabletimesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/callabletimesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallanalysisresponseset(e){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling getOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","GET",{callAnalysisSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallanalysisresponsesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignAgentownedmappingpreviewResults(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignAgentownedmappingpreviewResults';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignDiagnostics(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignDiagnostics';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/diagnostics","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignInteractions(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignInteractions';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/interactions","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignLinedistribution(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignLinedistribution';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/linedistribution","GET",{campaignId:e},{includeOnlyActiveCampaigns:i.includeOnlyActiveCampaigns,edgeGroupId:i.edgeGroupId,siteId:i.siteId,useWeight:i.useWeight,relativeWeight:i.relativeWeight,outboundLineCount:i.outboundLineCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/progress","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignStats(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignStats';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/stats","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignrule(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling getOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","GET",{campaignRuleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignrules(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaignrules","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaigns(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),contactListId:e.contactListId,dncListIds:e.dncListIds,distributionQueueId:e.distributionQueueId,edgeGroupId:e.edgeGroupId,callAnalysisResponseSetId:e.callAnalysisResponseSetId,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsAll(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/all","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),mediaType:this.apiClient.buildCollectionParam(e.mediaType,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsAllDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/all/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),mediaType:this.apiClient.buildCollectionParam(e.mediaType,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignsDivisionview';return this.apiClient.callApi("/api/v2/outbound/campaigns/divisionviews/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlist(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","GET",{contactListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling getOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","GET",{contactListId:e,contactId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistExport';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/export","GET",{contactListId:e},{download:i.download},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistImportstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistImportstatus';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/importstatus","GET",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistTimezonemappingpreview(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistTimezonemappingpreview';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview","GET",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistfilter(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling getOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","GET",{contactListFilterId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistfilters(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlistfilters","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder,contactListId:e.contactListId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlists(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlists","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistsDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistsDivisionview';return this.apiClient.callApi("/api/v2/outbound/contactlists/divisionviews/{contactListId}","GET",{contactListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlists/divisionviews","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlisttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","GET",{contactListTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlisttemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDigitalruleset(e){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","GET",{digitalRuleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDigitalrulesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/digitalrulesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclist(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","GET",{dncListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistExport';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/export","GET",{dncListId:e},{download:i.download},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistImportstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistImportstatus';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/importstatus","GET",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclists(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/dnclists","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,dncSourceType:e.dncSourceType,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistsDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistsDivisionview';return this.apiClient.callApi("/api/v2/outbound/dnclists/divisionviews/{dncListId}","GET",{dncListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/dnclists/divisionviews","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,dncSourceType:e.dncSourceType,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundEvent(e){if(void 0===e||null===e)throw'Missing the required parameter "eventId" when calling getOutboundEvent';return this.apiClient.callApi("/api/v2/outbound/events/{eventId}","GET",{eventId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundEvents(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/events","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,category:e.category,level:e.level,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundFilespecificationtemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","GET",{fileSpecificationTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundFilespecificationtemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","GET",{importTemplateId:e},{includeImportStatus:i.includeImportStatus},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplateImportstatus(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}/importstatus","GET",{importTemplateId:e},{listNamePrefix:i.listNamePrefix},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/importtemplates","GET",{},{includeImportStatus:e.includeImportStatus,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder,contactListTemplateId:e.contactListTemplateId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignDiagnostics(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaigns(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/messagingcampaigns","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,contactListId:e.contactListId,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),type:e.type,senderSmsPhoneNumber:e.senderSmsPhoneNumber,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignsDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignsDivisionview';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name,type:e.type,id:this.apiClient.buildCollectionParam(e.id,"multi"),senderSmsPhoneNumber:e.senderSmsPhoneNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundRuleset(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling getOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","GET",{ruleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundRulesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/rulesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesCampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesEmailcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","GET",{emailCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesEmailcampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesMessagingcampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling getOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","GET",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesSequences(){return this.apiClient.callApi("/api/v2/outbound/schedules/sequences","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling getOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","GET",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSequences(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/sequences","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSettings(){return this.apiClient.callApi("/api/v2/outbound/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundWrapupcodemappings(){return this.apiClient.callApi("/api/v2/outbound/wrapupcodemappings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistCustomexclusioncolumns(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistCustomexclusioncolumns';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistCustomexclusioncolumns';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistEmailaddresses(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistEmailaddresses';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistPhonenumbers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchOutboundSettings';return this.apiClient.callApi("/api/v2/outbound/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundAttemptlimits(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundAttemptlimits';return this.apiClient.callApi("/api/v2/outbound/attemptlimits","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundAudits';return this.apiClient.callApi("/api/v2/outbound/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder,facetsOnly:i.facetsOnly},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCallabletimesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCallabletimesets';return this.apiClient.callApi("/api/v2/outbound/callabletimesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCallanalysisresponsesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCallanalysisresponsesets';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignAgentownedmappingpreview(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling postOutboundCampaignAgentownedmappingpreview';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview","POST",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignCallbackSchedule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundCampaignCallbackSchedule';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/callback/schedule","POST",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignrules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaignrules';return this.apiClient.callApi("/api/v2/outbound/campaignrules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaigns(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaigns';return this.apiClient.callApi("/api/v2/outbound/campaigns","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignsProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaignsProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/progress","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistClear(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistClear';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/clear","POST",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContacts(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContacts';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContacts';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts","POST",{contactListId:e},{priority:t.priority,clearSystemData:t.clearSystemData,doNotQueue:t.doNotQueue},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulk';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulkRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkRemove';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulkUpdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkUpdate';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsSearch(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsSearch';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/search","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistExport';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/export","POST",{contactListId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfilters(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfilters';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfiltersBulkRetrieve(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfiltersBulkRetrieve';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/bulk/retrieve","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfiltersPreview(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfiltersPreview';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/preview","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlists(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlists';return this.apiClient.callApi("/api/v2/outbound/contactlists","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplates';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplatesBulkAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/bulk/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplatesBulkRetrieve(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/bulk/retrieve","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundConversationDnc(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postOutboundConversationDnc';return this.apiClient.callApi("/api/v2/outbound/conversations/{conversationId}/dnc","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDigitalrulesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundDigitalrulesets';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistEmailaddresses(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","POST",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistExport(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistExport';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/export","POST",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistPhonenumbers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","POST",{dncListId:e},{expirationDateTime:t.expirationDateTime},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclists(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundDnclists';return this.apiClient.callApi("/api/v2/outbound/dnclists","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundFilespecificationtemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundImporttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundImporttemplates';return this.apiClient.callApi("/api/v2/outbound/importtemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundImporttemplatesBulkAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';return this.apiClient.callApi("/api/v2/outbound/importtemplates/bulk/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundMessagingcampaigns(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundMessagingcampaigns';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundMessagingcampaignsProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundMessagingcampaignsProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/progress","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundRulesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundRulesets';return this.apiClient.callApi("/api/v2/outbound/rulesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundSequences(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundSequences';return this.apiClient.callApi("/api/v2/outbound/sequences","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundAttemptlimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling putOutboundAttemptlimit';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","PUT",{attemptLimitsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCallabletimeset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling putOutboundCallabletimeset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","PUT",{callableTimeSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCallanalysisresponseset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling putOutboundCallanalysisresponseset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","PUT",{callAnalysisSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundCampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","PUT",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaignAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundCampaignAgent';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling putOutboundCampaignAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOutboundCampaignAgent';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agents/{userId}","PUT",{campaignId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaignrule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling putOutboundCampaignrule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","PUT",{campaignRuleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlist(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling putOutboundContactlist';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","PUT",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlistContact(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling putOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling putOutboundContactlistContact';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","PUT",{contactListId:e,contactId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlistfilter(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","PUT",{contactListFilterId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlisttemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","PUT",{contactListTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundDigitalruleset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","PUT",{digitalRuleSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundDnclist(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","PUT",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundFilespecificationtemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","PUT",{fileSpecificationTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundImporttemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","PUT",{importTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundMessagingcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling putOutboundMessagingcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","PUT",{messagingCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundRuleset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling putOutboundRuleset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","PUT",{ruleSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesCampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundSchedulesCampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","PUT",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesEmailcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","PUT",{emailCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesMessagingcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","PUT",{messagingCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesSequence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling putOutboundSchedulesSequence';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","PUT",{sequenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSequence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling putOutboundSequence';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","PUT",{sequenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundWrapupcodemappings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';return this.apiClient.callApi("/api/v2/outbound/wrapupcodemappings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class ie{constructor(e){this.apiClient=e||d.instance}deletePresenceDefinition0(e){if(void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","DELETE",{definitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deletePresenceSource(e){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling deletePresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","DELETE",{sourceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deletePresencedefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling deletePresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","DELETE",{presenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceDefinition0(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling getPresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","GET",{definitionId:e},{localeCode:i.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceDefinitions0(e){return e=e||{},this.apiClient.callApi("/api/v2/presence/definitions","GET",{},{deactivated:e.deactivated,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),localeCode:e.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSettings(){return this.apiClient.callApi("/api/v2/presence/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSource(e){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling getPresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","GET",{sourceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSources(e){return e=e||{},this.apiClient.callApi("/api/v2/presence/sources","GET",{},{deactivated:e.deactivated},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceUserPrimarysource(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';return this.apiClient.callApi("/api/v2/presence/users/{userId}/primarysource","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresencedefinition(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling getPresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","GET",{presenceId:e},{localeCode:i.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresencedefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/presencedefinitions","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,deleted:e.deleted,localeCode:e.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSystempresences(){return this.apiClient.callApi("/api/v2/systempresences","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserPresence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserPresence';if(void 0===i||null===i)throw'Missing the required parameter "sourceId" when calling getUserPresence';return this.apiClient.callApi("/api/v2/users/{userId}/presences/{sourceId}","GET",{userId:e,sourceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserPresencesPurecloud(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserPresencesPurecloud';return this.apiClient.callApi("/api/v2/users/{userId}/presences/purecloud","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersPresenceBulk(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';return this.apiClient.callApi("/api/v2/users/presences/{sourceId}/bulk","GET",{sourceId:e},{id:this.apiClient.buildCollectionParam(i.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersPresencesPurecloudBulk(e){return e=e||{},this.apiClient.callApi("/api/v2/users/presences/purecloud/bulk","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserPresence(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserPresence';if(void 0===i||null===i)throw'Missing the required parameter "sourceId" when calling patchUserPresence';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserPresence';return this.apiClient.callApi("/api/v2/users/{userId}/presences/{sourceId}","PATCH",{userId:e,sourceId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserPresencesPurecloud(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserPresencesPurecloud';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserPresencesPurecloud';return this.apiClient.callApi("/api/v2/users/{userId}/presences/purecloud","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postPresenceDefinitions0(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresenceDefinitions0';return this.apiClient.callApi("/api/v2/presence/definitions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postPresenceSources(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresenceSources';return this.apiClient.callApi("/api/v2/presence/sources","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postPresencedefinitions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresencedefinitions';return this.apiClient.callApi("/api/v2/presencedefinitions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceDefinition0(e,i){if(void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","PUT",{definitionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putPresenceSettings';return this.apiClient.callApi("/api/v2/presence/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceSource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling putPresenceSource';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","PUT",{sourceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceUserPrimarysource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceUserPrimarysource';return this.apiClient.callApi("/api/v2/presence/users/{userId}/primarysource","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresencedefinition(e,i){if(void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling putPresencedefinition';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","PUT",{presenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUsersPresencesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putUsersPresencesBulk';return this.apiClient.callApi("/api/v2/users/presences/bulk","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class te{constructor(e){this.apiClient=e||d.instance}deleteProcessautomationTrigger(e){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","DELETE",{triggerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTrigger(e){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","GET",{triggerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTriggers(e){return e=e||{},this.apiClient.callApi("/api/v2/processautomation/triggers","GET",{},{before:e.before,after:e.after,pageSize:e.pageSize,topicName:e.topicName,enabled:e.enabled,hasDelayBy:e.hasDelayBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTriggersTopics(e){return e=e||{},this.apiClient.callApi("/api/v2/processautomation/triggers/topics","GET",{},{before:e.before,after:e.after,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggerTest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}/test","POST",{triggerId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postProcessautomationTriggers';return this.apiClient.callApi("/api/v2/processautomation/triggers","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggersTopicTest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';return this.apiClient.callApi("/api/v2/processautomation/triggers/topics/{topicName}/test","POST",{topicName:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putProcessautomationTrigger(e,i){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","PUT",{triggerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ne{constructor(e){this.apiClient=e||d.instance}deleteQualityCalibration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling deleteQualityCalibration';if(void 0===i||null===i)throw'Missing the required parameter "calibratorId" when calling deleteQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","DELETE",{calibrationId:e},{calibratorId:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityConversationEvaluation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling deleteQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","DELETE",{conversationId:e,evaluationId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityForm(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityFormsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityFormsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityAgentsActivity(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/agents/activity","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,startTime:e.startTime,endTime:e.endTime,agentUserId:this.apiClient.buildCollectionParam(e.agentUserId,"multi"),evaluatorUserId:e.evaluatorUserId,name:e.name,group:e.group,agentTeamId:e.agentTeamId,formContextId:e.formContextId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityCalibration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling getQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","GET",{calibrationId:e},{calibratorId:i.calibratorId,conversationId:i.conversationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityCalibrations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "calibratorId" when calling getQualityCalibrations';return this.apiClient.callApi("/api/v2/quality/calibrations","GET",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage,conversationId:i.conversationId,startTime:i.startTime,endTime:i.endTime,calibratorId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationEvaluation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling getQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","GET",{conversationId:e,evaluationId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getQualityConversationSurveys';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/surveys","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationsAuditsQueryTransactionId(e){if(void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getQualityConversationsAuditsQueryTransactionId';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query/{transactionId}","GET",{transactionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationsAuditsQueryTransactionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getQualityConversationsAuditsQueryTransactionIdResults';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query/{transactionId}/results","GET",{transactionId:e},{cursor:i.cursor,pageSize:i.pageSize,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityEvaluationsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/evaluations/query","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,conversationId:e.conversationId,agentUserId:e.agentUserId,agentTeamId:e.agentTeamId,evaluatorUserId:e.evaluatorUserId,assigneeUserId:e.assigneeUserId,queueId:e.queueId,startTime:e.startTime,endTime:e.endTime,formContextId:e.formContextId,evaluationState:this.apiClient.buildCollectionParam(e.evaluationState,"multi"),isReleased:e.isReleased,agentHasRead:e.agentHasRead,expandAnswerTotalScores:e.expandAnswerTotalScores,maximum:e.maximum,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityEvaluatorsActivity(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/evaluators/activity","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,startTime:e.startTime,endTime:e.endTime,name:e.name,permission:this.apiClient.buildCollectionParam(e.permission,"multi"),group:e.group,agentTeamId:e.agentTeamId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityForm(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormVersions';return this.apiClient.callApi("/api/v2/quality/forms/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityForms(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluationVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsEvaluationVersions';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluations(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms/evaluations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluationsBulkContexts(e){if(void 0===e||null===e)throw'Missing the required parameter "contextId" when calling getQualityFormsEvaluationsBulkContexts';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/bulk/contexts","GET",{},{contextId:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveyVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsSurveyVersions';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveys(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms/surveys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveysBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling getQualityFormsSurveysBulk';return this.apiClient.callApi("/api/v2/quality/forms/surveys/bulk","GET",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveysBulkContexts(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contextId" when calling getQualityFormsSurveysBulkContexts';return this.apiClient.callApi("/api/v2/quality/forms/surveys/bulk/contexts","GET",{},{contextId:this.apiClient.buildCollectionParam(e,"multi"),published:i.published},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedform(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedform';return this.apiClient.callApi("/api/v2/quality/publishedforms/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedforms(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestPerContext:e.onlyLatestPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedformsEvaluation';return this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsEvaluations(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestPerContext:e.onlyLatestPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedformsSurvey';return this.apiClient.callApi("/api/v2/quality/publishedforms/surveys/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsSurveys(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms/surveys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestEnabledPerContext:e.onlyLatestEnabledPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualitySurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "surveyId" when calling getQualitySurvey';return this.apiClient.callApi("/api/v2/quality/surveys/{surveyId}","GET",{surveyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualitySurveysScorable(e){if(void 0===e||null===e)throw'Missing the required parameter "customerSurveyUrl" when calling getQualitySurveysScorable';return this.apiClient.callApi("/api/v2/quality/surveys/scorable","GET",{},{customerSurveyUrl:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchQualityFormsSurvey(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling patchQualityFormsSurvey';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","PATCH",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityCalibrations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityCalibrations';return this.apiClient.callApi("/api/v2/quality/calibrations","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityConversationEvaluations(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postQualityConversationEvaluations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postQualityConversationEvaluations';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations","POST",{conversationId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityConversationsAuditsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityConversationsAuditsQuery';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityEvaluationsAggregatesQueryMe(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityEvaluationsAggregatesQueryMe';return this.apiClient.callApi("/api/v2/quality/evaluations/aggregates/query/me","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityEvaluationsScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityEvaluationsScoring';return this.apiClient.callApi("/api/v2/quality/evaluations/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityForms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityForms';return this.apiClient.callApi("/api/v2/quality/forms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityFormsEvaluations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityFormsEvaluations';return this.apiClient.callApi("/api/v2/quality/forms/evaluations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityFormsSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityFormsSurveys';return this.apiClient.callApi("/api/v2/quality/forms/surveys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedforms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedforms';return this.apiClient.callApi("/api/v2/quality/publishedforms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedformsEvaluations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedformsEvaluations';return this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedformsSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedformsSurveys';return this.apiClient.callApi("/api/v2/quality/publishedforms/surveys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualitySurveysScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualitySurveysScoring';return this.apiClient.callApi("/api/v2/quality/surveys/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityCalibration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling putQualityCalibration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","PUT",{calibrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityConversationEvaluation(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling putQualityConversationEvaluation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","PUT",{conversationId:e,evaluationId:i},{expand:n.expand},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityForm(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityForm';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityFormsEvaluation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityFormsSurvey(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityFormsSurvey';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualitySurveysScorable(e,i){if(void 0===e||null===e)throw'Missing the required parameter "customerSurveyUrl" when calling putQualitySurveysScorable';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualitySurveysScorable';return this.apiClient.callApi("/api/v2/quality/surveys/scorable","PUT",{},{customerSurveyUrl:e},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ae{constructor(e){this.apiClient=e||d.instance}deleteConversationRecordingAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling deleteConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling deleteConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","DELETE",{conversationId:e,recordingId:i,annotationId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrphanrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling deleteOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","DELETE",{orphanId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingCrossplatformMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "ids" when calling deleteRecordingCrossplatformMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","DELETE",{},{ids:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingCrossplatformMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling deleteRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","DELETE",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "ids" when calling deleteRecordingMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","DELETE",{},{ids:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling deleteRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","DELETE",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecording(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecording';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecording';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}","GET",{conversationId:e,recordingId:i},{formatId:t.formatId,emailFormatId:t.emailFormatId,chatFormatId:t.chatFormatId,messageFormatId:t.messageFormatId,download:t.download,fileName:t.fileName,locale:t.locale,mediaFormats:this.apiClient.buildCollectionParam(t.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling getConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","GET",{conversationId:e,recordingId:i,annotationId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingAnnotations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingAnnotations';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations","GET",{conversationId:e,recordingId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingmetadata(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingmetadata';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordingmetadata","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingmetadataRecordingId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingmetadataRecordingId';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingmetadataRecordingId';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}","GET",{conversationId:e,recordingId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordings';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings","GET",{conversationId:e},{maxWaitMs:i.maxWaitMs,formatId:i.formatId,mediaFormats:this.apiClient.buildCollectionParam(i.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling getOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","GET",{orphanId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecordingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling getOrphanrecordingMedia';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}/media","GET",{orphanId:e},{formatId:i.formatId,emailFormatId:i.emailFormatId,chatFormatId:i.chatFormatId,messageFormatId:i.messageFormatId,download:i.download,fileName:i.fileName,locale:i.locale,mediaFormats:this.apiClient.buildCollectionParam(i.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecordings(e){return e=e||{},this.apiClient.callApi("/api/v2/orphanrecordings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,hasConversation:e.hasConversation,media:e.media},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingBatchrequest(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingBatchrequest';return this.apiClient.callApi("/api/v2/recording/batchrequests/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingCrossplatformMediaretentionpolicies(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,enabled:e.enabled,summary:e.summary,hasErrors:e.hasErrors,deleteDaysThreshold:e.deleteDaysThreshold},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingCrossplatformMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","GET",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJobFailedrecordings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}/failedrecordings","GET",{jobId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,includeTotal:i.includeTotal,cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/jobs","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,state:e.state,showOnlyMyJobs:e.showOnlyMyJobs,jobType:e.jobType,includeTotal:e.includeTotal,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingKeyconfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/{keyConfigurationId}","GET",{keyConfigurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingKeyconfigurations(){return this.apiClient.callApi("/api/v2/recording/keyconfigurations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingMediaretentionpolicies(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,enabled:e.enabled,summary:e.summary,hasErrors:e.hasErrors,deleteDaysThreshold:e.deleteDaysThreshold},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","GET",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingRecordingkeys(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/recordingkeys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingRecordingkeysRotationschedule(){return this.apiClient.callApi("/api/v2/recording/recordingkeys/rotationschedule","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/settings","GET",{},{createDefault:e.createDefault},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingUploadsReport(e){if(void 0===e||null===e)throw'Missing the required parameter "reportId" when calling getRecordingUploadsReport';return this.apiClient.callApi("/api/v2/recording/uploads/reports/{reportId}","GET",{reportId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsRetentionQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';return this.apiClient.callApi("/api/v2/recordings/retention/query","GET",{},{retentionThresholdDays:e,cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsScreensessions(e){return e=e||{},this.apiClient.callApi("/api/v2/recordings/screensessions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsScreensessionsDetails(){return this.apiClient.callApi("/api/v2/recordings/screensessions/details","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingCrossplatformMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling patchRecordingCrossplatformMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","PATCH",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling patchRecordingMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","PATCH",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingsScreensession(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';return this.apiClient.callApi("/api/v2/recordings/screensessions/{recordingSessionId}","PATCH",{recordingSessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationRecordingAnnotations(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationRecordingAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling postConversationRecordingAnnotations';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationRecordingAnnotations';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations","POST",{conversationId:e,recordingId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingBatchrequests(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingBatchrequests';return this.apiClient.callApi("/api/v2/recording/batchrequests","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingCrossplatformMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingCrossplatformMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingJobs';return this.apiClient.callApi("/api/v2/recording/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingKeyconfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingKeyconfigurations';return this.apiClient.callApi("/api/v2/recording/keyconfigurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingKeyconfigurationsValidate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/validate","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingLocalkeys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingLocalkeys';return this.apiClient.callApi("/api/v2/recording/localkeys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingRecordingkeys(){return this.apiClient.callApi("/api/v2/recording/recordingkeys","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingUploadsReports(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingUploadsReports';return this.apiClient.callApi("/api/v2/recording/uploads/reports","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsDeletionprotection(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsDeletionprotection';return this.apiClient.callApi("/api/v2/recordings/deletionprotection","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsScreensessionsAcknowledge(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsScreensessionsAcknowledge';return this.apiClient.callApi("/api/v2/recordings/screensessions/acknowledge","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsScreensessionsMetadata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsScreensessionsMetadata';return this.apiClient.callApi("/api/v2/recordings/screensessions/metadata","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationRecording(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationRecording';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling putConversationRecording';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putConversationRecording';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}","PUT",{conversationId:e,recordingId:i},{clearExport:n.clearExport},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationRecordingAnnotation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling putConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling putConversationRecordingAnnotation';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling putConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","PUT",{conversationId:e,recordingId:i,annotationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}putOrphanrecording(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling putOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","PUT",{orphanId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingCrossplatformMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling putRecordingCrossplatformMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","PUT",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling putRecordingJob';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","PUT",{jobId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingKeyconfiguration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingKeyconfiguration';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/{keyConfigurationId}","PUT",{keyConfigurationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling putRecordingMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","PUT",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingRecordingkeysRotationschedule(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRecordingRecordingkeysRotationschedule';return this.apiClient.callApi("/api/v2/recording/recordingkeys/rotationschedule","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRecordingSettings';return this.apiClient.callApi("/api/v2/recording/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingsDeletionprotection(e){return e=e||{},this.apiClient.callApi("/api/v2/recordings/deletionprotection","PUT",{},{protect:e.protect},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class oe{constructor(e){this.apiClient=e||d.instance}deleteResponsemanagementLibrary(e){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling deleteResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","DELETE",{libraryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteResponsemanagementResponse(e){if(void 0===e||null===e)throw'Missing the required parameter "responseId" when calling deleteResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","DELETE",{responseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteResponsemanagementResponseasset(e){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling deleteResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","DELETE",{responseAssetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementLibraries(e){return e=e||{},this.apiClient.callApi("/api/v2/responsemanagement/libraries","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,messagingTemplateFilter:e.messagingTemplateFilter,libraryPrefix:e.libraryPrefix},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementLibrary(e){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling getResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","GET",{libraryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponse(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "responseId" when calling getResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","GET",{responseId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponseasset(e){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling getResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","GET",{responseAssetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponseassetsStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling getResponsemanagementResponseassetsStatusStatusId';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/status/{statusId}","GET",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling getResponsemanagementResponses';return this.apiClient.callApi("/api/v2/responsemanagement/responses","GET",{},{libraryId:e,pageNumber:i.pageNumber,pageSize:i.pageSize,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementLibraries(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementLibraries';return this.apiClient.callApi("/api/v2/responsemanagement/libraries","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementLibrariesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/bulk","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponseassetsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponseassetsSearch';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/search","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponseassetsUploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponseassetsUploads';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/uploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponses';return this.apiClient.callApi("/api/v2/responsemanagement/responses","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponsesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponsesQuery';return this.apiClient.callApi("/api/v2/responsemanagement/responses/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementLibrary(e,i){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling putResponsemanagementLibrary';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","PUT",{libraryId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementResponse(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "responseId" when calling putResponsemanagementResponse';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","PUT",{responseId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementResponseasset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling putResponsemanagementResponseasset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","PUT",{responseAssetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class re{constructor(e){this.apiClient=e||d.instance}deleteRoutingAssessment(e){if(void 0===e||null===e)throw'Missing the required parameter "assessmentId" when calling deleteRoutingAssessment';return this.apiClient.callApi("/api/v2/routing/assessments/{assessmentId}","DELETE",{assessmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailDomainRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling deleteRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling deleteRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","DELETE",{domainName:e,routeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailOutboundDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling deleteRoutingLanguage';return this.apiClient.callApi("/api/v2/routing/languages/{languageId}","DELETE",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling deleteRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","DELETE",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueue(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","DELETE",{queueId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteRoutingQueueMember';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members/{memberId}","DELETE",{queueId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueUser';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteRoutingQueueUser';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users/{memberId}","DELETE",{queueId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueWrapupcode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueWrapupcode';if(void 0===i||null===i)throw'Missing the required parameter "codeId" when calling deleteRoutingQueueWrapupcode';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}","DELETE",{queueId:e,codeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSettings(){return this.apiClient.callApi("/api/v2/routing/settings","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSkill(e){if(void 0===e||null===e)throw'Missing the required parameter "skillId" when calling deleteRoutingSkill';return this.apiClient.callApi("/api/v2/routing/skills/{skillId}","DELETE",{skillId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSkillgroup(e){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","DELETE",{skillGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSmsAddress(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling deleteRoutingSmsAddress';return this.apiClient.callApi("/api/v2/routing/sms/addresses/{addressId}","DELETE",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSmsPhonenumber(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","DELETE",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilization(){return this.apiClient.callApi("/api/v2/routing/utilization","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilizationLabel(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","DELETE",{labelId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilizationTag(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}","DELETE",{tagId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingWrapupcode(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling deleteRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","DELETE",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutinglanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","DELETE",{userId:e,languageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutingskill(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling deleteUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","DELETE",{userId:e,skillId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessment(e){if(void 0===e||null===e)throw'Missing the required parameter "assessmentId" when calling getRoutingAssessment';return this.apiClient.callApi("/api/v2/routing/assessments/{assessmentId}","GET",{assessmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessments(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,queueId:this.apiClient.buildCollectionParam(e.queueId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessmentsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRoutingAssessmentsJob';return this.apiClient.callApi("/api/v2/routing/assessments/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessmentsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments/jobs","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAvailablemediatypes(){return this.apiClient.callApi("/api/v2/routing/availablemediatypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomainRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling getRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","GET",{domainName:e,routeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomainRoutes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoutes';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes","GET",{domainName:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,pattern:i.pattern},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/email/domains","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,excludeStatus:e.excludeStatus,filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomainActivation(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/activation","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomainSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/search","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/email/outbound/domains","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailSetup(){return this.apiClient.callApi("/api/v2/routing/email/setup","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling getRoutingLanguage';return this.apiClient.callApi("/api/v2/routing/languages/{languageId}","GET",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingLanguages(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/languages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingMessageRecipient(e){if(void 0===e||null===e)throw'Missing the required parameter "recipientId" when calling getRoutingMessageRecipient';return this.apiClient.callApi("/api/v2/routing/message/recipients/{recipientId}","GET",{recipientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingMessageRecipients(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/message/recipients","GET",{},{messengerType:e.messengerType,name:e.name,pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorModelFeatures(e,i){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictorModelFeatures';if(void 0===i||null===i)throw'Missing the required parameter "modelId" when calling getRoutingPredictorModelFeatures';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}/models/{modelId}/features","GET",{predictorId:e,modelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorModels(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictorModels';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}/models","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,queueId:this.apiClient.buildCollectionParam(e.queueId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorsKeyperformanceindicators(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors/keyperformanceindicators","GET",{},{kpiGroup:e.kpiGroup,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueue(e){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","GET",{queueId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueComparisonperiod(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueComparisonperiod';if(void 0===i||null===i)throw'Missing the required parameter "comparisonPeriodId" when calling getRoutingQueueComparisonperiod';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}","GET",{queueId:e,comparisonPeriodId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueComparisonperiods(e){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueComparisonperiods';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/comparisonperiods","GET",{queueId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueEstimatedwaittime(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueEstimatedwaittime';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/estimatedwaittime","GET",{queueId:e},{conversationId:i.conversationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueMediatypeEstimatedwaittime(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';if(void 0===i||null===i)throw'Missing the required parameter "mediaType" when calling getRoutingQueueMediatypeEstimatedwaittime';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime","GET",{queueId:e,mediaType:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","GET",{queueId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),name:i.name,profileSkills:this.apiClient.buildCollectionParam(i.profileSkills,"multi"),skills:this.apiClient.buildCollectionParam(i.skills,"multi"),languages:this.apiClient.buildCollectionParam(i.languages,"multi"),routingStatus:this.apiClient.buildCollectionParam(i.routingStatus,"multi"),presence:this.apiClient.buildCollectionParam(i.presence,"multi"),memberBy:i.memberBy,joined:i.joined},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","GET",{queueId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),joined:i.joined,name:i.name,profileSkills:this.apiClient.buildCollectionParam(i.profileSkills,"multi"),skills:this.apiClient.buildCollectionParam(i.skills,"multi"),languages:this.apiClient.buildCollectionParam(i.languages,"multi"),routingStatus:this.apiClient.buildCollectionParam(i.routingStatus,"multi"),presence:this.apiClient.buildCollectionParam(i.presence,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueWrapupcodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueWrapupcodes';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes","GET",{queueId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueues(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),peerId:this.apiClient.buildCollectionParam(e.peerId,"multi"),cannedResponseLibraryId:e.cannedResponseLibraryId,hasPeer:e.hasPeer},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesDivisionviewsAll(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/divisionviews/all","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesMe(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/me","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,joined:e.joined,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettings(){return this.apiClient.callApi("/api/v2/routing/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettingsContactcenter(){return this.apiClient.callApi("/api/v2/routing/settings/contactcenter","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettingsTranscription(){return this.apiClient.callApi("/api/v2/routing/settings/transcription","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkill(e){if(void 0===e||null===e)throw'Missing the required parameter "skillId" when calling getRoutingSkill';return this.apiClient.callApi("/api/v2/routing/skills/{skillId}","GET",{skillId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroup(e){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","GET",{skillGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroupMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members","GET",{skillGroupId:e},{pageSize:i.pageSize,after:i.after,before:i.before,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroupMembersDivisions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members/divisions","GET",{skillGroupId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroups(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/skillgroups","GET",{},{pageSize:e.pageSize,name:e.name,after:e.after,before:e.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkills(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/skills","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAddress(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling getRoutingSmsAddress';return this.apiClient.callApi("/api/v2/routing/sms/addresses/{addressId}","GET",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAddresses(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/sms/addresses","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAvailablephonenumbers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "countryCode" when calling getRoutingSmsAvailablephonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "phoneNumberType" when calling getRoutingSmsAvailablephonenumbers';return this.apiClient.callApi("/api/v2/routing/sms/availablephonenumbers","GET",{},{countryCode:e,region:t.region,city:t.city,areaCode:t.areaCode,phoneNumberType:i,pattern:t.pattern,addressRequirement:t.addressRequirement},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsPhonenumber(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "addressId" when calling getRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","GET",{addressId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsPhonenumbers(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/sms/phonenumbers","GET",{},{phoneNumber:e.phoneNumber,phoneNumberType:this.apiClient.buildCollectionParam(e.phoneNumberType,"multi"),phoneNumberStatus:this.apiClient.buildCollectionParam(e.phoneNumberStatus,"multi"),countryCode:this.apiClient.buildCollectionParam(e.countryCode,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,language:e.language,"integration.id":e.integrationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilization(){return this.apiClient.callApi("/api/v2/routing/utilization","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabel(e){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","GET",{labelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabelAgents(e){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}/agents","GET",{labelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabels(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/utilization/labels","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTag(e){if(void 0===e||null===e)throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}","GET",{tagId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTagAgents(e){if(void 0===e||null===e)throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}/agents","GET",{tagId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTags(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/utilization/tags","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcode(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling getRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","GET",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodes(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/wrapupcodes","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodesDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/divisionviews/{codeId}","GET",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/wrapupcodes/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),includeState:e.includeState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserQueues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,joined:i.joined,divisionId:this.apiClient.buildCollectionParam(i.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutinglanguages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingskills(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSkillgroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSkillgroups';return this.apiClient.callApi("/api/v2/users/{userId}/skillgroups","GET",{userId:e},{pageSize:i.pageSize,after:i.after,before:i.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingConversation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchRoutingConversation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingConversation';return this.apiClient.callApi("/api/v2/routing/conversations/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingEmailDomain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchRoutingEmailDomain';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingEmailDomainValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchRoutingEmailDomainValidate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingEmailDomainValidate';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}/validate","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingPredictor(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling patchRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","PATCH",{predictorId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueMember(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling patchRoutingQueueMember';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchRoutingQueueMember';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members/{memberId}","PATCH",{queueId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","PATCH",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueUser(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueUser';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling patchRoutingQueueUser';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchRoutingQueueUser';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users/{memberId}","PATCH",{queueId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueUsers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","PATCH",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSettingsContactcenter(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchRoutingSettingsContactcenter';return this.apiClient.callApi("/api/v2/routing/settings/contactcenter","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSettingsTranscription(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';return this.apiClient.callApi("/api/v2/routing/settings/transcription","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSkillgroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","PATCH",{skillGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchUserQueue';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchUserQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserQueue';return this.apiClient.callApi("/api/v2/users/{userId}/queues/{queueId}","PATCH",{queueId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserQueues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","PATCH",{userId:e},{divisionId:this.apiClient.buildCollectionParam(t.divisionId,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","PATCH",{userId:e,languageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguagesBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsQueuesObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/queues/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRoutingActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';return this.apiClient.callApi("/api/v2/analytics/routing/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingAssessments(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingAssessmentsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomainRoutes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling postRoutingEmailDomainRoutes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingEmailDomainRoutes';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes","POST",{domainName:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomainTestconnection(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainTestconnection';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}/testconnection","POST",{domainId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailDomains';return this.apiClient.callApi("/api/v2/routing/email/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailOutboundDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailOutboundDomainsSimulated(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/simulated","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingLanguages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingLanguages';return this.apiClient.callApi("/api/v2/routing/languages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueMembers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","POST",{queueId:e},{delete:t._delete},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueUsers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","POST",{queueId:e},{delete:t._delete},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueWrapupcodes';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes","POST",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueues(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingQueues';return this.apiClient.callApi("/api/v2/routing/queues","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkillgroupMembersDivisions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members/divisions","POST",{skillGroupId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkillgroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSkillgroups';return this.apiClient.callApi("/api/v2/routing/skillgroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkills(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSkills';return this.apiClient.callApi("/api/v2/routing/skills","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsAddresses(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsAddresses';return this.apiClient.callApi("/api/v2/routing/sms/addresses","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbersAlphanumeric(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/alphanumeric","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbersImport(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersImport';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/import","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingUtilizationLabels(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';return this.apiClient.callApi("/api/v2/routing/utilization/labels","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingUtilizationTags(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingUtilizationTags';return this.apiClient.callApi("/api/v2/routing/utilization/tags","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingWrapupcodes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingWrapupcodes';return this.apiClient.callApi("/api/v2/routing/wrapupcodes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutinglanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutingskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutingskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingEmailDomainRoute(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRoute';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","PUT",{domainName:e,routeId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingEmailOutboundDomainActivation(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/activation","PUT",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingMessageRecipient(e,i){if(void 0===e||null===e)throw'Missing the required parameter "recipientId" when calling putRoutingMessageRecipient';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingMessageRecipient';return this.apiClient.callApi("/api/v2/routing/message/recipients/{recipientId}","PUT",{recipientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingQueue(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling putRoutingQueue';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","PUT",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingSettings';return this.apiClient.callApi("/api/v2/routing/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSettingsTranscription(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingSettingsTranscription';return this.apiClient.callApi("/api/v2/routing/settings/transcription","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSmsPhonenumber(e,i){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","PUT",{addressId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUserUtilization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putRoutingUserUtilization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingUtilization';return this.apiClient.callApi("/api/v2/routing/utilization","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUtilizationLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","PUT",{labelId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingWrapupcode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling putRoutingWrapupcode';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","PUT",{codeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskill(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling putUserRoutingskill';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","PUT",{userId:e,skillId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class le{constructor(e){this.apiClient=e||d.instance}deleteScimUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","DELETE",{userId:e},{},{"If-Match":i.ifMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}deleteScimV2User(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","DELETE",{userId:e},{},{"If-Match":i.ifMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimGroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","GET",{groupId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/groups","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimResourcetype(e){if(void 0===e||null===e)throw'Missing the required parameter "resourceType" when calling getScimResourcetype';return this.apiClient.callApi("/api/v2/scim/resourcetypes/{resourceType}","GET",{resourceType:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimResourcetypes(){return this.apiClient.callApi("/api/v2/scim/resourcetypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getScimSchema';return this.apiClient.callApi("/api/v2/scim/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimSchemas(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/schemas","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimServiceproviderconfig(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/serviceproviderconfig","GET",{},{},{"If-None-Match":e.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","GET",{userId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/users","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Group(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","GET",{groupId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Groups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "filter" when calling getScimV2Groups';return this.apiClient.callApi("/api/v2/scim/v2/groups","GET",{},{startIndex:i.startIndex,count:i.count,attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi"),filter:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Resourcetype(e){if(void 0===e||null===e)throw'Missing the required parameter "resourceType" when calling getScimV2Resourcetype';return this.apiClient.callApi("/api/v2/scim/v2/resourcetypes/{resourceType}","GET",{resourceType:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Resourcetypes(){return this.apiClient.callApi("/api/v2/scim/v2/resourcetypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Schema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getScimV2Schema';return this.apiClient.callApi("/api/v2/scim/v2/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Schemas(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/schemas","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Serviceproviderconfig(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/serviceproviderconfig","GET",{},{},{"If-None-Match":e.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2User(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","GET",{userId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Users(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/users","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}patchScimGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchScimGroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","PATCH",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchScimUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","PATCH",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimV2Group(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchScimV2Group';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","PATCH",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimV2User(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchScimV2User';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","PATCH",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}postScimUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postScimUsers';return this.apiClient.callApi("/api/v2/scim/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}postScimV2Users(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postScimV2Users';return this.apiClient.callApi("/api/v2/scim/v2/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putScimGroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","PUT",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling putScimUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","PUT",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimV2Group(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putScimV2Group';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","PUT",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimV2User(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling putScimV2User';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","PUT",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}}class se{constructor(e){this.apiClient=e||d.instance}postScreenrecordingToken(e){return e=e||{},this.apiClient.callApi("/api/v2/screenrecording/token","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class pe{constructor(e){this.apiClient=e||d.instance}getScript(e){if(void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScript';return this.apiClient.callApi("/api/v2/scripts/{scriptId}","GET",{scriptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptPage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptPage';if(void 0===i||null===i)throw'Missing the required parameter "pageId" when calling getScriptPage';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/pages/{pageId}","GET",{scriptId:e,pageId:i},{scriptDataVersion:t.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptPages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptPages';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/pages","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScripts(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,sortBy:e.sortBy,sortOrder:e.sortOrder,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,sortBy:e.sortBy,sortOrder:e.sortOrder,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublished(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptId';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdPage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdPage';if(void 0===i||null===i)throw'Missing the required parameter "pageId" when calling getScriptsPublishedScriptIdPage';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/pages/{pageId}","GET",{scriptId:e,pageId:i},{scriptDataVersion:t.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdPages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdPages';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/pages","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdVariables(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdVariables';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/variables","GET",{scriptId:e},{input:i.input,output:i.output,type:i.type,scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsUploadStatus(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "uploadId" when calling getScriptsUploadStatus';return this.apiClient.callApi("/api/v2/scripts/uploads/{uploadId}/status","GET",{uploadId:e},{longPoll:i.longPoll},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postScriptExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling postScriptExport';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/export","POST",{scriptId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postScriptsPublished(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published","POST",{},{scriptDataVersion:e.scriptDataVersion},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class ue{constructor(e){this.apiClient=e||d.instance}getDocumentationGknSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "q64" when calling getDocumentationGknSearch';return this.apiClient.callApi("/api/v2/documentation/gkn/search","GET",{},{q64:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDocumentationSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "q64" when calling getDocumentationSearch';return this.apiClient.callApi("/api/v2/documentation/search","GET",{},{q64:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearch';return this.apiClient.callApi("/api/v2/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getUsersSearch';return this.apiClient.callApi("/api/v2/users/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsTranscriptsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/transcripts/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsParticipantsAttributesSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';return this.apiClient.callApi("/api/v2/conversations/participants/attributes/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationAllSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationAllSearch';return this.apiClient.callApi("/api/v2/documentation/all/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationGknSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationGknSearch';return this.apiClient.callApi("/api/v2/documentation/gkn/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationSearch';return this.apiClient.callApi("/api/v2/documentation/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLocationsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearch';return this.apiClient.callApi("/api/v2/search","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTranscriptsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';return this.apiClient.callApi("/api/v2/speechandtextanalytics/transcripts/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeamsSearch';return this.apiClient.callApi("/api/v2/teams/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearch';return this.apiClient.callApi("/api/v2/users/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchConversationTarget(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchConversationTarget';return this.apiClient.callApi("/api/v2/users/search/conversation/target","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchQueuemembersManage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';return this.apiClient.callApi("/api/v2/users/search/queuemembers/manage","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchTeamsAssign(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';return this.apiClient.callApi("/api/v2/users/search/teams/assign","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class de{constructor(e){this.apiClient=e||d.instance}getEmailsSettings(){return this.apiClient.callApi("/api/v2/emails/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSettingsExecutiondata(){return this.apiClient.callApi("/api/v2/settings/executiondata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmailsSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/emails/settings","PATCH",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchSettingsExecutiondata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';return this.apiClient.callApi("/api/v2/settings/executiondata","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class ce{constructor(e){this.apiClient=e||d.instance}deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","DELETE",{dictionaryFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsProgram(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "programId" when calling deleteSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","DELETE",{programId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsSentimentfeedback(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}","DELETE",{sentimentFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsTopic(e){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling deleteSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","DELETE",{topicId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversation';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversationCommunicationTranscripturl(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturl';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturl';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversationCommunicationTranscripturls(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsDictionaryfeedback(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback","GET",{},{dialect:e.dialect,nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","GET",{dictionaryFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgram(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramMappings(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramMappings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/mappings","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramTranscriptionengines(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramTranscriptionengines';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsPrograms(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize,state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsGeneralJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsProgramsGeneralJob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsMappings(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/mappings","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsPublishjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsProgramsPublishjob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsTranscriptionenginesDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsUnpublished(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/unpublished","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSentimentDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentiment/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSentimentfeedback(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSettings(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopic(e){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling getSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","GET",{topicId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopics(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize,state:e.state,name:e.name,ids:this.apiClient.buildCollectionParam(e.ids,"multi"),dialects:this.apiClient.buildCollectionParam(e.dialects,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsGeneral(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/general","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsGeneralStatus(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/general/status","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsPublishjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsPublishjob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchSpeechandtextanalyticsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchSpeechandtextanalyticsSettings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsDictionaryfeedback(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsDictionaryfeedback';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsPrograms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsPrograms';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsProgramsGeneralJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsProgramsGeneralJobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/general/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsProgramsPublishjobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsProgramsPublishjobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/publishjobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsSentimentfeedback(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTopics(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopics';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTopicsPublishjobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopicsPublishjobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/publishjobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTranscriptsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';return this.apiClient.callApi("/api/v2/speechandtextanalytics/transcripts/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","PUT",{dictionaryFeedbackId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgram(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgram';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgramMappings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramMappings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramMappings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/mappings","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgramTranscriptionengines(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramTranscriptionengines';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramTranscriptionengines';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsSettings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsTopic(e,i){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling putSpeechandtextanalyticsTopic';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","PUT",{topicId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ge{constructor(e){this.apiClient=e||d.instance}deleteStationAssociateduser(e){if(void 0===e||null===e)throw'Missing the required parameter "stationId" when calling deleteStationAssociateduser';return this.apiClient.callApi("/api/v2/stations/{stationId}/associateduser","DELETE",{stationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getStation(e){if(void 0===e||null===e)throw'Missing the required parameter "stationId" when calling getStation';return this.apiClient.callApi("/api/v2/stations/{stationId}","GET",{stationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getStations(e){return e=e||{},this.apiClient.callApi("/api/v2/stations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,name:e.name,userSelectable:e.userSelectable,webRtcUserId:e.webRtcUserId,id:e.id,lineAppearanceId:e.lineAppearanceId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class he{constructor(e){this.apiClient=e||d.instance}getSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearch';return this.apiClient.callApi("/api/v2/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearch';return this.apiClient.callApi("/api/v2/search","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class me{constructor(e){this.apiClient=e||d.instance}deleteTaskmanagementWorkbin(e){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling deleteTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","DELETE",{workbinId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorkitem(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling deleteTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","DELETE",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorkitemsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling deleteTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","DELETE",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorktype(e){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","DELETE",{worktypeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorktypeStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling deleteTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","DELETE",{worktypeId:e,statusId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbin(e){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","GET",{workbinId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinHistory';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/history","GET",{workbinId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkbinVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}","GET",{workbinId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/versions","GET",{workbinId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitem(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","GET",{workitemId:e},{expands:i.expands},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemHistory';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/history","GET",{workitemId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemUserWrapups(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemUserWrapups';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getTaskmanagementWorkitemUserWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups","GET",{workitemId:e,userId:i},{expands:t.expands,after:t.after,pageSize:t.pageSize,sortOrder:t.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkitemVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}","GET",{workitemId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/versions","GET",{workitemId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemWrapups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/wrapups","GET",{workitemId:e},{expands:i.expands,after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsQueryJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsQueryJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getTaskmanagementWorkitemsSchemaVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemas(){return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktype(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","GET",{worktypeId:e},{expands:this.apiClient.buildCollectionParam(i.expands,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/history","GET",{worktypeId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling getTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","GET",{worktypeId:e,statusId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeStatuses(e){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatuses';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses","GET",{worktypeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorktypeVersion';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}","GET",{worktypeId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersions';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/versions","GET",{worktypeId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkbin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling patchTaskmanagementWorkbin';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","PATCH",{workbinId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitem(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitem';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemAssignment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemAssignment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemAssignment';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/assignment","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemUserWrapups(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUserWrapups';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchTaskmanagementWorkitemUserWrapups';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUserWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups","PATCH",{workitemId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemUsersMeWrapups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUsersMeWrapups';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUsersMeWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorktype(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","PATCH",{worktypeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorktypeStatus(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","PATCH",{worktypeId:e,statusId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkbins(e){return e=e||{},this.apiClient.callApi("/api/v2/taskmanagement/workbins","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkbinsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkbinsQuery';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemAcdCancel(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemAcdCancel';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel","POST",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemDisconnect';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/disconnect","POST",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemTerminate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemTerminate';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/terminate","POST",{workitemId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitems(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitems';return this.apiClient.callApi("/api/v2/taskmanagement/workitems","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQuery';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsQueryJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsSchemas';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypeStatuses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses","POST",{worktypeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypes(e){return e=e||{},this.apiClient.callApi("/api/v2/taskmanagement/worktypes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorktypesQuery';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putTaskmanagementWorkitemsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putTaskmanagementWorkitemsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ve{constructor(e){this.apiClient=e||d.instance}deleteTeam(e){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling deleteTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","DELETE",{teamId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTeamMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling deleteTeamMembers';if(void 0===i||null===i)throw'Missing the required parameter "id" when calling deleteTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","DELETE",{teamId:e},{id:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeam(e){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling getTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","GET",{teamId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeamMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling getTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","GET",{teamId:e},{pageSize:i.pageSize,before:i.before,after:i.after,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeams(e){return e=e||{},this.apiClient.callApi("/api/v2/teams","GET",{},{pageSize:e.pageSize,name:e.name,after:e.after,before:e.before,expand:e.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTeam(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling patchTeam';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","PATCH",{teamId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTeamsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTeamsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/teams/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postTeamMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","POST",{teamId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTeams(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeams';return this.apiClient.callApi("/api/v2/teams","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeamsSearch';return this.apiClient.callApi("/api/v2/teams/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class we{constructor(e){this.apiClient=e||d.instance}getTelephonyMediaregions(){return this.apiClient.callApi("/api/v2/telephony/mediaregions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySipmessagesConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';return this.apiClient.callApi("/api/v2/telephony/sipmessages/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySipmessagesConversationHeaders(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';return this.apiClient.callApi("/api/v2/telephony/sipmessages/conversations/{conversationId}/headers","GET",{conversationId:e},{keys:this.apiClient.buildCollectionParam(i.keys,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySiptraces(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "dateStart" when calling getTelephonySiptraces';if(void 0===i||null===i)throw'Missing the required parameter "dateEnd" when calling getTelephonySiptraces';return this.apiClient.callApi("/api/v2/telephony/siptraces","GET",{},{callId:t.callId,toUser:t.toUser,fromUser:t.fromUser,conversationId:t.conversationId,dateStart:e,dateEnd:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySiptracesDownloadDownloadId(e){if(void 0===e||null===e)throw'Missing the required parameter "downloadId" when calling getTelephonySiptracesDownloadDownloadId';return this.apiClient.callApi("/api/v2/telephony/siptraces/download/{downloadId}","GET",{downloadId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonySiptracesDownload(e){if(void 0===e||null===e)throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';return this.apiClient.callApi("/api/v2/telephony/siptraces/download","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ce{constructor(e){this.apiClient=e||d.instance}deleteTelephonyProvidersEdge(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","DELETE",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgeLogicalinterface(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling deleteTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","DELETE",{edgeId:e,interfaceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgeSoftwareupdate(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","DELETE",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesCertificateauthority(e){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling deleteTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","DELETE",{certificateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesDidpool(e){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling deleteTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","DELETE",{didPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesEdgegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling deleteTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","DELETE",{edgeGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesExtensionpool(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling deleteTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","DELETE",{extensionPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesPhone(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling deleteTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","DELETE",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesPhonebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling deleteTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","DELETE",{phoneBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesSite(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling deleteTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","DELETE",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesSiteOutboundroute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling deleteTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","DELETE",{siteId:e,outboundRouteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesTrunkbasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling deleteTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","DELETE",{trunkBaseSettingsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdge(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","GET",{edgeId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticNslookup(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticNslookup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticPing(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticPing';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticRoute(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticRoute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticTracepath(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticTracepath';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogicalinterface(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling getTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","GET",{edgeId:e,interfaceId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogicalinterfaces(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces","GET",{edgeId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getTelephonyProvidersEdgeLogsJob';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}","GET",{edgeId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/metrics","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgePhysicalinterface(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgePhysicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling getTelephonyProvidersEdgePhysicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}","GET",{edgeId:e,interfaceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgePhysicalinterfaces(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgePhysicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSetuppackage(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSetuppackage';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/setuppackage","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSoftwareupdate(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSoftwareversions(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSoftwareversions';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareversions","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeTrunks(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeTrunks';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/trunks","GET",{edgeId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortBy:i.sortBy,sortOrder:i.sortOrder,"trunkBase.id":i.trunkBaseId,trunkType:i.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdges(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,"site.id":e.siteId,"edgeGroup.id":e.edgeGroupId,sortBy:e.sortBy,managed:e.managed,showCloudMedia:e.showCloudMedia},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesCertificateauthority(e){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling getTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","GET",{certificateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDid(e){if(void 0===e||null===e)throw'Missing the required parameter "didId" when calling getTelephonyProvidersEdgesDid';return this.apiClient.callApi("/api/v2/telephony/providers/edges/dids/{didId}","GET",{didId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpool(e){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling getTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","GET",{didPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpools(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpoolsDids(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "type" when calling getTelephonyProvidersEdgesDidpoolsDids';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/dids","GET",{},{type:e,id:this.apiClient.buildCollectionParam(i.id,"multi"),numberMatch:i.numberMatch,pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDids(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/dids","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,phoneNumber:e.phoneNumber,"owner.id":e.ownerId,"didPool.id":e.didPoolId,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling getTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","GET",{edgeGroupId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgegroupId" when calling getTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===i||null===i)throw'Missing the required parameter "edgetrunkbaseId" when calling getTelephonyProvidersEdgesEdgegroupEdgetrunkbase';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}","GET",{edgegroupId:e,edgetrunkbaseId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroups(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,sortBy:e.sortBy,managed:e.managed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgeversionreport(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgeversionreport","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExpired(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/expired","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtension(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionId" when calling getTelephonyProvidersEdgesExtension';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensions/{extensionId}","GET",{extensionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpool(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling getTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","GET",{extensionPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpools(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,number:e._number},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpoolsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensions(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,number:e._number},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLine(e){if(void 0===e||null===e)throw'Missing the required parameter "lineId" when calling getTelephonyProvidersEdgesLine';return this.apiClient.callApi("/api/v2/telephony/providers/edges/lines/{lineId}","GET",{lineId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "lineBaseId" when calling getTelephonyProvidersEdgesLinebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}","GET",{lineBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinebasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/linebasesettings","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLines(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/lines","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinesTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "lineBaseSettingsId" when calling getTelephonyProvidersEdgesLinesTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/lines/template","GET",{},{lineBaseSettingsId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLogicalinterfaces(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/logicalinterfaces","GET",{},{edgeIds:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMediastatisticsConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversation';return this.apiClient.callApi("/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMediastatisticsConversationCommunication(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';return this.apiClient.callApi("/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/metrics","GET",{},{edgeIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesOutboundroutes(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/outboundroutes","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,"site.id":e.siteId,"externalTrunkBases.ids":e.externalTrunkBasesIds,sortBy:e.sortBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhone(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling getTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","GET",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling getTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","GET",{phoneBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettingsTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneMetabaseId" when calling getTelephonyProvidersEdgesPhonebasesettingsTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/template","GET",{},{phoneMetabaseId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhones(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phones","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,"site.id":e.siteId,"webRtcUser.id":e.webRtcUserId,"phoneBaseSettings.id":e.phoneBaseSettingsId,"lines.loggedInUser.id":e.linesLoggedInUserId,"lines.defaultForUser.id":e.linesDefaultForUserId,phone_hardwareId:e.phoneHardwareId,"lines.id":e.linesId,"lines.name":e.linesName,name:e.name,"status.operationalStatus":e.statusOperationalStatus,"secondaryStatus.operationalStatus":e.secondaryStatusOperationalStatus,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),fields:this.apiClient.buildCollectionParam(e.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonesTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseSettingsId" when calling getTelephonyProvidersEdgesPhonesTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/template","GET",{},{phoneBaseSettingsId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhysicalinterfaces(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesPhysicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/physicalinterfaces","GET",{},{edgeIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSite(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplan';if(void 0===i||null===i)throw'Missing the required parameter "numberPlanId" when calling getTelephonyProvidersEdgesSiteNumberplan';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}","GET",{siteId:e,numberPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplans(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplans';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplansClassifications(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplansClassifications';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications","GET",{siteId:e},{classification:i.classification},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteOutboundroute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling getTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","GET",{siteId:e,outboundRouteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteOutboundroutes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteOutboundroutes';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes","GET",{siteId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,name:i.name,"externalTrunkBases.ids":i.externalTrunkBasesIds,sortBy:i.sortBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteSiteconnections(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSites(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/sites","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,"location.id":e.locationId,managed:e.managed,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTimezones(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/timezones","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunk(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkId" when calling getTelephonyProvidersEdgesTrunk';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/{trunkId}","GET",{trunkId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkId" when calling getTelephonyProvidersEdgesTrunkMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics","GET",{trunkId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesetting(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling getTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","GET",{trunkBaseSettingsId:e},{ignoreHidden:i.ignoreHidden},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,recordingEnabled:e.recordingEnabled,ignoreHidden:e.ignoreHidden,managed:e.managed,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases","GET",{},{type:e.type,pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettingsTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkMetabaseId" when calling getTelephonyProvidersEdgesTrunkbasesettingsTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/template","GET",{},{trunkMetabaseId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunks(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,"edge.id":e.edgeId,"trunkBase.id":e.trunkBaseId,trunkType:e.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunksMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkIds" when calling getTelephonyProvidersEdgesTrunksMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/metrics","GET",{},{trunkIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkswithrecording(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkswithrecording","GET",{},{trunkType:e.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTelephonyProvidersEdgesSiteSiteconnections(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","PATCH",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticNslookup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticNslookup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticNslookup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticPing(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticPing';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticPing';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticRoute';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticRoute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticTracepath(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticTracepath';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticTracepath';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogicalinterfaces(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogicalinterfaces';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogsJobUpload(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogsJobUpload';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling postTelephonyProvidersEdgeLogsJobUpload';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogsJobUpload';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload","POST",{edgeId:e,jobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogsJobs';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeReboot(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/reboot","POST",{edgeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeSoftwareupdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeSoftwareupdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeStatuscode(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeStatuscode';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/statuscode","POST",{edgeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeUnpair(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeUnpair';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/unpair","POST",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdges(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdges';return this.apiClient.callApi("/api/v2/telephony/providers/edges","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesAddressvalidation(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesAddressvalidation';return this.apiClient.callApi("/api/v2/telephony/providers/edges/addressvalidation","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesCertificateauthorities(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesCertificateauthorities';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesDidpools(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesDidpools';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesEdgegroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesEdgegroups';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesExtensionpools(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesExtensionpools';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhoneReboot(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling postTelephonyProvidersEdgesPhoneReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}/reboot","POST",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhonebasesettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhonebasesettings';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhones(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhones';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhonesReboot(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhonesReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/reboot","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesSiteOutboundroutes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling postTelephonyProvidersEdgesSiteOutboundroutes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSiteOutboundroutes';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes","POST",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesSites(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSites';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesTrunkbasesettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesTrunkbasesettings';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdge(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdge';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","PUT",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgeLogicalinterface(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling putTelephonyProvidersEdgeLogicalinterface';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","PUT",{edgeId:e,interfaceId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesCertificateauthority(e,i){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling putTelephonyProvidersEdgesCertificateauthority';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","PUT",{certificateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesDidpool(e,i){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling putTelephonyProvidersEdgesDidpool';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","PUT",{didPoolId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesEdgegroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling putTelephonyProvidersEdgesEdgegroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","PUT",{edgeGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgegroupId" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===i||null===i)throw'Missing the required parameter "edgetrunkbaseId" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}","PUT",{edgegroupId:e,edgetrunkbaseId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesExtensionpool(e,i){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling putTelephonyProvidersEdgesExtensionpool';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","PUT",{extensionPoolId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesPhone(e,i){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling putTelephonyProvidersEdgesPhone';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","PUT",{phoneId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesPhonebasesetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling putTelephonyProvidersEdgesPhonebasesetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","PUT",{phoneBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSite(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSite';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteNumberplans(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteNumberplans';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteNumberplans';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteOutboundroute(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesSiteOutboundroute';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","PUT",{siteId:e,outboundRouteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteSiteconnections(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesTrunkbasesetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling putTelephonyProvidersEdgesTrunkbasesetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","PUT",{trunkBaseSettingsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ie{constructor(e){this.apiClient=e||d.instance}getTextbotsBotsSearch(e){return e=e||{},this.apiClient.callApi("/api/v2/textbots/bots/search","GET",{},{botType:this.apiClient.buildCollectionParam(e.botType,"multi"),botName:e.botName,botId:this.apiClient.buildCollectionParam(e.botId,"multi"),pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotflowsSessionTurns(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postTextbotsBotflowsSessionTurns';if(void 0===i||null===i)throw'Missing the required parameter "turnRequest" when calling postTextbotsBotflowsSessionTurns';return this.apiClient.callApi("/api/v2/textbots/botflows/sessions/{sessionId}/turns","POST",{sessionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotflowsSessions(e){if(void 0===e||null===e)throw'Missing the required parameter "launchRequest" when calling postTextbotsBotflowsSessions';return this.apiClient.callApi("/api/v2/textbots/botflows/sessions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotsExecute(e){if(void 0===e||null===e)throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';return this.apiClient.callApi("/api/v2/textbots/bots/execute","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class fe{constructor(e){this.apiClient=e||d.instance}deleteToken(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteToken';return this.apiClient.callApi("/api/v2/tokens/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTokensMe(){return this.apiClient.callApi("/api/v2/tokens/me","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTokensMe(e){return e=e||{},this.apiClient.callApi("/api/v2/tokens/me","GET",{},{preserveIdleTTL:e.preserveIdleTTL},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTokensTimeout(){return this.apiClient.callApi("/api/v2/tokens/timeout","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}headTokensMe(){return this.apiClient.callApi("/api/v2/tokens/me","HEAD",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putTokensTimeout(e){return e=e||{},this.apiClient.callApi("/api/v2/tokens/timeout","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ae{constructor(e){this.apiClient=e||d.instance}getKnowledgeKnowledgebaseUploadsUrlsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}","GET",{knowledgeBaseId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftFunctionUpload(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function/upload","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeDocumentuploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';return this.apiClient.callApi("/api/v2/knowledge/documentuploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseUploadsUrlsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerUploads(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerUploads';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingMinerUploads';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/uploads","POST",{minerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsLearningCoverart(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsLearningCoverart';return this.apiClient.callApi("/api/v2/uploads/learning/coverart","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsPublicassetsImages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsPublicassetsImages';return this.apiClient.callApi("/api/v2/uploads/publicassets/images","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsRecordings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsRecordings';return this.apiClient.callApi("/api/v2/uploads/recordings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsWorkforcemanagementHistoricaldataCsv(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';return this.apiClient.callApi("/api/v2/uploads/workforcemanagement/historicaldata/csv","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class be{constructor(e){this.apiClient=e||d.instance}getOauthClientUsageQueryResult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getOauthClientUsageQueryResult';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}","GET",{executionId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageSummary(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClientUsageSummary';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/summary","GET",{clientId:e},{days:i.days},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageQueryExecutionIdResults(e){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getUsageQueryExecutionIdResults';return this.apiClient.callApi("/api/v2/usage/query/{executionId}/results","GET",{executionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageSimplesearchExecutionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';return this.apiClient.callApi("/api/v2/usage/simplesearch/{executionId}/results","GET",{executionId:e},{after:i.after,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientUsageQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOauthClientUsageQuery';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query","POST",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUsageQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsageQuery';return this.apiClient.callApi("/api/v2/usage/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsageSimplesearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsageSimplesearch';return this.apiClient.callApi("/api/v2/usage/simplesearch","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class je{constructor(e){this.apiClient=e||d.instance}deleteUserrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling deleteUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","DELETE",{recordingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecording(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling getUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","GET",{recordingId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling getUserrecordingMedia';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}/media","GET",{recordingId:e},{formatId:i.formatId,async:i.async},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordings(e){return e=e||{},this.apiClient.callApi("/api/v2/userrecordings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordingsSummary(){return this.apiClient.callApi("/api/v2/userrecordings/summary","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserrecording(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling putUserrecording';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","PUT",{recordingId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Pe{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationSubjectDivisionRole(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling deleteAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","DELETE",{subjectId:e,divisionId:i,roleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUser';return this.apiClient.callApi("/api/v2/users/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutinglanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","DELETE",{userId:e,languageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutingskill(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling deleteUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","DELETE",{userId:e,skillId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserStationAssociatedstation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserStationAssociatedstation';return this.apiClient.callApi("/api/v2/users/{userId}/station/associatedstation","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserStationDefaultstation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserStationDefaultstation';return this.apiClient.callApi("/api/v2/users/{userId}/station/defaultstation","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserVerifier(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserVerifier';if(void 0===i||null===i)throw'Missing the required parameter "verifierId" when calling deleteUserVerifier';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers/{verifierId}","DELETE",{userId:e,verifierId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/me","GET",{},{name:i.name,permission:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/me","GET",{},{permission:e,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedSubjectId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationDivisionspermittedPagedSubjectId';if(void 0===i||null===i)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedSubjectId';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/{subjectId}","GET",{subjectId:e},{permission:i,pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}","GET",{subjectId:e},{includeDuplicates:i.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/me","GET",{},{includeDuplicates:e.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProfilesUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/profiles/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jid:this.apiClient.buildCollectionParam(e.jid,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUser';return this.apiClient.callApi("/api/v2/users/{userId}","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource,state:i.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserAdjacents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserAdjacents';return this.apiClient.callApi("/api/v2/users/{userId}/adjacents","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserCallforwarding(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserDirectreports(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserDirectreports';return this.apiClient.callApi("/api/v2/users/{userId}/directreports","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserFavorites(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserFavorites';return this.apiClient.callApi("/api/v2/users/{userId}/favorites","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGeolocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","GET",{userId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserOutofoffice(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserOutofoffice';return this.apiClient.callApi("/api/v2/users/{userId}/outofoffice","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserProfile';return this.apiClient.callApi("/api/v2/users/{userId}/profile","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserProfileskills(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserProfileskills';return this.apiClient.callApi("/api/v2/users/{userId}/profileskills","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserQueues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,joined:i.joined,divisionId:this.apiClient.buildCollectionParam(i.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","GET",{subjectId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutinglanguages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingskills(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingstatus';return this.apiClient.callApi("/api/v2/users/{userId}/routingstatus","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSkillgroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSkillgroups';return this.apiClient.callApi("/api/v2/users/{userId}/skillgroups","GET",{userId:e},{pageSize:i.pageSize,after:i.after,before:i.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserState(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserState';return this.apiClient.callApi("/api/v2/users/{userId}/state","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserStation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserStation';return this.apiClient.callApi("/api/v2/users/{userId}/station","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSuperiors(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSuperiors';return this.apiClient.callApi("/api/v2/users/{userId}/superiors","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserTrustors(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserTrustors';return this.apiClient.callApi("/api/v2/users/{userId}/trustors","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserVerifiers(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserVerifiers';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource,state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivities(e){return e=e||{},this.apiClient.callApi("/api/v2/users/development/activities","GET",{},{userId:this.apiClient.buildCollectionParam(e.userId,"multi"),moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pass:e.pass,pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,types:this.apiClient.buildCollectionParam(e.types,"multi"),statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),relationship:this.apiClient.buildCollectionParam(e.relationship,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivitiesMe(e){return e=e||{},this.apiClient.callApi("/api/v2/users/development/activities/me","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pass:e.pass,pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,types:this.apiClient.buildCollectionParam(e.types,"multi"),statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),relationship:this.apiClient.buildCollectionParam(e.relationship,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivity(e,i){if(void 0===e||null===e)throw'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';if(void 0===i||null===i)throw'Missing the required parameter "type" when calling getUsersDevelopmentActivity';return this.apiClient.callApi("/api/v2/users/development/activities/{activityId}","GET",{activityId:e},{type:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersMe(e){return e=e||{},this.apiClient.callApi("/api/v2/users/me","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getUsersSearch';return this.apiClient.callApi("/api/v2/users/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUser';return this.apiClient.callApi("/api/v2/users/{userId}","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserCallforwarding(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserCallforwarding';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserGeolocation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling patchUserGeolocation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","PATCH",{userId:e,clientId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchUserQueue';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchUserQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserQueue';return this.apiClient.callApi("/api/v2/users/{userId}/queues/{queueId}","PATCH",{queueId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserQueues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","PATCH",{userId:e},{divisionId:this.apiClient.buildCollectionParam(t.divisionId,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","PATCH",{userId:e,languageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguagesBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUsersBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchUsersBulk';return this.apiClient.callApi("/api/v2/users/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersActivityQuery';return this.apiClient.callApi("/api/v2/analytics/users/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/users/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/users/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkadd(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkadd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkadd';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkadd","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkremove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkremove';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkremove","POST",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkreplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkreplace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkreplace';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkreplace","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectDivisionRole(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling postAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling postAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","POST",{subjectId:e,divisionId:i,roleId:t},{subjectType:n.subjectType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postUserExternalid(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserExternalid';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserExternalid';return this.apiClient.callApi("/api/v2/users/{userId}/externalid","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserInvite(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserInvite';return this.apiClient.callApi("/api/v2/users/{userId}/invite","POST",{userId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postUserPassword(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserPassword';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserPassword';return this.apiClient.callApi("/api/v2/users/{userId}/password","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutinglanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutingskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutingskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsers';return this.apiClient.callApi("/api/v2/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersDevelopmentActivitiesAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';return this.apiClient.callApi("/api/v2/users/development/activities/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersMePassword(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersMePassword';return this.apiClient.callApi("/api/v2/users/me/password","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearch';return this.apiClient.callApi("/api/v2/users/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchConversationTarget(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchConversationTarget';return this.apiClient.callApi("/api/v2/users/search/conversation/target","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchQueuemembersManage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';return this.apiClient.callApi("/api/v2/users/search/queuemembers/manage","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchTeamsAssign(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';return this.apiClient.callApi("/api/v2/users/search/teams/assign","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUserUtilization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putRoutingUserUtilization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserCallforwarding(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserCallforwarding';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserOutofoffice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserOutofoffice';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserOutofoffice';return this.apiClient.callApi("/api/v2/users/{userId}/outofoffice","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserProfileskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserProfileskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserProfileskills';return this.apiClient.callApi("/api/v2/users/{userId}/profileskills","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling putUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","PUT",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskill(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling putUserRoutingskill';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","PUT",{userId:e,skillId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingstatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingstatus';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingstatus';return this.apiClient.callApi("/api/v2/users/{userId}/routingstatus","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserState(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserState';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserState';return this.apiClient.callApi("/api/v2/users/{userId}/state","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserStationAssociatedstationStationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserStationAssociatedstationStationId';if(void 0===i||null===i)throw'Missing the required parameter "stationId" when calling putUserStationAssociatedstationStationId';return this.apiClient.callApi("/api/v2/users/{userId}/station/associatedstation/{stationId}","PUT",{userId:e,stationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserStationDefaultstationStationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserStationDefaultstationStationId';if(void 0===i||null===i)throw'Missing the required parameter "stationId" when calling putUserStationDefaultstationStationId';return this.apiClient.callApi("/api/v2/users/{userId}/station/defaultstation/{stationId}","PUT",{userId:e,stationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserVerifier(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserVerifier';if(void 0===i||null===i)throw'Missing the required parameter "verifierId" when calling putUserVerifier';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserVerifier';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers/{verifierId}","PUT",{userId:e,verifierId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class ye{constructor(e){this.apiClient=e||d.instance}getDate(){return this.apiClient.callApi("/api/v2/date","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIpranges(){return this.apiClient.callApi("/api/v2/ipranges","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTimezones(e){return e=e||{},this.apiClient.callApi("/api/v2/timezones","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postCertificateDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCertificateDetails';return this.apiClient.callApi("/api/v2/certificate/details","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Oe{constructor(e){this.apiClient=e||d.instance}deleteVoicemailMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling deleteVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","DELETE",{messageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteVoicemailMessages(){return this.apiClient.callApi("/api/v2/voicemail/messages","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupMailbox(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupMailbox';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/mailbox","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupMessages';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/messages","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupPolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupPolicy';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/policy","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMailbox(){return this.apiClient.callApi("/api/v2/voicemail/mailbox","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMeMailbox(){return this.apiClient.callApi("/api/v2/voicemail/me/mailbox","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMeMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/me/messages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMePolicy(){return this.apiClient.callApi("/api/v2/voicemail/me/policy","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessage(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","GET",{messageId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessageMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getVoicemailMessageMedia';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}/media","GET",{messageId:e},{formatId:i.formatId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/messages","GET",{},{ids:e.ids,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailPolicy(){return this.apiClient.callApi("/api/v2/voicemail/policy","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailQueueMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getVoicemailQueueMessages';return this.apiClient.callApi("/api/v2/voicemail/queues/{queueId}/messages","GET",{queueId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailUserpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailGroupPolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchVoicemailGroupPolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailGroupPolicy';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/policy","PATCH",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailMePolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchVoicemailMePolicy';return this.apiClient.callApi("/api/v2/voicemail/me/policy","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling patchVoicemailMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","PATCH",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailUserpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchVoicemailUserpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/messages","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling putVoicemailMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","PUT",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailPolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putVoicemailPolicy';return this.apiClient.callApi("/api/v2/voicemail/policy","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailUserpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putVoicemailUserpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Me{constructor(e){this.apiClient=e||d.instance}deleteWebchatDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebchatGuestConversationMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteWebchatGuestConversationMember';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}","DELETE",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebchatSettings(){return this.apiClient.callApi("/api/v2/webchat/settings","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","GET",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatDeployments(){return this.apiClient.callApi("/api/v2/webchat/deployments","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMediarequest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';if(void 0===i||null===i)throw'Missing the required parameter "mediaRequestId" when calling getWebchatGuestConversationMediarequest';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}","GET",{conversationId:e,mediaRequestId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMediarequests(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequests';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling getWebchatGuestConversationMember';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}","GET",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMembers';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members","GET",{conversationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,excludeDisconnectedMembers:i.excludeDisconnectedMembers},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getWebchatGuestConversationMessage';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessages';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/messages","GET",{conversationId:e},{after:i.after,before:i.before,sortOrder:i.sortOrder,maxResults:i.maxResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatSettings(){return this.apiClient.callApi("/api/v2/webchat/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchWebchatGuestConversationMediarequest(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchWebchatGuestConversationMediarequest';if(void 0===i||null===i)throw'Missing the required parameter "mediaRequestId" when calling patchWebchatGuestConversationMediarequest';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchWebchatGuestConversationMediarequest';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}","PATCH",{conversationId:e,mediaRequestId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebchatDeployments';return this.apiClient.callApi("/api/v2/webchat/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversationMemberMessages(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberMessages';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWebchatGuestConversationMemberMessages';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages","POST",{conversationId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversationMemberTyping(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberTyping';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberTyping';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing","POST",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebchatGuestConversations';return this.apiClient.callApi("/api/v2/webchat/guest/conversations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putWebchatDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWebchatDeployment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWebchatSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putWebchatSettings';return this.apiClient.callApi("/api/v2/webchat/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Te{constructor(e){this.apiClient=e||d.instance}deleteWebdeploymentsConfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling deleteWebdeploymentsConfiguration';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}","DELETE",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsDeploymentCobrowseSessionId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';if(void 0===i||null===i)throw'Missing the required parameter "sessionId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}","DELETE",{deploymentId:e,sessionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsTokenRevoke(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/token/revoke","DELETE",{},{},{"X-Journey-Session-Id":e.xJourneySessionId,"X-Journey-Session-Type":e.xJourneySessionType},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getWebdeploymentsConfigurationVersion';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}","GET",{configurationId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersions';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions","GET",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersionsDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersionsDraft';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft","GET",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurations(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/configurations","GET",{},{showOnlyPublished:e.showOnlyPublished},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeployment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","GET",{deploymentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeploymentCobrowseSessionId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';if(void 0===i||null===i)throw'Missing the required parameter "sessionId" when calling getWebdeploymentsDeploymentCobrowseSessionId';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}","GET",{deploymentId:e,sessionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeploymentConfigurations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/configurations","GET",{deploymentId:e},{type:i.type,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeployments(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/deployments","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsConfigurationVersionsDraftPublish(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling postWebdeploymentsConfigurationVersionsDraftPublish';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish","POST",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsConfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationVersion" when calling postWebdeploymentsConfigurations';return this.apiClient.callApi("/api/v2/webdeployments/configurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "deployment" when calling postWebdeploymentsDeployments';return this.apiClient.callApi("/api/v2/webdeployments/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsTokenOauthcodegrantjwtexchange(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebdeploymentsTokenOauthcodegrantjwtexchange';return this.apiClient.callApi("/api/v2/webdeployments/token/oauthcodegrantjwtexchange","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsTokenRefresh(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/token/refresh","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWebdeploymentsConfigurationVersionsDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling putWebdeploymentsConfigurationVersionsDraft';if(void 0===i||null===i)throw'Missing the required parameter "configurationVersion" when calling putWebdeploymentsConfigurationVersionsDraft';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft","PUT",{configurationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWebdeploymentsDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeployment';if(void 0===i||null===i)throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class qe{constructor(e){this.apiClient=e||d.instance}getWebmessagingMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/webmessaging/messages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class Se{constructor(e){this.apiClient=e||d.instance}deleteWidgetsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWidgetsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","GET",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWidgetsDeployments(){return this.apiClient.callApi("/api/v2/widgets/deployments","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWidgetsDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWidgetsDeployments';return this.apiClient.callApi("/api/v2/widgets/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putWidgetsDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ke{constructor(e){this.apiClient=e||d.instance}deleteWorkforcemanagementBusinessunit(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","DELETE",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitActivitycode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling deleteWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","DELETE",{businessUnitId:e,activityCodeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitPlanninggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling deleteWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","DELETE",{businessUnitId:e,planningGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitSchedulingRun(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling deleteWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","DELETE",{businessUnitId:e,runId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitServicegoaltemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","DELETE",{businessUnitId:e,serviceGoalTemplateId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitStaffinggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","DELETE",{businessUnitId:e,staffingGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}","DELETE",{businessUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","DELETE",{businessUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitWeekSchedule(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}","DELETE",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitWeekShorttermforecast(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}","DELETE",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunit(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","DELETE",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","DELETE",{managementUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","DELETE",{managementUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitWorkplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","DELETE",{managementUnitId:e,workPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitWorkplanrotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","DELETE",{managementUnitId:e,workPlanRotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherence(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getWorkforcemanagementAdherence';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence","GET",{},{userId:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceExplanation(e){if(void 0===e||null===e)throw'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/{explanationId}","GET",{explanationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceExplanationsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceHistoricalBulkJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalBulkJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceHistoricalJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdhocmodelingjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';return this.apiClient.callApi("/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentAdherenceExplanation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';if(void 0===i||null===i)throw'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}","GET",{agentId:e,explanationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentManagementunit(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/managementunit","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentsMeManagementunit(){return this.apiClient.callApi("/api/v2/workforcemanagement/agents/me/managementunit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","GET",{businessUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitActivitycode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling getWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","GET",{businessUnitId:e,activityCodeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitActivitycodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes","GET",{businessUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitIntradayPlanninggroups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitIntradayPlanninggroups';if(void 0===i||null===i)throw'Missing the required parameter "_date" when calling getWorkforcemanagementBusinessunitIntradayPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups","GET",{businessUnitId:e},{date:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitManagementunits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitManagementunits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits","GET",{businessUnitId:e},{feature:i.feature,divisionId:i.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitPlanninggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling getWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","GET",{businessUnitId:e,planningGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitPlanninggroups(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups","GET",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRun(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling getWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","GET",{businessUnitId:e,runId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRunResult(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===t||null===t)throw'Missing the required parameter "managementUnitIds" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===n||null===n)throw'Missing the required parameter "expand" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result","GET",{businessUnitId:e,runId:i},{managementUnitIds:this.apiClient.buildCollectionParam(t,"multi"),expand:this.apiClient.buildCollectionParam(n,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRuns(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRuns';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs","GET",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitServicegoaltemplate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","GET",{businessUnitId:e,serviceGoalTemplateId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitServicegoaltemplates(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates","GET",{businessUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitStaffinggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","GET",{businessUnitId:e,staffingGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitStaffinggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}","GET",{businessUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","GET",{businessUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId,forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedule(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}","GET",{businessUnitId:e,weekId:i,scheduleId:t},{expand:n.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults","GET",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast","GET",{businessUnitId:e,weekId:i,scheduleId:t},{forceDownload:n.forceDownload},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===n||null===n)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}","GET",{businessUnitId:e,weekId:i,scheduleId:t,agentId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions","GET",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===n||null===n)throw'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}","GET",{businessUnitId:e,weekId:i,scheduleId:t,recalculationId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedules(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules","GET",{businessUnitId:e,weekId:i},{includeOnlyPublished:t.includeOnlyPublished,expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecast(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{expand:this.apiClient.buildCollectionParam(n.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastData(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{weekNumber:n.weekNumber,forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{weekNumbers:this.apiClient.buildCollectionParam(n.weekNumbers,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecasts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecasts';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecasts';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts","GET",{businessUnitId:e,weekDateId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits","GET",{},{feature:e.feature,divisionId:e.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/divisionviews","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementCalendarDataIcs(e){if(void 0===e||null===e)throw'Missing the required parameter "calendarId" when calling getWorkforcemanagementCalendarDataIcs';return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/data/ics","GET",{},{calendarId:e},{},{},null,["PureCloud OAuth"],["application/json"],["text/calendar"])}getWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/deletejob","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementHistoricaldataImportstatus(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/importstatus","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementIntegrationsHris(){return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementIntegrationsHrisTimeofftypesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitActivitycodes(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAdherence(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAdherence';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence","GET",{managementUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAgent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';if(void 0===i||null===i)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgent';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}","GET",{managementUnitId:e,agentId:i},{excludeCapabilities:t.excludeCapabilities,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAgentShifttrades(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgentShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades","GET",{managementUnitId:e,agentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitShifttradesMatched(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesMatched';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitShifttradesUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesUsers';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","GET",{managementUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeofflimits(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","GET",{managementUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeoffplans(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequest(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}","GET",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits","GET",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequests(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests","GET",{managementUnitId:e,userId:i},{recentlyReviewed:t.recentlyReviewed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUsers';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekSchedule(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}","GET",{managementUnitId:e,weekId:i,scheduleId:t},{expand:n.expand,forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekSchedules(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules","GET",{managementUnitId:e,weekId:i},{includeOnlyPublished:t.includeOnlyPublished,earliestWeekDate:t.earliestWeekDate,latestWeekDate:t.latestWeekDate},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekShifttrades(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades","GET",{managementUnitId:e,weekDateId:i},{evaluateMatches:t.evaluateMatches,forceDownloadService:t.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling getWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","GET",{managementUnitId:e,workPlanId:i},{includeOnly:this.apiClient.buildCollectionParam(t.includeOnly,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplanrotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","GET",{managementUnitId:e,workPlanRotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplanrotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),exclude:this.apiClient.buildCollectionParam(i.exclude,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,feature:e.feature,divisionId:e.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/divisionviews","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementNotifications(){return this.apiClient.callApi("/api/v2/workforcemanagement/notifications","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementSchedulingjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementSchedulingjob';return this.apiClient.callApi("/api/v2/workforcemanagement/schedulingjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementShifttrades(){return this.apiClient.callApi("/api/v2/workforcemanagement/shifttrades","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementShrinkageJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';return this.apiClient.callApi("/api/v2/workforcemanagement/shrinkage/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffbalanceJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequest(e){if(void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}","GET",{timeOffRequestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequestWaitlistpositions(e){if(void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions","GET",{timeOffRequestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequests(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests","GET",{},{recentlyReviewed:e.recentlyReviewed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementAgentAdherenceExplanation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';if(void 0===i||null===i)throw'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}","PATCH",{agentId:e,explanationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","PATCH",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitActivitycode(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","PATCH",{businessUnitId:e,activityCodeId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitPlanninggroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","PATCH",{businessUnitId:e,planningGroupId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitSchedulingRun(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","PATCH",{businessUnitId:e,runId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitServicegoaltemplate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","PATCH",{businessUnitId:e,serviceGoalTemplateId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitStaffinggroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","PATCH",{businessUnitId:e,staffingGroupId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitTimeoffplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","PATCH",{businessUnitId:e,timeOffPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","PATCH",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitAgents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents","PATCH",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeofflimit(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","PATCH",{managementUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeoffplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","PATCH",{managementUnitId:e,timeOffPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';if(void 0===i||null===i)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';if(void 0===t||null===t)throw'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus","PATCH",{managementUnitId:e,timeOffRequestId:i,userId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitUserTimeoffrequest(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}","PATCH",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWeekShifttrade(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===t||null===t)throw'Missing the required parameter "tradeId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWeekShifttrade';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}","PATCH",{managementUnitId:e,weekDateId:i,tradeId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWorkplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","PATCH",{managementUnitId:e,workPlanId:i},{validationMode:t.validationMode},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWorkplanrotation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","PATCH",{managementUnitId:e,workPlanRotationId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementTimeoffrequest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}","PATCH",{timeOffRequestId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceExplanations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceExplanationsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/query","POST",{},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceHistorical(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceHistoricalBulk(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/bulk","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentAdherenceExplanations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations","POST",{agentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentAdherenceExplanationsQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query","POST",{agentId:e},{forceAsync:t.forceAsync,forceDownloadService:t.forceDownloadService},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agents","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentsIntegrationsHrisQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agents/integrations/hris/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentsMePossibleworkshifts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/me/possibleworkshifts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentschedulesMine(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agentschedules/mine","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitActivitycodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query","POST",{businessUnitId:e},{forceAsync:t.forceAsync,forceDownloadService:t.forceDownloadService},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitAgentschedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search","POST",{businessUnitId:e},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitIntraday(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday","POST",{businessUnitId:e},{forceAsync:i.forceAsync},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitPlanninggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitServicegoaltemplates(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitStaffinggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitStaffinggroupsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query","POST",{businessUnitId:e,weekId:i,scheduleId:t},{forceAsync:a.forceAsync,forceDownloadService:a.forceDownloadService},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleCopy(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleReschedule(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleUpdate(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedules(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedules';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesGenerate(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy","POST",{businessUnitId:e,weekDateId:i,forecastId:t},{forceAsync:a.forceAsync},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate","POST",{businessUnitId:e,weekDateId:i},{forceAsync:n.forceAsync},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import","POST",{businessUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl","POST",{businessUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementCalendarUrlIcs(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","POST",{},{language:e.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/deletejob","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementHistoricaldataValidate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/validate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementIntegrationsHriTimeofftypesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs","POST",{hrisIntegrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitAgentschedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search","POST",{managementUnitId:e},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitHistoricaladherencequery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitMove(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitMove';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/move","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitSchedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitSchedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitShrinkageJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequests(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequests';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query","POST",{managementUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs","POST",{managementUnitId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs","POST",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate","POST",{managementUnitId:e,userId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradeMatch(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===t||null===t)throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match","POST",{managementUnitId:e,weekDateId:i,tradeId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttrades(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades","POST",{managementUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradesSearch(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search","POST",{managementUnitId:e,weekDateId:i},{forceDownloadService:n.forceDownloadService},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradesStateBulk(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk","POST",{managementUnitId:e,weekDateId:i},{forceAsync:n.forceAsync},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanCopy(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy","POST",{managementUnitId:e,workPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanValidate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate","POST",{managementUnitId:e,workPlanId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanrotationCopy(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy","POST",{managementUnitId:e,workPlanRotationId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanrotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans","POST",{managementUnitId:e},{validationMode:i.validationMode},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementNotificationsUpdate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/notifications/update","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementSchedules(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/schedules","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTeamAdherenceHistorical(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';return this.apiClient.callApi("/api/v2/workforcemanagement/teams/{teamId}/adherence/historical","POST",{teamId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTeamShrinkageJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs","POST",{teamId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffbalanceJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffbalance/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeofflimitsAvailableQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeofflimits/available/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequests(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequestsEstimate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/estimate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementAgentIntegrationsHris(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/integrations/hris","PUT",{agentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementBusinessunitTimeofflimitValues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values","PUT",{businessUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementManagementunitTimeofflimitValues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values","PUT",{managementUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}}return new class{constructor(){this.ApiClient=new d,this.ApiClientClass=d,this.AlertingApi=c,this.AnalyticsApi=g,this.ArchitectApi=h,this.AuditApi=m,this.AuthorizationApi=v,this.BillingApi=w,this.CarrierServicesApi=C,this.ChatApi=I,this.CoachingApi=f,this.ContentManagementApi=A,this.ConversationsApi=b,this.DataExtensionsApi=j,this.DownloadsApi=P,this.EmailsApi=y,this.EventsApi=O,this.ExternalContactsApi=M,this.FaxApi=T,this.FlowsApi=q,this.GamificationApi=S,this.GeneralDataProtectionRegulationApi=k,this.GeolocationApi=E,this.GreetingsApi=G,this.GroupsApi=U,this.IdentityProviderApi=D,this.InfrastructureAsCodeApi=R,this.IntegrationsApi=x,this.JourneyApi=z,this.KnowledgeApi=W,this.LanguageUnderstandingApi=B,this.LanguagesApi=L,this.LearningApi=N,this.LicenseApi=K,this.LocationsApi=J,this.LogCaptureApi=V,this.MessagingApi=F,this.MobileDevicesApi=Q,this.NotificationsApi=_,this.OAuthApi=H,this.ObjectsApi=$,this.OperationalEventsApi=Z,this.OrganizationApi=X,this.OrganizationAuthorizationApi=Y,this.OutboundApi=ee,this.PresenceApi=ie,this.ProcessAutomationApi=te,this.QualityApi=ne,this.RecordingApi=ae,this.ResponseManagementApi=oe,this.RoutingApi=re,this.SCIMApi=le,this.ScreenRecordingApi=se,this.ScriptsApi=pe,this.SearchApi=ue,this.SettingsApi=de,this.SpeechTextAnalyticsApi=ce,this.StationsApi=ge,this.SuggestApi=he,this.TaskManagementApi=me,this.TeamsApi=ve,this.TelephonyApi=we,this.TelephonyProvidersEdgeApi=Ce,this.TextbotsApi=Ie,this.TokensApi=fe,this.UploadsApi=Ae,this.UsageApi=be,this.UserRecordingsApi=je,this.UsersApi=Pe,this.UtilitiesApi=ye,this.VoicemailApi=Oe,this.WebChatApi=Me,this.WebDeploymentsApi=Te,this.WebMessagingApi=qe,this.WidgetsApi=Se,this.WorkforceManagementApi=ke,this.PureCloudRegionHosts=o}}}); \ No newline at end of file +define(["axios","qs"],function(e,i){"use strict";function t(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var n=t(e),a=t(i),o={us_east_1:"mypurecloud.com",eu_west_1:"mypurecloud.ie",ap_southeast_2:"mypurecloud.com.au",ap_northeast_1:"mypurecloud.jp",eu_central_1:"mypurecloud.de",us_west_2:"usw2.pure.cloud",ca_central_1:"cac1.pure.cloud",ap_northeast_2:"apne2.pure.cloud",eu_west_2:"euw2.pure.cloud",ap_south_1:"aps1.pure.cloud",us_east_2:"use2.us-gov-pure.cloud",sa_east_1:"sae1.pure.cloud",me_central_1:"mec1.pure.cloud",ap_northeast_3:"apne3.pure.cloud",eu_central_2:"euc2.pure.cloud"};const r={levels:{none:0,error:1,debug:2,trace:3}},l={level:{LNone:"none",LError:"error",LDebug:"debug",LTrace:"trace"}},s={formats:{JSON:"json",TEXT:"text"}};class p{get logLevelEnum(){return l}get logFormatEnum(){return s}constructor(){this.log_level=l.level.LNone,this.log_format=s.formats.TEXT,this.log_to_console=!0,this.log_file_path,this.log_response_body=!1,this.log_request_body=!1,this.setLogger()}setLogger(){if("undefined"==typeof window){const e=require("winston");this.logger=e.createLogger({levels:r.levels,level:this.log_level}),this.log_file_path&&""!==this.log_file_path&&(this.log_format===s.formats.JSON?this.logger.add(new e.transports.File({format:e.format.json(),filename:this.log_file_path})):this.logger.add(new e.transports.File({format:e.format.combine(e.format(e=>(e.level=e.level.toUpperCase(),e))(),e.format.simple()),filename:this.log_file_path}))),this.log_to_console&&(this.log_format===s.formats.JSON?this.logger.add(new e.transports.Console({format:e.format.json()})):this.logger.add(new e.transports.Console({format:e.format.combine(e.format(e=>(e.level=e.level.toUpperCase(),e))(),e.format.simple())})))}}log(e,i,t,n,a,o,r,l){var s=this.formatLog(e,i,t,n,a,o,r,l);"undefined"!=typeof window?this.calculateLogLevel(e)>0&&!0===this.log_to_console&&(this.log_format===this.logFormatEnum.formats.JSON?console.log(s):console.log(`${e.toUpperCase()}: ${s}`)):this.logger.transports.length>0&&this.logger.log(e,s)}calculateLogLevel(e){switch(this.log_level){case this.logLevelEnum.level.LError:return e!==this.logLevelEnum.level.LError?-1:1;case this.logLevelEnum.level.LDebug:return e===this.logLevelEnum.level.LTrace?-1:1;case this.logLevelEnum.level.LTrace:return 1;default:return-1}}formatLog(e,i,t,n,a,o,r,l){var p,u=a?JSON.parse(JSON.stringify(a)):null,d=o?JSON.parse(JSON.stringify(o)):null,c=r?JSON.parse(JSON.stringify(r)):null,g=l?JSON.parse(JSON.stringify(l)):null;return a&&(u.Authorization="[REDACTED]"),this.log_request_body||(c=void 0),this.log_response_body||(g=void 0),this.log_format&&this.log_format===s.formats.JSON?(p={level:e,date:(new Date).toISOString(),method:t,url:decodeURIComponent(n),correlationId:d&&d["inin-correlation-id"]?d["inin-correlation-id"]:"",statusCode:i},u&&(p.requestHeaders=u),d&&(p.responseHeaders=d),c&&(p.requestBody=c),g&&(p.responseBody=g)):p=`${(new Date).toISOString()}\n=== REQUEST === \n${this.formatValue("URL",decodeURIComponent(n))}${this.formatValue("Method",t)}${this.formatValue("Headers",this.formatHeaderString(u))}${this.formatValue("Body",c?JSON.stringify(c,null,2):"")}\n=== RESPONSE ===\n${this.formatValue("Status",i)}${this.formatValue("Headers",this.formatHeaderString(d))}${this.formatValue("CorrelationId",d&&d["inin-correlation-id"]?d["inin-correlation-id"]:"")}${this.formatValue("Body",g?JSON.stringify(g,null,2):"")}`,p}formatHeaderString(e){var i="";if(!e)return i;for(const[t,n]of Object.entries(e))i+=`\n\t${t}: ${n}`;return i}formatValue(e,i){return i&&""!==i&&"{}"!==i?`${e}: ${i}\n`:""}getLogLevel(e){switch(e){case"error":return l.level.LError;case"debug":return l.level.LDebug;case"trace":return l.level.LTrace;default:return l.level.LNone}}getLogFormat(e){switch(e){case"json":return s.formats.JSON;default:return s.formats.TEXT}}}class u{get instance(){return u.instance}set instance(e){u.instance=e}constructor(){if(u.instance||(u.instance=this),"undefined"!=typeof window)this.configPath="";else{const e=require("os"),i=require("path");this.configPath=i.join(e.homedir(),".genesyscloudjavascript","config")}this.refresh_access_token=!0,this.refresh_token_wait_max=10,this.live_reload_config=!0,this.host,this.environment,this.basePath,this.authUrl,this.config,this.logger=new p,this.setEnvironment(),this.liveLoadConfig()}liveLoadConfig(){if("undefined"!=typeof window)this.configPath="";else if(this.updateConfigFromFile(),this.live_reload_config&&!0===this.live_reload_config)try{const e=require("fs");e.watchFile(this.configPath,{persistent:!1},(i,t)=>{this.updateConfigFromFile(),this.live_reload_config||e.unwatchFile(this.configPath)})}catch(e){}}setConfigPath(e){e&&e!==this.configPath&&(this.configPath=e,this.liveLoadConfig())}updateConfigFromFile(){if("undefined"==typeof window){const t=require("configparser");try{var e=new t;e.read(this.configPath),this.config=e}catch(e){if(e.name&&"MissingSectionHeaderError"===e.name){var i=require("fs").readFileSync(this.configPath,"utf8");this.config={_sections:JSON.parse(i)}}}this.config&&this.updateConfigValues()}}updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString("logging","log_level")),this.logger.log_format=this.logger.getLogFormat(this.getConfigString("logging","log_format")),this.logger.log_to_console=void 0!==this.getConfigBoolean("logging","log_to_console")?this.getConfigBoolean("logging","log_to_console"):this.logger.log_to_console,this.logger.log_file_path=void 0!==this.getConfigString("logging","log_file_path")?this.getConfigString("logging","log_file_path"):this.logger.log_file_path,this.logger.log_response_body=void 0!==this.getConfigBoolean("logging","log_response_body")?this.getConfigBoolean("logging","log_response_body"):this.logger.log_response_body,this.logger.log_request_body=void 0!==this.getConfigBoolean("logging","log_request_body")?this.getConfigBoolean("logging","log_request_body"):this.logger.log_request_body,this.refresh_access_token=void 0!==this.getConfigBoolean("reauthentication","refresh_access_token")?this.getConfigBoolean("reauthentication","refresh_access_token"):this.refresh_access_token,this.refresh_token_wait_max=void 0!==this.getConfigInt("reauthentication","refresh_token_wait_max")?this.getConfigInt("reauthentication","refresh_token_wait_max"):this.refresh_token_wait_max,this.live_reload_config=void 0!==this.getConfigBoolean("general","live_reload_config")?this.getConfigBoolean("general","live_reload_config"):this.live_reload_config,this.host=void 0!==this.getConfigString("general","host")?this.getConfigString("general","host"):this.host,this.setEnvironment(),this.logger.setLogger()}setEnvironment(e){this.environment=e||(this.host?this.host:"mypurecloud.com"),this.environment=this.environment.replace(/\/+$/,""),this.environment.startsWith("https://")&&(this.environment=this.environment.substring(8)),this.environment.startsWith("http://")&&(this.environment=this.environment.substring(7)),this.environment.startsWith("api.")&&(this.environment=this.environment.substring(4)),this.basePath=`https://api.${this.environment}`,this.authUrl=`https://login.${this.environment}`}getConfigString(e,i){if(this.config._sections[e])return this.config._sections[e][i]}getConfigBoolean(e,i){if(this.config._sections[e]&&void 0!==this.config._sections[e][i])return"string"==typeof this.config._sections[e][i]?"true"===this.config._sections[e][i]:this.config._sections[e][i]}getConfigInt(e,i){if(this.config._sections[e]&&this.config._sections[e][i])return"string"==typeof this.config._sections[e][i]?parseInt(this.config._sections[e][i]):this.config._sections[e][i]}}class d{get instance(){return d.instance}set instance(e){d.instance=e}constructor(){d.instance||(d.instance=this),this.CollectionFormatEnum={CSV:",",SSV:" ",TSV:"\t",PIPES:"|",MULTI:"multi"};try{localStorage.setItem("purecloud_local_storage_test","purecloud_local_storage_test"),localStorage.removeItem("purecloud_local_storage_test"),this.hasLocalStorage=!0}catch(e){this.hasLocalStorage=!1}this.authentications={"Guest Chat JWT":{type:"apiKey",in:"header",name:"Authorization"},"PureCloud OAuth":{type:"oauth2"}},this.defaultHeaders={},this.timeout=16e3,this.authData={},this.settingsPrefix="purecloud",this.refreshInProgress=!1,this.config=new u,"undefined"!=typeof window&&(window.ApiClient=this)}setReturnExtendedResponses(e){this.returnExtended=e}setPersistSettings(e,i){this.persistSettings=e,this.settingsPrefix=i?i.replace(/\W+/g,"_"):"purecloud"}_saveSettings(e){try{if(this.authData.accessToken=e.accessToken,this.authentications["PureCloud OAuth"].accessToken=e.accessToken,e.state&&(this.authData.state=e.state),this.authData.error=e.error,this.authData.error_description=e.error_description,e.tokenExpiryTime&&(this.authData.tokenExpiryTime=e.tokenExpiryTime,this.authData.tokenExpiryTimeString=e.tokenExpiryTimeString),!0!==this.persistSettings)return;if(!this.hasLocalStorage)return;let i=JSON.parse(JSON.stringify(this.authData));delete i.state,localStorage.setItem(`${this.settingsPrefix}_auth_data`,JSON.stringify(i))}catch(e){console.error(e)}}_loadSettings(){if(!0!==this.persistSettings)return;if(!this.hasLocalStorage)return;const e=this.authData.state;this.authData=localStorage.getItem(`${this.settingsPrefix}_auth_data`),this.authData?this.authData=JSON.parse(this.authData):this.authData={},this.authData.accessToken&&this.setAccessToken(this.authData.accessToken),this.authData.state=e}setEnvironment(e){this.config.setEnvironment(e)}loginImplicitGrant(e,i,t){const n=this._setValuesFromUrlHash();return this.clientId=e,this.redirectUri=i,t||(t={}),new Promise((e,i)=>{if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),n&&n.error)return n.accessToken=void 0,this._saveSettings(n),i(new Error(`[${n.error}] ${n.error_description}`));this._testTokenAccess().then(()=>{!this.authData.state&&t.state&&(this.authData.state=t.state),e(this.authData)}).catch(e=>{var i={client_id:encodeURIComponent(this.clientId),redirect_uri:encodeURIComponent(this.redirectUri),response_type:"token"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=this._buildAuthUrl("oauth/authorize",i);window.location.replace(n)})})}loginClientCredentialsGrant(e,i){this.clientId=e;var t=Buffer.from(`${e}:${i}`).toString("base64");return new Promise((e,i)=>{if("undefined"!=typeof window)return void i(new Error("The client credentials grant is not supported in a browser."));const a={Authorization:`Basic ${t}`};n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:a,data:"grant_type=client_credentials",httpsAgent:this.proxyAgent}).then(i=>{this.config.logger.log("trace",i.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,i.headers,{grant_type:"client_credentials"},void 0),this.config.logger.log("debug",i.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,void 0,{grant_type:"client_credentials"},void 0),this.setAccessToken(i.data.access_token),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*i.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),e(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,a,e.response.headers,{grant_type:"client_credentials"},e.response.data),i(e)})})}loginSaml2BearerGrant(e,i,t,n){return this.clientId=e,new Promise((a,o)=>{if("undefined"==typeof window){var r=Buffer.from(e+":"+i).toString("base64"),l=this._formAuthRequest(r,{grant_type:"urn:ietf:params:oauth:grant-type:saml2-bearer",orgName:t,assertion:n});l.proxy=this.proxy;var s={grant_type:"urn:ietf:params:oauth:grant-type:saml2-bearer",orgName:t,assertion:n};l.then(e=>{this.config.logger.log("trace",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,e.headers,s,void 0),this.config.logger.log("debug",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,void 0,s,void 0);var i=e.data.access_token;this.setAccessToken(i),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*e.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),a(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,l.headers,e.response.headers,s,e.response.data),o(e)})}else o(new Error("The saml2bearer grant is not supported in a browser."))})}authorizePKCEGrant(e,i,t,o){return this.clientId=e,new Promise((r,l)=>{var s=n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:{"Content-Type":"application/x-www-form-urlencoded"},data:a.default.stringify({grant_type:"authorization_code",code:t,code_verifier:i,client_id:e,redirect_uri:o})});s.proxy=this.proxy;var p={grant_type:"authorization_code",code:t,code_verifier:i,client_id:e,redirect_uri:o};s.then(e=>{this.config.logger.log("trace",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,e.headers,p,void 0),this.config.logger.log("debug",e.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,void 0,p,void 0);var i=e.data.access_token;this.setAccessToken(i),this.authData.tokenExpiryTime=(new Date).getTime()+1e3*e.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),r(this.authData)}).catch(e=>{e.response&&this.config.logger.log("error",e.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,s.headers,e.response.headers,p,e.response.data),l(e)})})}generatePKCECodeVerifier(e){if(e<43||e>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");if("undefined"!=typeof window){const i="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(crypto.getRandomValues(new Uint32Array(e))).map(e=>i[e%i.length]).join("")}try{const i=require("crypto").getRandomValues,t="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(i(new Uint32Array(e))).map(e=>t[e%t.length]).join("")}catch(e){throw new Error("Crypto module is missing/not supported.")}}computePKCECodeChallenge(e){if(e.length<43||e.length>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");if("undefined"!=typeof window){const i=(new TextEncoder).encode(e);return new Promise((e,t)=>{window.crypto.subtle.digest("SHA-256",i).then(i=>{let t=Buffer.from(i).toString("base64").replaceAll("+","-").replaceAll("/","_");t=t.split("=")[0],e(t)}).catch(e=>t(new Error(`Code Challenge Error ${e}`)))})}try{const i=require("crypto").createHash,t=(new TextEncoder).encode(e);return new Promise((e,n)=>{const a=i("sha256").update(t).digest();e(Buffer.from(a).toString("base64url"))})}catch(e){throw new Error("Crypto module is missing/not supported.")}}loginPKCEGrant(e,i,t,n){if(!this.hasLocalStorage&&!n)throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");const a=this._setValuesFromUrlQuery();return this.clientId=e,this.redirectUri=i,this.codeVerifier=n,t||(t={}),new Promise((e,i)=>{if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),a&&a.error)return this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),this._saveSettings({accessToken:void 0}),i(new Error(`[${a.error}] ${a.error_description}`));a&&a.code?(this.codeVerifier||this.hasLocalStorage&&(this.codeVerifier=sessionStorage.getItem("genesys_cloud_sdk_pkce_code_verifier")),this.authorizePKCEGrant(this.clientId,this.codeVerifier,a.code,this.redirectUri).then(()=>{this._testTokenAccess().then(()=>{!this.authData.state&&a.state&&(this.authData.state=a.state),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),e(this.authData)}).catch(e=>(this._saveSettings({accessToken:void 0}),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error(`[${e.name}] ${e.msg}`))))}).catch(e=>(this._saveSettings({accessToken:void 0}),this.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error(`[${e.name}] ${e.msg}`))))):this._testTokenAccess().then(()=>{!this.authData.state&&t.state&&(this.authData.state=t.state),e(this.authData)}).catch(e=>{this.codeVerifier||(this.codeVerifier=this.generatePKCECodeVerifier(128),this.hasLocalStorage&&sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",this.codeVerifier)),this.computePKCECodeChallenge(this.codeVerifier).then(e=>{var i={client_id:encodeURIComponent(this.clientId),redirect_uri:encodeURIComponent(this.redirectUri),code_challenge:encodeURIComponent(e),response_type:"code",code_challenge_method:"S256"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=this._buildAuthUrl("oauth/authorize",i);window.location.replace(n)}).catch(e=>i(new Error(`[${e.name}]`)))})})}_setValuesFromUrlQuery(){if("undefined"==typeof window||!window.location.search)return;let e={},i=new URLSearchParams(window.location.search),t=i.get("code"),n=i.get("error"),a=i.get("error_description"),o=i.get("state");if(n)return e.error=n,a&&(e.error_description=a),e;t&&(e.code=t,o&&(e.state=o));var r,l,s=window.location;return"replaceState"in history?history.replaceState("",document.title,s.pathname):(r=document.body.scrollTop,l=document.body.scrollLeft,history.pushState("",document.title,s.pathname),document.body.scrollTop=r,document.body.scrollLeft=l),e}loginCodeAuthorizationGrant(e,i,t,n){return this.clientId=e,this.clientSecret=i,new Promise((a,o)=>{if("undefined"==typeof window){var r=Buffer.from(e+":"+i).toString("base64"),l=this._formAuthRequest(r,{grant_type:"authorization_code",code:t,redirect_uri:n});l.proxy=this.proxy;var s={grant_type:"authorization_code",code:t,redirect_uri:n};this._handleCodeAuthorizationResponse(l,s,a,o)}else o(new Error("The Code Authorization grant is not supported in a browser."))})}refreshCodeAuthorizationGrant(e,i,t){return new Promise((n,a)=>{if("undefined"==typeof window){var o=Buffer.from(e+":"+i).toString("base64"),r=this._formAuthRequest(o,{grant_type:"refresh_token",refresh_token:t});r.proxy=this.proxy;var l={grant_type:"refresh_token",refresh_token:t};this._handleCodeAuthorizationResponse(r,l,n,a)}else a(new Error("The Code Authorization grant is not supported in a browser."))})}_handleCodeAuthorizationResponse(e,i,t,n){e.then(n=>{this.config.logger.log("trace",n.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,n.headers,i,void 0),this.config.logger.log("debug",n.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,void 0,i,void 0);var a=n.data.access_token,o=n.data.refresh_token;this.setAccessToken(a),this.authData.refreshToken=o,this.authData.tokenExpiryTime=(new Date).getTime()+1e3*n.data.expires_in,this.authData.tokenExpiryTimeString=new Date(this.authData.tokenExpiryTime).toUTCString(),t(this.authData)}).catch(t=>{t.response&&this.config.logger.log("error",t.response.status,"POST",`https://login.${this.config.environment}/oauth/token`,e.headers,t.response.headers,i,t.response.data),n(t)})}_formAuthRequest(e,i){return n.default({method:"POST",url:`https://login.${this.config.environment}/oauth/token`,headers:{Authorization:"Basic "+e,"Content-Type":"application/x-www-form-urlencoded"},data:a.default.stringify(i)})}_handleExpiredAccessToken(){return new Promise((e,i)=>{"undefined"==typeof window?this.refreshInProgress?this._sleep(this.config.refresh_token_wait_max).then(()=>{this.refreshInProgress?i(new Error(`Token refresh took longer than ${this.config.refresh_token_wait_max} seconds`)):e()}):(this.refreshInProgress=!0,this.refreshCodeAuthorizationGrant(this.clientId,this.clientSecret,this.authData.refreshToken).then(()=>{this.refreshInProgress=!1,e()}).catch(e=>{this.refreshInProgress=!1,i(e)})):i(new Error("This method is not supported in a browser."))})}_sleep(e){return new Promise(i=>setTimeout(i,e))}_testTokenAccess(){return new Promise((e,i)=>{this._loadSettings(),this.authentications["PureCloud OAuth"].accessToken?this.callApi("/api/v2/tokens/me","GET",null,null,null,null,null,["PureCloud OAuth"],["application/json"],["application/json"]).then(()=>{e()}).catch(e=>{this._saveSettings({accessToken:void 0}),i(e)}):i(new Error("Token is not set"))})}_setValuesFromUrlHash(){if("undefined"==typeof window||!window.location.hash)return;const e=new RegExp("^#*(.+?)=(.+?)$","i");let i={};if(window.location.hash.split("&").forEach(t=>{const n=e.exec(t);n&&(i[n[1]]=decodeURIComponent(decodeURIComponent(n[2].replace(/\+/g,"%20"))))}),i.error)return i;if(i.access_token){let e={};i.state&&(e.state=i.state),i.expires_in&&(e.tokenExpiryTime=(new Date).getTime()+1e3*parseInt(i.expires_in.replace(/\+/g,"%20")),e.tokenExpiryTimeString=new Date(e.tokenExpiryTime).toUTCString()),e.accessToken=i.access_token.replace(/\+/g,"%20");var t,n,a=window.location;"replaceState"in history?history.replaceState("",document.title,a.pathname+a.search):(t=document.body.scrollTop,n=document.body.scrollLeft,a.hash="",document.body.scrollTop=t,document.body.scrollLeft=n),this._saveSettings(e)}}setAccessToken(e){this._saveSettings({accessToken:e})}setStorageKey(e){this.storageKey=e,this.setAccessToken(this.authentications["PureCloud OAuth"].accessToken)}logout(e){this.hasLocalStorage&&this._saveSettings({accessToken:void 0,state:void 0,tokenExpiryTime:void 0,tokenExpiryTimeString:void 0});var i={client_id:encodeURIComponent(this.clientId)};e&&(i.redirect_uri=encodeURI(e));var t=this._buildAuthUrl("logout",i);window.location.replace(t)}_buildAuthUrl(e,i){return i||(i={}),Object.keys(i).reduce((e,t)=>i[t]?`${e}&${t}=${i[t]}`:e,`${this.config.authUrl}/${e}?`)}paramToString(e){return e?e instanceof Date?e.toJSON():e instanceof Boolean?e.toString().toLowerCase():e.toString():""}serialize(e){var i={};for(var t in e)e.hasOwnProperty(t)&&void 0!==e[t]&&(i[encodeURIComponent(t)]=Array.isArray(e[t])?e[t].join(","):this.paramToString(e[t]));return i}addHeaders(e,...i){return e=e?Object.assign(e,...i):Object.assign(...i)}buildUrl(e,i){e.match(/^\//)||(e=`/${e}`);var t=this.config.basePath+e;return t=t.replace(/\{([\w-]+)\}/g,(e,t)=>{var n;return n=i.hasOwnProperty(t)?this.paramToString(i[t]):e,encodeURIComponent(n)})}isJsonMime(e){return Boolean(e&&e.match(/^application\/json(;.*)?$/i))}jsonPreferredMime(e){for(var i=0;i{var t=this.authentications[i];switch(t.type){case"basic":(t.username||t.password)&&(e.auth={username:t.username||"",password:t.password||""});break;case"apiKey":if(t.apiKey){var n={};t.apiKeyPrefix?n[t.name]=`${t.apiKeyPrefix} ${t.apiKey}`:n[t.name]=t.apiKey,"header"===t.in?e.headers=this.addHeaders(e.headers,n):e.params=this.serialize(n)}break;case"oauth2":t.accessToken&&(e.headers=this.addHeaders(e.headers,{Authorization:`Bearer ${t.accessToken}`}));break;default:throw new Error(`Unknown authentication type: ${t.type}`)}})}setProxyAgent(e){this.proxyAgent=e}callApi(e,i,t,a,o,r,l,s,p,u){return new Promise((d,c)=>{!function g(h){var m=h.buildUrl(e,t);var v={method:i,url:m,httpsAgent:h.proxyAgent,timeout:h.timeout,params:h.serialize(a)};h.applyAuthToRequest(v,s);const w=h.defaultHeaders;const C=h.normalizeParams(o);v.headers=h.addHeaders(v.headers,w,C);var I=h.jsonPreferredMime(p);I?v.headers["Content-Type"]=I:v.headers["Content-Type"]||(v.headers["Content-Type"]="application/json");if("application/x-www-form-urlencoded"===I)v.data=h.normalizeParams(r);else if("multipart/form-data"==I){var f=h.normalizeParams(r);for(var A in f)if(f.hasOwnProperty(A)){var b=new FormData;b.set(A,f[A]),v.data=b}}else l&&(v.data=l);var j=h.jsonPreferredMime(u);j&&(v.headers.Accept=j);n.default.request(v).then(e=>{var t=!0===h.returnExtended?{status:e.status,statusText:e.statusText,headers:e.headers,body:e.data,text:e.text,error:null}:e.data?e.data:e.text;h.config.logger.log("trace",e.status,i,m,v.headers,e.headers,l,void 0),h.config.logger.log("debug",e.status,i,m,v.headers,void 0,l,void 0),d(t)}).catch(e=>{var t=e;e.response&&401==e.response.status&&h.config.refresh_access_token&&""!==h.authData.refreshToken?h._handleExpiredAccessToken().then(()=>{g(h)}).catch(e=>{c(e)}):e.response&&(h.config.logger.log("error",e.response.status,i,m,v.headers,e.response.headers,l,e.response.data),t=!0===h.returnExtended?{status:e.response.status,statusText:e.response.statusText,headers:e.response.headers,body:e.response.data,text:e.response.text,error:e}:e.response.data?e.response.data:e.response.text),c(t)})}(this)})}}class c{constructor(e){this.apiClient=e||d.instance}deleteAlertingAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling deleteAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","DELETE",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingInteractionstatsAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","DELETE",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingInteractionstatsRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","DELETE",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAlertingRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling deleteAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","DELETE",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingAlert(e){if(void 0===e||null===e)throw'Missing the required parameter "alertId" when calling getAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","GET",{alertId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingAlertsActive(){return this.apiClient.callApi("/api/v2/alerting/alerts/active","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","GET",{alertId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlerts(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/unread","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsRule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","GET",{ruleId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingInteractionstatsRules(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/interactionstats/rules","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAlertingRule(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling getAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","GET",{ruleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling patchAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","PATCH",{alertId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingAlertsBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAlertingAlertsBulk';return this.apiClient.callApi("/api/v2/alerting/alerts/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchAlertingRulesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAlertingRulesBulk';return this.apiClient.callApi("/api/v2/alerting/rules/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingAlertsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/alerts/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingInteractionstatsRules(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingRules';return this.apiClient.callApi("/api/v2/alerting/rules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRulesBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';return this.apiClient.callApi("/api/v2/alerting/rules/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAlertingRulesQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/alerting/rules/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingAlert(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling putAlertingAlert';return this.apiClient.callApi("/api/v2/alerting/alerts/{alertId}","PUT",{alertId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingInteractionstatsAlert(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';return this.apiClient.callApi("/api/v2/alerting/interactionstats/alerts/{alertId}","PUT",{alertId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingInteractionstatsRule(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';return this.apiClient.callApi("/api/v2/alerting/interactionstats/rules/{ruleId}","PUT",{ruleId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAlertingRule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ruleId" when calling putAlertingRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAlertingRule';return this.apiClient.callApi("/api/v2/alerting/rules/{ruleId}","PUT",{ruleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class g{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsActionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsActionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsAgentcopilotsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsAgentcopilotsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowDivisionsReportingturns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,actionId:i.actionId,sessionId:i.sessionId,language:i.language,askActionResults:i.askActionResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowReportingturns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowReportingturns';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/reportingturns","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,actionId:i.actionId,sessionId:i.sessionId,language:i.language,askActionResults:i.askActionResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotflowSessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowSessions';return this.apiClient.callApi("/api/v2/analytics/botflows/{botFlowId}/sessions","GET",{botFlowId:e},{after:i.after,pageSize:i.pageSize,interval:i.interval,botResultCategories:i.botResultCategories,endLanguage:i.endLanguage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsBotsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getAnalyticsConversationDetails';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetails(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/conversations/details","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsDataretentionSettings(){return this.apiClient.callApi("/api/v2/analytics/dataretention/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowexecutionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowexecutionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsKnowledgeAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsKnowledgeAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingDashboardsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';return this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingDashboardsUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users","GET",{},{sortBy:e.sortBy,pageNumber:e.pageNumber,pageSize:e.pageSize,id:this.apiClient.buildCollectionParam(e.id,"multi"),state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingExports(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/reporting/exports","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingExportsMetadata(){return this.apiClient.callApi("/api/v2/analytics/reporting/exports/metadata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingSettings(){return this.apiClient.callApi("/api/v2/analytics/reporting/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingSettingsDashboardsQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';if(void 0===i||null===i)throw'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/dashboards/query","GET",{},{dashboardType:e,dashboardAccessFilter:i,sortBy:t.sortBy,pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsReportingSettingsUserDashboards(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/users/{userId}/dashboards","GET",{userId:e},{sortBy:i.sortBy,pageNumber:i.pageNumber,pageSize:i.pageSize,publicOnly:i.publicOnly,favoriteOnly:i.favoriteOnly,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsResolutionsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsResolutionsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTaskmanagementAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTaskmanagementAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTranscriptsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsTranscriptsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAnalyticsReportingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';return this.apiClient.callApi("/api/v2/analytics/reporting/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsActionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsActionsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/actions/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsAgentcopilotsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/agentcopilots/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsAgentcopilotsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/agentcopilots/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsBotsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsBotsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/bots/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationDetailsProperties(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details/properties","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsTranscriptsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/transcripts/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowexecutionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowexecutionsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flowexecutions/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/flows/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/flows/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsKnowledgeAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsKnowledgeAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/knowledge/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsQueuesObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/queues/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRatelimitsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/ratelimits/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingDashboardsUsersBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';return this.apiClient.callApi("/api/v2/analytics/reporting/dashboards/users/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingExports(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';return this.apiClient.callApi("/api/v2/analytics/reporting/exports","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingSettingsDashboardsBulkRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/dashboards/bulk/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsReportingSettingsDashboardsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';return this.apiClient.callApi("/api/v2/analytics/reporting/settings/dashboards/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsResolutionsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/resolutions/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRoutingActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';return this.apiClient.callApi("/api/v2/analytics/routing/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTaskmanagementAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTaskmanagementAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/taskmanagement/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTeamsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTeamsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/teams/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTranscriptsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTranscriptsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/transcripts/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersActivityQuery';return this.apiClient.callApi("/api/v2/analytics/users/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/users/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/users/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putAnalyticsDataretentionSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';return this.apiClient.callApi("/api/v2/analytics/dataretention/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class h{constructor(e){this.apiClient=e||d.instance}deleteArchitectEmergencygroup(e){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling deleteArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","DELETE",{emergencyGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammar(e){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","DELETE",{grammarId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguageFilesDtmf(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectGrammarLanguageFilesVoice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice","DELETE",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectIvr(e){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling deleteArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","DELETE",{ivrId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPrompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","DELETE",{promptId:e},{allResources:i.allResources},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPromptResourceAudio(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectPromptResourceAudio';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectPromptResourceAudio';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectPrompts(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteArchitectPrompts';return this.apiClient.callApi("/api/v2/architect/prompts","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSchedule(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling deleteArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","DELETE",{scheduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSchedulegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling deleteArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","DELETE",{scheduleGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteArchitectSystempromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling deleteArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","DELETE",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlow(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling deleteFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","DELETE",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowInstancesSettingsLoglevels(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling deleteFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","DELETE",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlows(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteFlows';return this.apiClient.callApi("/api/v2/flows","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsDatatable(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling deleteFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","DELETE",{datatableId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsDatatableRow(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling deleteFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling deleteFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","DELETE",{datatableId:e,rowId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsInstancesSettingsLoglevelsDefault(){return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteFlowsMilestone(e){if(void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling deleteFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","DELETE",{milestoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytracking(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "name" when calling getArchitectDependencytracking';return this.apiClient.callApi("/api/v2/architect/dependencytracking","GET",{},{pageNumber:i.pageNumber,pageSize:i.pageSize,name:e,objectType:this.apiClient.buildCollectionParam(i.objectType,"multi"),consumedResources:i.consumedResources,consumingResources:i.consumingResources,consumedResourceType:this.apiClient.buildCollectionParam(i.consumedResourceType,"multi"),consumingResourceType:this.apiClient.buildCollectionParam(i.consumingResourceType,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingBuild(){return this.apiClient.callApi("/api/v2/architect/dependencytracking/build","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingConsumedresources(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingConsumedresources';if(void 0===i||null===i)throw'Missing the required parameter "version" when calling getArchitectDependencytrackingConsumedresources';if(void 0===t||null===t)throw'Missing the required parameter "objectType" when calling getArchitectDependencytrackingConsumedresources';return this.apiClient.callApi("/api/v2/architect/dependencytracking/consumedresources","GET",{},{id:e,version:i,objectType:t,resourceType:this.apiClient.buildCollectionParam(n.resourceType,"multi"),pageNumber:n.pageNumber,pageSize:n.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingConsumingresources(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingConsumingresources';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling getArchitectDependencytrackingConsumingresources';return this.apiClient.callApi("/api/v2/architect/dependencytracking/consumingresources","GET",{},{id:e,objectType:i,resourceType:this.apiClient.buildCollectionParam(t.resourceType,"multi"),version:t.version,pageNumber:t.pageNumber,pageSize:t.pageSize,flowFilter:t.flowFilter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingDeletedresourceconsumers(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/deletedresourceconsumers","GET",{},{name:e.name,objectType:this.apiClient.buildCollectionParam(e.objectType,"multi"),flowFilter:e.flowFilter,consumedResources:e.consumedResources,consumedResourceType:this.apiClient.buildCollectionParam(e.consumedResourceType,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingObject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "id" when calling getArchitectDependencytrackingObject';return this.apiClient.callApi("/api/v2/architect/dependencytracking/object","GET",{},{id:e,version:i.version,objectType:i.objectType,consumedResources:i.consumedResources,consumingResources:i.consumingResources,consumedResourceType:this.apiClient.buildCollectionParam(i.consumedResourceType,"multi"),consumingResourceType:this.apiClient.buildCollectionParam(i.consumingResourceType,"multi"),consumedResourceRequest:i.consumedResourceRequest},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingType(e){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getArchitectDependencytrackingType';return this.apiClient.callApi("/api/v2/architect/dependencytracking/types/{typeId}","GET",{typeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingTypes(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/types","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectDependencytrackingUpdatedresourceconsumers(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/dependencytracking/updatedresourceconsumers","GET",{},{name:e.name,objectType:this.apiClient.buildCollectionParam(e.objectType,"multi"),consumedResources:e.consumedResources,consumedResourceType:this.apiClient.buildCollectionParam(e.consumedResourceType,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroup(e){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling getArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","GET",{emergencyGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroups(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/emergencygroups","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectEmergencygroupsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/emergencygroups/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammar(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling getArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","GET",{grammarId:e},{includeFileUrls:i.includeFileUrls},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammarLanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","GET",{grammarId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectGrammars(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/grammars","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,includeFileUrls:e.includeFileUrls},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvr(e){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling getArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","GET",{ivrId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvrs(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/ivrs","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,dnis:e.dnis,scheduleGroup:e.scheduleGroup},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectIvrsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/ivrs/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPrompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","GET",{promptId:e},{includeMediaUris:i.includeMediaUris,includeResources:i.includeResources,language:this.apiClient.buildCollectionParam(i.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getArchitectPromptHistoryHistoryId';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/history/{historyId}","GET",{promptId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","GET",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPromptResources(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectPromptResources';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources","GET",{promptId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectPrompts(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/prompts","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:this.apiClient.buildCollectionParam(e.name,"multi"),description:e.description,nameOrDescription:e.nameOrDescription,sortBy:e.sortBy,sortOrder:e.sortOrder,includeMediaUris:e.includeMediaUris,includeResources:e.includeResources,language:this.apiClient.buildCollectionParam(e.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedule(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling getArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","GET",{scheduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling getArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","GET",{scheduleGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroups(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedulegroups","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,scheduleIds:e.scheduleIds,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulegroupsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedulegroups/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedules(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedules","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSchedulesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/schedules/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystemprompt(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystemprompt';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}","GET",{promptId:e},{includeMediaUris:i.includeMediaUris,includeResources:i.includeResources,language:this.apiClient.buildCollectionParam(i.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getArchitectSystempromptHistoryHistoryId';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/history/{historyId}","GET",{promptId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptResource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","GET",{promptId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystempromptResources(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "promptId" when calling getArchitectSystempromptResources';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources","GET",{promptId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getArchitectSystemprompts(e){return e=e||{},this.apiClient.callApi("/api/v2/architect/systemprompts","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,includeMediaUris:e.includeMediaUris,includeResources:e.includeResources,language:this.apiClient.buildCollectionParam(e.language,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlow(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","GET",{flowId:e},{deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowHistoryHistoryId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowHistoryHistoryId';if(void 0===i||null===i)throw'Missing the required parameter "historyId" when calling getFlowHistoryHistoryId';return this.apiClient.callApi("/api/v2/flows/{flowId}/history/{historyId}","GET",{flowId:e,historyId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize,sortOrder:t.sortOrder,sortBy:t.sortBy,action:this.apiClient.buildCollectionParam(t.action,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowInstancesSettingsLoglevels(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","GET",{flowId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowLatestconfiguration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowLatestconfiguration';return this.apiClient.callApi("/api/v2/flows/{flowId}/latestconfiguration","GET",{flowId:e},{deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersion';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}","GET",{flowId:e,versionId:i},{deleted:t.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionConfiguration(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionConfiguration';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionConfiguration';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/configuration","GET",{flowId:e,versionId:i},{deleted:t.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionHealth(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/health","GET",{flowId:e,versionId:i},{language:t.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionIntentHealth(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';if(void 0===t||null===t)throw'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';if(void 0===n||null===n)throw'Missing the required parameter "language" when calling getFlowVersionIntentHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health","GET",{flowId:e,versionId:i,intentId:t},{language:n},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersionIntentUtteranceHealth(e,i,t,n,a){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===t||null===t)throw'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===n||null===n)throw'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';if(void 0===a||null===a)throw'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health","GET",{flowId:e,versionId:i,intentId:t,utteranceId:n},{language:a},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling getFlowVersions';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions","GET",{flowId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,deleted:i.deleted},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlows(e){return e=e||{},this.apiClient.callApi("/api/v2/flows","GET",{},{type:this.apiClient.buildCollectionParam(e.type,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,publishVersionId:e.publishVersionId,editableBy:e.editableBy,lockedBy:e.lockedBy,lockedByClientId:e.lockedByClientId,secure:e.secure,deleted:e.deleted,includeSchemas:e.includeSchemas,publishedAfter:e.publishedAfter,publishedBefore:e.publishedBefore,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatable(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","GET",{datatableId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling getFlowsDatatableExportJob';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}","GET",{datatableId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableImportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling getFlowsDatatableImportJob';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}","GET",{datatableId:e,importJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableImportJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableImportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs","GET",{datatableId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableRow(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling getFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","GET",{datatableId:e,rowId:i},{showbrief:t.showbrief},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatableRows(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatableRows';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows","GET",{datatableId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,showbrief:i.showbrief,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatables(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/datatables","GET",{},{expand:e.expand,pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatablesDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling getFlowsDatatablesDivisionview';return this.apiClient.callApi("/api/v2/flows/datatables/divisionviews/{datatableId}","GET",{datatableId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDatatablesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/datatables/divisionviews","GET",{},{expand:e.expand,pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/divisionviews","GET",{},{type:this.apiClient.buildCollectionParam(e.type,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,publishVersionId:e.publishVersionId,publishedAfter:e.publishedAfter,publishedBefore:e.publishedBefore,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),includeSchemas:e.includeSchemas},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsExecution(e){if(void 0===e||null===e)throw'Missing the required parameter "flowExecutionId" when calling getFlowsExecution';return this.apiClient.callApi("/api/v2/flows/executions/{flowExecutionId}","GET",{flowExecutionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstance(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "instanceId" when calling getFlowsInstance';return this.apiClient.callApi("/api/v2/flows/instances/{instanceId}","GET",{instanceId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getFlowsInstancesJob';return this.apiClient.callApi("/api/v2/flows/instances/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesQuerycapabilities(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/querycapabilities","GET",{},{expand:e.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsExecutiondata(){return this.apiClient.callApi("/api/v2/flows/instances/settings/executiondata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevels(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevelsCharacteristics(){return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/characteristics","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsInstancesSettingsLoglevelsDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsJob(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getFlowsJob';return this.apiClient.callApi("/api/v2/flows/jobs/{jobId}","GET",{jobId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestone(e){if(void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling getFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","GET",{milestoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestones(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsMilestonesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "flowOutcomeId" when calling getFlowsOutcome';return this.apiClient.callApi("/api/v2/flows/outcomes/{flowOutcomeId}","GET",{flowOutcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,description:e.description,nameOrDescription:e.nameOrDescription,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFlowsOutcomesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchArchitectGrammar(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling patchArchitectGrammar';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}","PATCH",{grammarId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchArchitectGrammarLanguage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling patchArchitectGrammarLanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchArchitectGrammarLanguage';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}","PATCH",{grammarId:e,languageCode:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchFlowsInstancesSettingsExecutiondata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchFlowsInstancesSettingsExecutiondata';return this.apiClient.callApi("/api/v2/flows/instances/settings/executiondata","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectDependencytrackingBuild(){return this.apiClient.callApi("/api/v2/architect/dependencytracking/build","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectEmergencygroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectEmergencygroups';return this.apiClient.callApi("/api/v2/architect/emergencygroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguageFilesDtmf(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf","POST",{grammarId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguageFilesVoice(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice","POST",{grammarId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammarLanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectGrammarLanguages';return this.apiClient.callApi("/api/v2/architect/grammars/{grammarId}/languages","POST",{grammarId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectGrammars(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectGrammars';return this.apiClient.callApi("/api/v2/architect/grammars","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectIvrs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectIvrs';return this.apiClient.callApi("/api/v2/architect/ivrs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPromptHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectPromptHistory';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/history","POST",{promptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPromptResources(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectPromptResources';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectPromptResources';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources","POST",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectPrompts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectPrompts';return this.apiClient.callApi("/api/v2/architect/prompts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSchedulegroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectSchedulegroups';return this.apiClient.callApi("/api/v2/architect/schedulegroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSchedules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postArchitectSchedules';return this.apiClient.callApi("/api/v2/architect/schedules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSystempromptHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectSystempromptHistory';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/history","POST",{promptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postArchitectSystempromptResources(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling postArchitectSystempromptResources';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postArchitectSystempromptResources';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources","POST",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowHistory(e){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowHistory';return this.apiClient.callApi("/api/v2/flows/{flowId}/history","POST",{flowId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowInstancesSettingsLoglevels(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowInstancesSettingsLoglevels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","POST",{flowId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowVersions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling postFlowVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowVersions';return this.apiClient.callApi("/api/v2/flows/{flowId}/versions","POST",{flowId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlows(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlows';return this.apiClient.callApi("/api/v2/flows","POST",{},{language:i.language},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsCheckin(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsCheckin';return this.apiClient.callApi("/api/v2/flows/actions/checkin","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsCheckout(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsCheckout';return this.apiClient.callApi("/api/v2/flows/actions/checkout","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsDeactivate(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsDeactivate';return this.apiClient.callApi("/api/v2/flows/actions/deactivate","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsPublish(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsPublish';return this.apiClient.callApi("/api/v2/flows/actions/publish","POST",{},{flow:e,version:i.version},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsRevert(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsRevert';return this.apiClient.callApi("/api/v2/flows/actions/revert","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsActionsUnlock(e){if(void 0===e||null===e)throw'Missing the required parameter "flow" when calling postFlowsActionsUnlock';return this.apiClient.callApi("/api/v2/flows/actions/unlock","POST",{},{flow:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableExportJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableExportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/export/jobs","POST",{datatableId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableImportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postFlowsDatatableImportJobs';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/import/jobs","POST",{datatableId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatableRows(e,i){if(void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling postFlowsDatatableRows';if(void 0===i||null===i)throw'Missing the required parameter "dataTableRow" when calling postFlowsDatatableRows';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows","POST",{datatableId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsDatatables(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsDatatables';return this.apiClient.callApi("/api/v2/flows/datatables","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsExecutions(e){if(void 0===e||null===e)throw'Missing the required parameter "flowLaunchRequest" when calling postFlowsExecutions';return this.apiClient.callApi("/api/v2/flows/executions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsInstancesJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsInstancesJobs';return this.apiClient.callApi("/api/v2/flows/instances/jobs","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsInstancesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postFlowsInstancesQuery';return this.apiClient.callApi("/api/v2/flows/instances/query","POST",{},{indexOnly:i.indexOnly,pageSize:i.pageSize},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsJobs(){return this.apiClient.callApi("/api/v2/flows/jobs","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsMilestones(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/milestones","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postFlowsOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/flows/outcomes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectEmergencygroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "emergencyGroupId" when calling putArchitectEmergencygroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectEmergencygroup';return this.apiClient.callApi("/api/v2/architect/emergencygroups/{emergencyGroupId}","PUT",{emergencyGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectIvr(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ivrId" when calling putArchitectIvr';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectIvr';return this.apiClient.callApi("/api/v2/architect/ivrs/{ivrId}","PUT",{ivrId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectPrompt(e,i){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectPrompt';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectPrompt';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}","PUT",{promptId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectPromptResource(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectPromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling putArchitectPromptResource';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putArchitectPromptResource';return this.apiClient.callApi("/api/v2/architect/prompts/{promptId}/resources/{languageCode}","PUT",{promptId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSchedule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "scheduleId" when calling putArchitectSchedule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectSchedule';return this.apiClient.callApi("/api/v2/architect/schedules/{scheduleId}","PUT",{scheduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSchedulegroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "scheduleGroupId" when calling putArchitectSchedulegroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putArchitectSchedulegroup';return this.apiClient.callApi("/api/v2/architect/schedulegroups/{scheduleGroupId}","PUT",{scheduleGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putArchitectSystempromptResource(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "promptId" when calling putArchitectSystempromptResource';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling putArchitectSystempromptResource';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putArchitectSystempromptResource';return this.apiClient.callApi("/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}","PUT",{promptId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putFlow(e,i){if(void 0===e||null===e)throw'Missing the required parameter "flowId" when calling putFlow';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlow';return this.apiClient.callApi("/api/v2/flows/{flowId}","PUT",{flowId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowInstancesSettingsLoglevels(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "flowId" when calling putFlowInstancesSettingsLoglevels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlowInstancesSettingsLoglevels';return this.apiClient.callApi("/api/v2/flows/{flowId}/instances/settings/loglevels","PUT",{flowId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsDatatable(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFlowsDatatable';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}","PUT",{datatableId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsDatatableRow(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "datatableId" when calling putFlowsDatatableRow';if(void 0===i||null===i)throw'Missing the required parameter "rowId" when calling putFlowsDatatableRow';return this.apiClient.callApi("/api/v2/flows/datatables/{datatableId}/rows/{rowId}","PUT",{datatableId:e,rowId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsInstancesSettingsLoglevelsDefault(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling putFlowsInstancesSettingsLoglevelsDefault';return this.apiClient.callApi("/api/v2/flows/instances/settings/loglevels/default","PUT",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsMilestone(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "milestoneId" when calling putFlowsMilestone';return this.apiClient.callApi("/api/v2/flows/milestones/{milestoneId}","PUT",{milestoneId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putFlowsOutcome(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';return this.apiClient.callApi("/api/v2/flows/outcomes/{flowOutcomeId}","PUT",{flowOutcomeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class m{constructor(e){this.apiClient=e||d.instance}getAuditsQueryRealtimeServicemapping(){return this.apiClient.callApi("/api/v2/audits/query/realtime/servicemapping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryServicemapping(){return this.apiClient.callApi("/api/v2/audits/query/servicemapping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryTransactionId(e){if(void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getAuditsQueryTransactionId';return this.apiClient.callApi("/api/v2/audits/query/{transactionId}","GET",{transactionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuditsQueryTransactionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getAuditsQueryTransactionIdResults';return this.apiClient.callApi("/api/v2/audits/query/{transactionId}/results","GET",{transactionId:e},{cursor:i.cursor,pageSize:i.pageSize,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQuery';return this.apiClient.callApi("/api/v2/audits/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQueryRealtime(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';return this.apiClient.callApi("/api/v2/audits/query/realtime","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuditsQueryRealtimeRelated(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';return this.apiClient.callApi("/api/v2/audits/query/realtime/related","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class v{constructor(e){this.apiClient=e||d.instance}deleteAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","DELETE",{divisionId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationRole(e){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling deleteAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","DELETE",{roleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationSubjectDivisionRole(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling deleteAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","DELETE",{subjectId:e,divisionId:i,roleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","GET",{divisionId:e},{objectCount:i.objectCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionGrants(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivisionGrants';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/grants","GET",{divisionId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/divisions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,objectCount:e.objectCount,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsHome(){return this.apiClient.callApi("/api/v2/authorization/divisions/home","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsLimit(){return this.apiClient.callApi("/api/v2/authorization/divisions/limit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/me","GET",{},{name:i.name,permission:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/me","GET",{},{permission:e,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedSubjectId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationDivisionspermittedPagedSubjectId';if(void 0===i||null===i)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedSubjectId';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/{subjectId}","GET",{subjectId:e},{permission:i,pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationPermissions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/permissions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,queryType:e.queryType,query:e.query},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationProducts(){return this.apiClient.callApi("/api/v2/authorization/products","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRole(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","GET",{roleId:e},{userCount:i.userCount,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleComparedefaultRightRoleId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "leftRoleId" when calling getAuthorizationRoleComparedefaultRightRoleId';if(void 0===i||null===i)throw'Missing the required parameter "rightRoleId" when calling getAuthorizationRoleComparedefaultRightRoleId';return this.apiClient.callApi("/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}","GET",{leftRoleId:e,rightRoleId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleSubjectgrants(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRoleSubjectgrants';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/subjectgrants","GET",{roleId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoleUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling getAuthorizationRoleUsers';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users","GET",{roleId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationRoles(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/roles","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,permission:this.apiClient.buildCollectionParam(e.permission,"multi"),defaultRoleId:this.apiClient.buildCollectionParam(e.defaultRoleId,"multi"),userCount:e.userCount,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSettings(){return this.apiClient.callApi("/api/v2/authorization/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}","GET",{subjectId:e},{includeDuplicates:i.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/me","GET",{},{includeDuplicates:e.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsRolecounts(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/rolecounts","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","GET",{subjectId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchAuthorizationRole(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling patchAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","PATCH",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchAuthorizationSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchAuthorizationSettings';return this.apiClient.callApi("/api/v2/authorization/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionObject(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionObject';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling postAuthorizationDivisionObject';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationDivisionObject';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/objects/{objectType}","POST",{divisionId:e,objectType:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionRestore(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/restore","POST",{divisionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationDivisions';return this.apiClient.callApi("/api/v2/authorization/divisions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRole(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "roleId" when calling postAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","POST",{roleId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRoleComparedefaultRightRoleId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "leftRoleId" when calling postAuthorizationRoleComparedefaultRightRoleId';if(void 0===i||null===i)throw'Missing the required parameter "rightRoleId" when calling postAuthorizationRoleComparedefaultRightRoleId';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationRoleComparedefaultRightRoleId';return this.apiClient.callApi("/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}","POST",{leftRoleId:e,rightRoleId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationRoles';return this.apiClient.callApi("/api/v2/authorization/roles","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationRolesDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/roles/default","POST",{},{force:e.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkadd(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkadd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkadd';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkadd","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkremove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkremove';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkremove","POST",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkreplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkreplace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkreplace';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkreplace","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectDivisionRole(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling postAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling postAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","POST",{subjectId:e,divisionId:i,roleId:t},{subjectType:n.subjectType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationDivision(e,i){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","PUT",{divisionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRole(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRole';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRole';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRoleUsersAdd(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRoleUsersAdd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRoleUsersAdd';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users/add","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRoleUsersRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roleId" when calling putAuthorizationRoleUsersRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationRoleUsersRemove';return this.apiClient.callApi("/api/v2/authorization/roles/{roleId}/users/remove","PUT",{roleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationRolesDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putAuthorizationRolesDefault';return this.apiClient.callApi("/api/v2/authorization/roles/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling putUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","PUT",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class w{constructor(e){this.apiClient=e||d.instance}getBillingReportsBillableusage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "startDate" when calling getBillingReportsBillableusage';if(void 0===i||null===i)throw'Missing the required parameter "endDate" when calling getBillingReportsBillableusage';return this.apiClient.callApi("/api/v2/billing/reports/billableusage","GET",{},{startDate:e,endDate:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getBillingTrusteebillingoverviewTrustorOrgId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';return this.apiClient.callApi("/api/v2/billing/trusteebillingoverview/{trustorOrgId}","GET",{trustorOrgId:e},{billingPeriodIndex:i.billingPeriodIndex},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class C{constructor(e){this.apiClient=e||d.instance}getCarrierservicesIntegrationsEmergencylocationsMe(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneNumber" when calling getCarrierservicesIntegrationsEmergencylocationsMe';return this.apiClient.callApi("/api/v2/carrierservices/integrations/emergencylocations/me","GET",{},{phoneNumber:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postCarrierservicesIntegrationsEmergencylocationsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/carrierservices/integrations/emergencylocations/me","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class I{constructor(e){this.apiClient=e||d.instance}deleteChatsRoomMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageId}","DELETE",{roomJid:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsRoomMessagesPin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';if(void 0===i||null===i)throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}","DELETE",{roomJid:e,pinnedMessageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{userId}","DELETE",{roomJid:e,userId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsUserMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling deleteChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageId}","DELETE",{userId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteChatsUserMessagesPin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';if(void 0===i||null===i)throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}","DELETE",{userId:e,pinnedMessageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getChatsMessage';return this.apiClient.callApi("/api/v2/chats/messages/{messageId}","GET",{messageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoom(e){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoom';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}","GET",{roomJid:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageIds" when calling getChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageIds}","GET",{roomJid:e,messageIds:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomMessages';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages","GET",{roomJid:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{participantJid}","GET",{roomJid:e,participantJid:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsRoomParticipants(e){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants","GET",{roomJid:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsSettings(){return this.apiClient.callApi("/api/v2/chats/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsThreadMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "threadId" when calling getChatsThreadMessages';return this.apiClient.callApi("/api/v2/chats/threads/{threadId}/messages","GET",{threadId:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUser';return this.apiClient.callApi("/api/v2/chats/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageIds" when calling getChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageIds}","GET",{userId:e,messageIds:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserMessages';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages","GET",{userId:e},{limit:i.limit,before:i.before,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUserSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getChatsUserSettings';return this.apiClient.callApi("/api/v2/chats/users/{userId}/settings","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getChatsUsersMeSettings(){return this.apiClient.callApi("/api/v2/chats/users/me/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsRoom(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling patchChatsRoom';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchChatsRoom';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}","PATCH",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsRoomMessage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling patchChatsRoomMessage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchChatsRoomMessage';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/{messageId}","PATCH",{roomJid:e,messageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchChatsSettings';return this.apiClient.callApi("/api/v2/chats/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUserMessage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchChatsUserMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchChatsUserMessage';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/{messageId}","PATCH",{userId:e,messageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUserSettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchChatsUserSettings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchChatsUserSettings';return this.apiClient.callApi("/api/v2/chats/users/{userId}/settings","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchChatsUsersMeSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchChatsUsersMeSettings';return this.apiClient.callApi("/api/v2/chats/users/me/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsRoomMessages';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages","POST",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomMessagesPins(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsRoomMessagesPins';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/messages/pins","POST",{roomJid:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRoomParticipant(e,i){if(void 0===e||null===e)throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postChatsRoomParticipant';return this.apiClient.callApi("/api/v2/chats/rooms/{roomJid}/participants/{userId}","POST",{roomJid:e,userId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsRooms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postChatsRooms';return this.apiClient.callApi("/api/v2/chats/rooms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsUserMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postChatsUserMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsUserMessages';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postChatsUserMessagesPins(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postChatsUserMessagesPins';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postChatsUserMessagesPins';return this.apiClient.callApi("/api/v2/chats/users/{userId}/messages/pins","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putChatsMessageReactions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling putChatsMessageReactions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putChatsMessageReactions';return this.apiClient.callApi("/api/v2/chats/messages/{messageId}/reactions","PUT",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putChatsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putChatsSettings';return this.apiClient.callApi("/api/v2/chats/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class f{constructor(e){this.apiClient=e||d.instance}deleteCoachingAppointment(e){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling deleteCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","DELETE",{appointmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteCoachingAppointmentAnnotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling deleteCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling deleteCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","DELETE",{appointmentId:e,annotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointment(e){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","GET",{appointmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentAnnotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling getCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","GET",{appointmentId:e,annotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentAnnotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentAnnotations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations","GET",{appointmentId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentStatuses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling getCoachingAppointmentStatuses';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/statuses","GET",{appointmentId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userIds" when calling getCoachingAppointments';return this.apiClient.callApi("/api/v2/coaching/appointments","GET",{},{userIds:this.apiClient.buildCollectionParam(e,"multi"),interval:i.interval,pageNumber:i.pageNumber,pageSize:i.pageSize,statuses:this.apiClient.buildCollectionParam(i.statuses,"multi"),facilitatorIds:this.apiClient.buildCollectionParam(i.facilitatorIds,"multi"),sortOrder:i.sortOrder,relationships:this.apiClient.buildCollectionParam(i.relationships,"multi"),completionInterval:i.completionInterval,overdue:i.overdue,intervalCondition:i.intervalCondition},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingAppointmentsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/coaching/appointments/me","GET",{},{interval:e.interval,pageNumber:e.pageNumber,pageSize:e.pageSize,statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),facilitatorIds:this.apiClient.buildCollectionParam(e.facilitatorIds,"multi"),sortOrder:e.sortOrder,relationships:this.apiClient.buildCollectionParam(e.relationships,"multi"),completionInterval:e.completionInterval,overdue:e.overdue,intervalCondition:e.intervalCondition},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingNotification(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "notificationId" when calling getCoachingNotification';return this.apiClient.callApi("/api/v2/coaching/notifications/{notificationId}","GET",{notificationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getCoachingNotifications(e){return e=e||{},this.apiClient.callApi("/api/v2/coaching/notifications","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingAppointment';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}","PATCH",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointmentAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointmentAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "annotationId" when calling patchCoachingAppointmentAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchCoachingAppointmentAnnotation';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}","PATCH",{appointmentId:e,annotationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingAppointmentStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling patchCoachingAppointmentStatus';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingAppointmentStatus';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/status","PATCH",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchCoachingNotification(e,i){if(void 0===e||null===e)throw'Missing the required parameter "notificationId" when calling patchCoachingNotification';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchCoachingNotification';return this.apiClient.callApi("/api/v2/coaching/notifications/{notificationId}","PATCH",{notificationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentAnnotations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling postCoachingAppointmentAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postCoachingAppointmentAnnotations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/annotations","POST",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentConversations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "appointmentId" when calling postCoachingAppointmentConversations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postCoachingAppointmentConversations';return this.apiClient.callApi("/api/v2/coaching/appointments/{appointmentId}/conversations","POST",{appointmentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingAppointments';return this.apiClient.callApi("/api/v2/coaching/appointments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingAppointmentsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingAppointmentsAggregatesQuery';return this.apiClient.callApi("/api/v2/coaching/appointments/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postCoachingScheduleslotsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';return this.apiClient.callApi("/api/v2/coaching/scheduleslots/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class A{constructor(e){this.apiClient=e||d.instance}deleteContentmanagementDocument(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","DELETE",{documentId:e},{override:i.override},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementShare(e){if(void 0===e||null===e)throw'Missing the required parameter "shareId" when calling deleteContentmanagementShare';return this.apiClient.callApi("/api/v2/contentmanagement/shares/{shareId}","DELETE",{shareId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling deleteContentmanagementStatusStatusId';return this.apiClient.callApi("/api/v2/contentmanagement/status/{statusId}","DELETE",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspace(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","DELETE",{workspaceId:e},{moveChildrenToWorkspaceId:i.moveChildrenToWorkspaceId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspaceMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","DELETE",{workspaceId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteContentmanagementWorkspaceTagvalue(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling deleteContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling deleteContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","DELETE",{workspaceId:e,tagId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocument(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","GET",{documentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocumentContent(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getContentmanagementDocumentContent';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}/content","GET",{documentId:e},{disposition:i.disposition,contentType:i.contentType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/documents","GET",{},{workspaceId:e,name:i.name,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queryPhrase" when calling getContentmanagementQuery';return this.apiClient.callApi("/api/v2/contentmanagement/query","GET",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder,queryPhrase:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSecurityprofile(e){if(void 0===e||null===e)throw'Missing the required parameter "securityProfileId" when calling getContentmanagementSecurityprofile';return this.apiClient.callApi("/api/v2/contentmanagement/securityprofiles/{securityProfileId}","GET",{securityProfileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSecurityprofiles(){return this.apiClient.callApi("/api/v2/contentmanagement/securityprofiles","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementShare(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "shareId" when calling getContentmanagementShare';return this.apiClient.callApi("/api/v2/contentmanagement/shares/{shareId}","GET",{shareId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementSharedSharedId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';return this.apiClient.callApi("/api/v2/contentmanagement/shared/{sharedId}","GET",{sharedId:e},{redirect:i.redirect,disposition:i.disposition,contentType:i.contentType,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementShares(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/shares","GET",{},{entityId:e.entityId,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementStatus(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/status","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling getContentmanagementStatusStatusId';return this.apiClient.callApi("/api/v2/contentmanagement/status/{statusId}","GET",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementUsage(){return this.apiClient.callApi("/api/v2/contentmanagement/usage","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspace(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","GET",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/documents","GET",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceMember(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling getContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","GET",{workspaceId:e,memberId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceMembers';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members","GET",{workspaceId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceTagvalue(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling getContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","GET",{workspaceId:e,tagId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaceTagvalues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling getContentmanagementWorkspaceTagvalues';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues","GET",{workspaceId:e},{value:i.value,pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getContentmanagementWorkspaces(e){return e=e||{},this.apiClient.callApi("/api/v2/contentmanagement/workspaces","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,access:this.apiClient.buildCollectionParam(e.access,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocument(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postContentmanagementDocument';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementDocument';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}","POST",{documentId:e},{expand:t.expand,override:t.override},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocumentContent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postContentmanagementDocumentContent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementDocumentContent';return this.apiClient.callApi("/api/v2/contentmanagement/documents/{documentId}/content","POST",{documentId:e},{override:t.override},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementDocuments';return this.apiClient.callApi("/api/v2/contentmanagement/documents","POST",{},{copySource:i.copySource,moveSource:i.moveSource,override:i.override},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementQuery';return this.apiClient.callApi("/api/v2/contentmanagement/query","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementShares(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementShares';return this.apiClient.callApi("/api/v2/contentmanagement/shares","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaceTagvalues(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling postContentmanagementWorkspaceTagvalues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaceTagvalues';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues","POST",{workspaceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaceTagvaluesQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling postContentmanagementWorkspaceTagvaluesQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaceTagvaluesQuery';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query","POST",{workspaceId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postContentmanagementWorkspaces(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postContentmanagementWorkspaces';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspace(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putContentmanagementWorkspace';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}","PUT",{workspaceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspaceMember(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspaceMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling putContentmanagementWorkspaceMember';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceMember';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}","PUT",{workspaceId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putContentmanagementWorkspaceTagvalue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workspaceId" when calling putContentmanagementWorkspaceTagvalue';if(void 0===i||null===i)throw'Missing the required parameter "tagId" when calling putContentmanagementWorkspaceTagvalue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';return this.apiClient.callApi("/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}","PUT",{workspaceId:e,tagId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class b{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationParticipantCode(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationParticipantCode';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationParticipantCode';if(void 0===t||null===t)throw'Missing the required parameter "addCommunicationCode" when calling deleteConversationParticipantCode';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}","DELETE",{conversationId:e,participantId:i,addCommunicationCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationParticipantFlaggedreason(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationParticipantFlaggedreason';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationParticipantFlaggedreason';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason","DELETE",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsCallParticipantConsult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling deleteConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","DELETE",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsEmailMessagesDraftAttachment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationsEmailMessagesDraftAttachment';if(void 0===i||null===i)throw'Missing the required parameter "attachmentId" when calling deleteConversationsEmailMessagesDraftAttachment';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}","DELETE",{conversationId:e,attachmentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagesCachedmediaCachedMediaItemId(e){if(void 0===e||null===e)throw'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';return this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}","DELETE",{cachedMediaItemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsFacebookIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsInstagramIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsOpenIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingIntegrationsWhatsappIntegrationId(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","DELETE",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteConversationsMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling deleteConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","DELETE",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getAnalyticsConversationDetails';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetails(e){return e=e||{},this.apiClient.callApi("/api/v2/analytics/conversations/details","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJob';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsConversationsDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantSecureivrsession(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantSecureivrsession';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantSecureivrsession';if(void 0===t||null===t)throw'Missing the required parameter "secureSessionId" when calling getConversationParticipantSecureivrsession';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}","GET",{conversationId:e,participantId:i,secureSessionId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantSecureivrsessions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantSecureivrsessions';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantSecureivrsessions';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationSecureattributes(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversations(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations","GET",{},{communicationType:e.communicationType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCall(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCallParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallback(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallback';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCallbackParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbackParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCallbackParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCallbackParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallbacks(){return this.apiClient.callApi("/api/v2/conversations/callbacks","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCalls(){return this.apiClient.callApi("/api/v2/conversations/calls","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallsHistory(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/calls/history","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,interval:e.interval,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCallsMaximumconferenceparties(){return this.apiClient.callApi("/api/v2/conversations/calls/maximumconferenceparties","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChat(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChat';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsChatMessage';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatMessages';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/messages","GET",{conversationId:e},{after:i.after,before:i.before,sortOrder:i.sortOrder,maxResults:i.maxResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsChatParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChatParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsChats(){return this.apiClient.callApi("/api/v2/conversations/chats","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesession(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesession';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsCobrowsesessionParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessionParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsCobrowsesessionParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsCobrowsesessions(){return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmail(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmail';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsEmailMessage';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessages(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailMessagesDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsEmailParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsEmailParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmailSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsEmailSettings';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/settings","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsEmails(){return this.apiClient.callApi("/api/v2/conversations/emails","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsKeyconfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "keyconfigurationsId" when calling getConversationsKeyconfiguration';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/{keyconfigurationsId}","GET",{keyconfigurationsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsKeyconfigurations(){return this.apiClient.callApi("/api/v2/conversations/keyconfigurations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageCommunicationMessagesMediaMediaId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';if(void 0===t||null===t)throw'Missing the required parameter "mediaId" when calling getConversationsMessageCommunicationMessagesMediaMediaId';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}","GET",{conversationId:e,communicationId:i,mediaId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageDetails(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getConversationsMessageDetails';return this.apiClient.callApi("/api/v2/conversations/messages/{messageId}/details","GET",{messageId:e},{useNormalizedMessage:i.useNormalizedMessage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageMessage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getConversationsMessageMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{useNormalizedMessage:t.useNormalizedMessage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsMessageParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantWrapup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup","GET",{conversationId:e,participantId:i},{provisional:t.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessageParticipantWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsMessageParticipantWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsMessageParticipantWrapupcodes';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes","GET",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessages(){return this.apiClient.callApi("/api/v2/conversations/messages","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagesCachedmedia(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,url:e.url},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagesCachedmediaCachedMediaItemId(e){if(void 0===e||null===e)throw'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';return this.apiClient.callApi("/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}","GET",{cachedMediaItemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingFacebookApp(){return this.apiClient.callApi("/api/v2/conversations/messaging/facebook/app","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingFacebookPermissions(){return this.apiClient.callApi("/api/v2/conversations/messaging/facebook/permissions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsFacebook(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsFacebookIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsInstagram(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsInstagramIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsOpen(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsOpenIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsWhatsapp(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,"supportedContent.id":e.supportedContentId,"messagingSetting.id":e.messagingSettingId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingIntegrationsWhatsappIntegrationId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","GET",{integrationId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","GET",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/settings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontent(e){return e=e||{},this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontentDefault(){return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling getConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","GET",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsMessagingThreadingtimeline(){return this.apiClient.callApi("/api/v2/conversations/messaging/threadingtimeline","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsScreenshareParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsScreenshareParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsScreenshareParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsSettings(){return this.apiClient.callApi("/api/v2/conversations/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsSocialParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsSocialParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsSocialParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsSocialParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideoDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "conferenceId" when calling getConversationsVideoDetails';return this.apiClient.callApi("/api/v2/conversations/videos/{conferenceId}/details","GET",{conferenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideoParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationsVideoParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling getConversationsVideoParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling getConversationsVideoParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","GET",{conversationId:e,participantId:i,communicationId:t},{provisional:n.provisional},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationsVideosMeeting(e){if(void 0===e||null===e)throw'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';return this.apiClient.callApi("/api/v2/conversations/videos/meetings/{meetingId}","GET",{meetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationParticipant';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationSecureattributes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationSecureattributes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationUtilizationlabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationUtilizationlabel';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationUtilizationlabel';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/utilizationlabel","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsAftercallworkConversationIdParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsAftercallworkConversationIdParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCall(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCall';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipant';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCallParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallParticipantConsult(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallParticipantConsult';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallback(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallback';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCallback';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipant';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbackParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCallbackParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCallbackParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCallbacks(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchConversationsCallbacks';return this.apiClient.callApi("/api/v2/conversations/callbacks","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChat(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChat';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsChat';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsChatParticipant';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsChatParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsChatParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsChatParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsChatParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesession(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesession';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsCobrowsesession';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipant(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipant';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipantAttributes(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsCobrowsesessionParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsCobrowsesessionParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsCobrowsesessionParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmail(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmail';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsEmail';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailMessagesDraft(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","PATCH",{conversationId:e},{autoFill:i.autoFill,discard:i.discard},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipant(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipant';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipant';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipantAttributes(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantAttributes';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsEmailParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsEmailParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipant(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipant';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipant';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipantAttributes(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantAttributes';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantAttributes';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes","PATCH",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessageParticipantCommunication(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantCommunication';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantCommunication';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling patchConversationsMessageParticipantCommunication';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchConversationsMessageParticipantCommunication';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}","PATCH",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsFacebookIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsFacebookIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsFacebookIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsInstagramIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsOpenIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingIntegrationsWhatsappIntegrationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsWhatsappIntegrationId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsWhatsappIntegrationId';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}","PATCH",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingSetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingSetting';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/{messageSettingId}","PATCH",{messageSettingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsMessagingSupportedcontentSupportedContentId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling patchConversationsMessagingSupportedcontentSupportedContentId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchConversationsMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/{supportedContentId}","PATCH",{supportedContentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchConversationsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchConversationsSettings';return this.apiClient.callApi("/api/v2/conversations/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationDetailsProperties(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';return this.apiClient.callApi("/api/v2/analytics/conversations/{conversationId}/details/properties","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/conversations/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationAssign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationAssign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationAssign';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/assign","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationBarge(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationBarge';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/barge","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationCobrowse(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationCobrowse';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/cobrowse","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationDisconnect';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/disconnect","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantCallbacks(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantCallbacks';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantCallbacks';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantDigits(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantDigits';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantDigits';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/digits","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceExternal(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantReplaceQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationParticipantSecureivrsessions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationParticipantSecureivrsessions';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationParticipantSecureivrsessions';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationSummaryFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';if(void 0===i||null===i)throw'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback","POST",{conversationId:e,summaryId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCall(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCall';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsCall';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantBarge(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantCoach(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCoach';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCoach';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCallParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsult(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsult';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsult';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsult';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultExternal(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantConsultQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantMonitor(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantMonitor';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantMonitor';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallParticipants(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipants';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsCallParticipants';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbackParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallbackParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallbackParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCallbackParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbackParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCallbackParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCallbackParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsCallbackParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacks(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacks';return this.apiClient.callApi("/api/v2/conversations/callbacks","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacksBulkDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacksBulkDisconnect';return this.apiClient.callApi("/api/v2/conversations/callbacks/bulk/disconnect","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCallbacksBulkUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCallbacksBulkUpdate';return this.apiClient.callApi("/api/v2/conversations/callbacks/bulk/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCalls(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsCalls';return this.apiClient.callApi("/api/v2/conversations/calls","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatCommunicationMessages(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationMessages';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsChatCommunicationMessages';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages","POST",{conversationId:e,communicationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatCommunicationTyping(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationTyping';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationTyping';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing","POST",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsChatParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChatParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsChatParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsChats(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsChats';return this.apiClient.callApi("/api/v2/conversations/chats","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCobrowsesessionParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsCobrowsesessionParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsCobrowsesessionParticipantReplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsCobrowsesessionParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsCobrowsesessionParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailInboundmessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailInboundmessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailInboundmessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/inboundmessages","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailMessages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailMessages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailMessages';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailMessagesDraftAttachmentsCopy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailMessagesDraftAttachmentsCopy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsEmailMessagesDraftAttachmentsCopy';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy","POST",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsEmailParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsEmailParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailReconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/reconnect","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmails(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsEmails';return this.apiClient.callApi("/api/v2/conversations/emails","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsEmailsAgentless(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsEmailsAgentless';return this.apiClient.callApi("/api/v2/conversations/emails/agentless","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsFaxes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsFaxes';return this.apiClient.callApi("/api/v2/conversations/faxes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsKeyconfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsKeyconfigurations';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsKeyconfigurationsValidate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsKeyconfigurationsValidate';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/validate","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationMessages(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessages';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageCommunicationMessages';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages","POST",{conversationId:e,communicationId:i},{useNormalizedMessage:n.useNormalizedMessage},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationMessagesMedia(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationMessagesMedia';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationMessagesMedia';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media","POST",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageCommunicationTyping(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationTyping';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationTyping';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageCommunicationTyping';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing","POST",{conversationId:e,communicationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenEvent(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/event","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/message","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageInboundOpenReceipt(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';return this.apiClient.callApi("/api/v2/conversations/messages/{integrationId}/inbound/open/receipt","POST",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageMessagesBulk(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageMessagesBulk';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/messages/bulk","POST",{conversationId:e},{useNormalizedMessage:i.useNormalizedMessage},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsMessageParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantMonitor(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantMonitor';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantMonitor';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor","POST",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessageParticipantReplace(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsMessageParticipantReplace';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsMessageParticipantReplace';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationsMessageParticipantReplace';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace","POST",{conversationId:e,participantId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessages';return this.apiClient.callApi("/api/v2/conversations/messages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagesAgentless(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagesAgentless';return this.apiClient.callApi("/api/v2/conversations/messages/agentless","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagesInboundOpen(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagesInboundOpen';return this.apiClient.callApi("/api/v2/conversations/messages/inbound/open","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsFacebook(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/facebook","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsInstagram(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/instagram","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsOpen(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/open","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsWhatsapp(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingIntegrationsWhatsappEmbeddedsignup(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsappEmbeddedsignup';return this.apiClient.callApi("/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingSettings';return this.apiClient.callApi("/api/v2/conversations/messaging/settings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsMessagingSupportedcontent(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsMessagingSupportedcontent';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsParticipantsAttributesSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';return this.apiClient.callApi("/api/v2/conversations/participants/attributes/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsScreenshareParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsScreenshareParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsScreenshareParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsSocialParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsVideoParticipantCommunicationWrapup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup","POST",{conversationId:e,participantId:i,communicationId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsVideosMeetings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsVideosMeetings';return this.apiClient.callApi("/api/v2/conversations/videos/meetings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationParticipantFlaggedreason(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationParticipantFlaggedreason';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling putConversationParticipantFlaggedreason';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason","PUT",{conversationId:e,participantId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationSecureattributes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationSecureattributes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationSecureattributes';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/secureattributes","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationTags(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationTags';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationTags';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/tags","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallParticipantCommunicationUuidata(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===i||null===i)throw'Missing the required parameter "participantId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===t||null===t)throw'Missing the required parameter "communicationId" when calling putConversationsCallParticipantCommunicationUuidata';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling putConversationsCallParticipantCommunicationUuidata';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata","PUT",{conversationId:e,participantId:i,communicationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCallRecordingstate';return this.apiClient.callApi("/api/v2/conversations/calls/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCallbackRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';return this.apiClient.callApi("/api/v2/conversations/callbacks/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsChatRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsChatRecordingstate';return this.apiClient.callApi("/api/v2/conversations/chats/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsCobrowsesessionRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';return this.apiClient.callApi("/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsEmailMessagesDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsEmailMessagesDraft';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsEmailMessagesDraft';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/messages/draft","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsEmailRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';return this.apiClient.callApi("/api/v2/conversations/emails/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsKeyconfiguration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "keyconfigurationsId" when calling putConversationsKeyconfiguration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsKeyconfiguration';return this.apiClient.callApi("/api/v2/conversations/keyconfigurations/{keyconfigurationsId}","PUT",{keyconfigurationsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessageRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';return this.apiClient.callApi("/api/v2/conversations/messages/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingSettingsDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';return this.apiClient.callApi("/api/v2/conversations/messaging/settings/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingSupportedcontentDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingSupportedcontentDefault';return this.apiClient.callApi("/api/v2/conversations/messaging/supportedcontent/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsMessagingThreadingtimeline(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putConversationsMessagingThreadingtimeline';return this.apiClient.callApi("/api/v2/conversations/messaging/threadingtimeline","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsScreenshareRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';return this.apiClient.callApi("/api/v2/conversations/screenshares/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsSocialRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';return this.apiClient.callApi("/api/v2/conversations/socials/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationsVideoRecordingstate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';return this.apiClient.callApi("/api/v2/conversations/videos/{conversationId}/recordingstate","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class j{constructor(e){this.apiClient=e||d.instance}getDataextensionsCoretype(e){if(void 0===e||null===e)throw'Missing the required parameter "coretypeName" when calling getDataextensionsCoretype';return this.apiClient.callApi("/api/v2/dataextensions/coretypes/{coretypeName}","GET",{coretypeName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDataextensionsCoretypes(){return this.apiClient.callApi("/api/v2/dataextensions/coretypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDataextensionsLimits(){return this.apiClient.callApi("/api/v2/dataextensions/limits","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class P{constructor(e){this.apiClient=e||d.instance}getDownload(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "downloadId" when calling getDownload';return this.apiClient.callApi("/api/v2/downloads/{downloadId}","GET",{downloadId:e},{contentDisposition:i.contentDisposition,issueRedirect:i.issueRedirect,redirectToAuth:i.redirectToAuth},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class y{constructor(e){this.apiClient=e||d.instance}getEmailsSettings(){return this.apiClient.callApi("/api/v2/emails/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmailsSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/emails/settings","PATCH",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class O{constructor(e){this.apiClient=e||d.instance}postEventsConversations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsConversations';return this.apiClient.callApi("/api/v2/events/conversations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postEventsUsersPresence(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsUsersPresence';return this.apiClient.callApi("/api/v2/events/users/presence","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postEventsUsersRoutingstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';return this.apiClient.callApi("/api/v2/events/users/routingstatus","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class M{constructor(e){this.apiClient=e||d.instance}deleteExternalcontactsContact(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling deleteExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","DELETE",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsContactNote(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling deleteExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling deleteExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","DELETE",{contactId:e,noteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsContactsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling deleteExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","DELETE",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganization(e){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","DELETE",{externalOrganizationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganizationNote(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling deleteExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","DELETE",{externalOrganizationId:e,noteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsOrganizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling deleteExternalcontactsOrganizationTrustor';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor","DELETE",{externalOrganizationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteExternalcontactsRelationship(e){if(void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling deleteExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","DELETE",{relationshipId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContact(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","GET",{contactId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactIdentifiers(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactIdentifiers';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/identifiers","GET",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactJourneySessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/journey/sessions","GET",{contactId:e},{pageSize:i.pageSize,after:i.after,includeMerged:i.includeMerged},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactNote(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling getExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","GET",{contactId:e,noteId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactNotes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactNotes';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes","GET",{contactId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactUnresolved(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/unresolved","GET",{contactId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContacts(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/contacts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,q:e.q,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getExternalcontactsContactsSchemaVersion';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsContactsSchemaVersions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactsSchemas(){return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganization(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","GET",{externalOrganizationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),includeTrustors:i.includeTrustors},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationContacts(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationContacts';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,q:i.q,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationNote(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling getExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","GET",{externalOrganizationId:e,noteId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationNotes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationNotes';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationRelationships(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships","GET",{externalOrganizationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizations(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/organizations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,q:e.q,trustorId:this.apiClient.buildCollectionParam(e.trustorId,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),includeTrustors:e.includeTrustors},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getExternalcontactsOrganizationsSchemaVersion';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getExternalcontactsOrganizationsSchemaVersions';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsOrganizationsSchemas(){return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsRelationship(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling getExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","GET",{relationshipId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsReversewhitepageslookup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "lookupVal" when calling getExternalcontactsReversewhitepageslookup';return this.apiClient.callApi("/api/v2/externalcontacts/reversewhitepageslookup","GET",{},{lookupVal:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanContacts(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/contacts","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanNotes(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/notes","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanOrganizations(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/organizations","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsScanRelationships(e){return e=e||{},this.apiClient.callApi("/api/v2/externalcontacts/scan/relationships","GET",{},{limit:e.limit,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchExternalcontactsContactIdentifiers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/identifiers","PATCH",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContacts';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsUnresolved(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUnresolved';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/unresolved","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkContactsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/contacts/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotes';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkNotesUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkNotesUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/notes/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizations';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkOrganizationsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/organizations/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationships(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsAdd';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsRemove(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsRemove';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/remove","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsBulkRelationshipsUpdate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsBulkRelationshipsUpdate';return this.apiClient.callApi("/api/v2/externalcontacts/bulk/relationships/update","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactNotes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling postExternalcontactsContactNotes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postExternalcontactsContactNotes';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes","POST",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactPromotion(e){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling postExternalcontactsContactPromotion';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/promotion","POST",{contactId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsContacts';return this.apiClient.callApi("/api/v2/externalcontacts/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsContactsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsContactsSchemas';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsIdentifierlookup(e){if(void 0===e||null===e)throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';return this.apiClient.callApi("/api/v2/externalcontacts/identifierlookup","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsMergeContacts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';return this.apiClient.callApi("/api/v2/externalcontacts/merge/contacts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizationNotes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling postExternalcontactsOrganizationNotes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationNotes';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes","POST",{externalOrganizationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizations';return this.apiClient.callApi("/api/v2/externalcontacts/organizations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsOrganizationsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationsSchemas';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postExternalcontactsRelationships(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postExternalcontactsRelationships';return this.apiClient.callApi("/api/v2/externalcontacts/relationships","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling putExternalcontactsContact';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsContact';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}","PUT",{contactId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContactNote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "contactId" when calling putExternalcontactsContactNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling putExternalcontactsContactNote';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putExternalcontactsContactNote';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}","PUT",{contactId:e,noteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsContactsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putExternalcontactsContactsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsContactsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsConversation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putExternalcontactsConversation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsConversation';return this.apiClient.callApi("/api/v2/externalcontacts/conversations/{conversationId}","PUT",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsOrganization';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}","PUT",{externalOrganizationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationNote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationNote';if(void 0===i||null===i)throw'Missing the required parameter "noteId" when calling putExternalcontactsOrganizationNote';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putExternalcontactsOrganizationNote';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}","PUT",{externalOrganizationId:e,noteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationTrustorTrustorId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "externalOrganizationId" when calling putExternalcontactsOrganizationTrustorTrustorId';if(void 0===i||null===i)throw'Missing the required parameter "trustorId" when calling putExternalcontactsOrganizationTrustorTrustorId';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}","PUT",{externalOrganizationId:e,trustorId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsOrganizationsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putExternalcontactsOrganizationsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsOrganizationsSchema';return this.apiClient.callApi("/api/v2/externalcontacts/organizations/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putExternalcontactsRelationship(e,i){if(void 0===e||null===e)throw'Missing the required parameter "relationshipId" when calling putExternalcontactsRelationship';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';return this.apiClient.callApi("/api/v2/externalcontacts/relationships/{relationshipId}","PUT",{relationshipId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class T{constructor(e){this.apiClient=e||d.instance}deleteFaxDocument(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","DELETE",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocument(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","GET",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocumentContent(e){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getFaxDocumentContent';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}/content","GET",{documentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxDocuments(e){return e=e||{},this.apiClient.callApi("/api/v2/fax/documents","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxSettings(){return this.apiClient.callApi("/api/v2/fax/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFaxSummary(){return this.apiClient.callApi("/api/v2/fax/summary","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putFaxDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling putFaxDocument';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putFaxDocument';return this.apiClient.callApi("/api/v2/fax/documents/{documentId}","PUT",{documentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putFaxSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/fax/settings","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class q{constructor(e){this.apiClient=e||d.instance}getAnalyticsFlowsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsFlowsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/flows/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/flows/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsFlowsObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/flows/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class S{constructor(e){this.apiClient=e||d.instance}deleteEmployeeperformanceExternalmetricsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","DELETE",{metricId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getEmployeeperformanceExternalmetricsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling getEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","GET",{metricId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getEmployeeperformanceExternalmetricsDefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsights(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsights';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsights';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsights';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsights';if(void 0===a||null===a)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsights';return this.apiClient.callApi("/api/v2/gamification/insights","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,primaryPeriodStartWorkday:a,pageSize:o.pageSize,pageNumber:o.pageNumber,sortKey:o.sortKey,sortMetricId:o.sortMetricId,sortOrder:o.sortOrder,userIds:o.userIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsDetails(e,i,t,n,a){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsDetails';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsDetails';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsDetails';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsDetails';if(void 0===a||null===a)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsDetails';return this.apiClient.callApi("/api/v2/gamification/insights/details","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,primaryPeriodStartWorkday:a},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsGroupsTrends(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrends';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrends';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrends';return this.apiClient.callApi("/api/v2/gamification/insights/groups/trends","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsGroupsTrendsAll(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsGroupsTrendsAll';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsGroupsTrendsAll';return this.apiClient.callApi("/api/v2/gamification/insights/groups/trends/all","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsMembers(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsMembers';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsMembers';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationInsightsMembers';return this.apiClient.callApi("/api/v2/gamification/insights/members","GET",{},{filterType:e,filterId:i,granularity:t,startWorkday:n},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsTrends(e,i,t,n,a,o,r){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationInsightsTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationInsightsTrends';if(void 0===t||null===t)throw'Missing the required parameter "granularity" when calling getGamificationInsightsTrends';if(void 0===n||null===n)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsTrends';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsTrends';return this.apiClient.callApi("/api/v2/gamification/insights/trends","GET",{},{filterType:e,filterId:i,granularity:t,comparativePeriodStartWorkday:n,comparativePeriodEndWorkday:a,primaryPeriodStartWorkday:o,primaryPeriodEndWorkday:r},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsUserDetails(e,i,t,n,a,o){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationInsightsUserDetails';if(void 0===i||null===i)throw'Missing the required parameter "filterType" when calling getGamificationInsightsUserDetails';if(void 0===t||null===t)throw'Missing the required parameter "filterId" when calling getGamificationInsightsUserDetails';if(void 0===n||null===n)throw'Missing the required parameter "granularity" when calling getGamificationInsightsUserDetails';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserDetails';if(void 0===o||null===o)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserDetails';return this.apiClient.callApi("/api/v2/gamification/insights/users/{userId}/details","GET",{userId:e},{filterType:i,filterId:t,granularity:n,comparativePeriodStartWorkday:a,primaryPeriodStartWorkday:o},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationInsightsUserTrends(e,i,t,n,a,o,r,l){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationInsightsUserTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterType" when calling getGamificationInsightsUserTrends';if(void 0===t||null===t)throw'Missing the required parameter "filterId" when calling getGamificationInsightsUserTrends';if(void 0===n||null===n)throw'Missing the required parameter "granularity" when calling getGamificationInsightsUserTrends';if(void 0===a||null===a)throw'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsUserTrends';if(void 0===o||null===o)throw'Missing the required parameter "comparativePeriodEndWorkday" when calling getGamificationInsightsUserTrends';if(void 0===r||null===r)throw'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsUserTrends';if(void 0===l||null===l)throw'Missing the required parameter "primaryPeriodEndWorkday" when calling getGamificationInsightsUserTrends';return this.apiClient.callApi("/api/v2/gamification/insights/users/{userId}/trends","GET",{userId:e},{filterType:i,filterId:t,granularity:n,comparativePeriodStartWorkday:a,comparativePeriodEndWorkday:o,primaryPeriodStartWorkday:r,primaryPeriodEndWorkday:l},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboard(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationLeaderboard';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationLeaderboard';return this.apiClient.callApi("/api/v2/gamification/leaderboard","GET",{},{startWorkday:e,endWorkday:i,metricId:t.metricId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardAll(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationLeaderboardAll';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationLeaderboardAll';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationLeaderboardAll';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationLeaderboardAll';return this.apiClient.callApi("/api/v2/gamification/leaderboard/all","GET",{},{filterType:e,filterId:i,startWorkday:t,endWorkday:n,metricId:a.metricId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardAllBestpoints(e,i){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationLeaderboardAllBestpoints';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationLeaderboardAllBestpoints';return this.apiClient.callApi("/api/v2/gamification/leaderboard/all/bestpoints","GET",{},{filterType:e,filterId:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationLeaderboardBestpoints(){return this.apiClient.callApi("/api/v2/gamification/leaderboard/bestpoints","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationMetricdefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "metricDefinitionId" when calling getGamificationMetricdefinition';return this.apiClient.callApi("/api/v2/gamification/metricdefinitions/{metricDefinitionId}","GET",{metricDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationMetricdefinitions(){return this.apiClient.callApi("/api/v2/gamification/metricdefinitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfile(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfile';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}","GET",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMembers(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMembers';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members","GET",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetric(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetric';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationProfileMetric';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/{metricId}","GET",{profileId:e,metricId:i},{workday:t.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetrics(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetrics';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics","GET",{profileId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),workday:i.workday,metricIds:i.metricIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfileMetricsObjectivedetails(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationProfileMetricsObjectivedetails';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails","GET",{profileId:e},{workday:i.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfiles(){return this.apiClient.callApi("/api/v2/gamification/profiles","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfilesUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationProfilesUser';return this.apiClient.callApi("/api/v2/gamification/profiles/users/{userId}","GET",{userId:e},{workday:i.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationProfilesUsersMe(e){return e=e||{},this.apiClient.callApi("/api/v2/gamification/profiles/users/me","GET",{},{workday:e.workday},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecards(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecards';return this.apiClient.callApi("/api/v2/gamification/scorecards","GET",{},{workday:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsAttendance(e,i){if(void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsAttendance';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsAttendance';return this.apiClient.callApi("/api/v2/gamification/scorecards/attendance","GET",{},{startWorkday:e,endWorkday:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsBestpoints(){return this.apiClient.callApi("/api/v2/gamification/scorecards/bestpoints","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsAlltime(e){if(void 0===e||null===e)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsPointsAlltime';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/alltime","GET",{},{endWorkday:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsAverage(e){if(void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecardsPointsAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/average","GET",{},{workday:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsPointsTrends(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsPointsTrends';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsPointsTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/points/trends","GET",{},{startWorkday:e,endWorkday:i,dayOfWeek:t.dayOfWeek},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricUserValuesTrends(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';if(void 0===a||null===a)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends","GET",{profileId:e,metricId:i,userId:t},{startWorkday:n,endWorkday:a,referenceWorkday:o.referenceWorkday,timeZone:o.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricUsersValuesTrends(e,i,t,n,a,o){if(o=o||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';if(void 0===a||null===a)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends","GET",{profileId:e,metricId:i},{filterType:t,filterId:o.filterId,startWorkday:n,endWorkday:a,referenceWorkday:o.referenceWorkday,timeZone:o.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsProfileMetricValuesTrends(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends","GET",{profileId:e,metricId:i},{filterType:a.filterType,startWorkday:t,endWorkday:n,referenceWorkday:a.referenceWorkday,timeZone:a.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUser';if(void 0===i||null===i)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUser';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}","GET",{userId:e},{workday:i,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserAttendance(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserAttendance';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserAttendance';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserAttendance';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/attendance","GET",{userId:e},{startWorkday:i,endWorkday:t},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserBestpoints(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserBestpoints';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/bestpoints","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserPointsAlltime(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserPointsAlltime';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserPointsAlltime';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/points/alltime","GET",{userId:e},{endWorkday:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserPointsTrends(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserPointsTrends';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserPointsTrends';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserPointsTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/points/trends","GET",{userId:e},{startWorkday:i,endWorkday:t,dayOfWeek:n.dayOfWeek},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUserValuesTrends(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getGamificationScorecardsUserValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUserValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUserValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/{userId}/values/trends","GET",{userId:e},{startWorkday:i,endWorkday:t,timeZone:n.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersPointsAverage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersPointsAverage';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersPointsAverage';if(void 0===t||null===t)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUsersPointsAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/points/average","GET",{},{filterType:e,filterId:i,workday:t},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersValuesAverage(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersValuesAverage';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersValuesAverage';if(void 0===t||null===t)throw'Missing the required parameter "workday" when calling getGamificationScorecardsUsersValuesAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/values/average","GET",{},{filterType:e,filterId:i,workday:t,timeZone:n.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsUsersValuesTrends(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "filterType" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "filterId" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===t||null===t)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsUsersValuesTrends';if(void 0===n||null===n)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsUsersValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/users/values/trends","GET",{},{filterType:e,filterId:i,startWorkday:t,endWorkday:n,timeZone:a.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsValuesAverage(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workday" when calling getGamificationScorecardsValuesAverage';return this.apiClient.callApi("/api/v2/gamification/scorecards/values/average","GET",{},{workday:e,timeZone:i.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationScorecardsValuesTrends(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "startWorkday" when calling getGamificationScorecardsValuesTrends';if(void 0===i||null===i)throw'Missing the required parameter "endWorkday" when calling getGamificationScorecardsValuesTrends';return this.apiClient.callApi("/api/v2/gamification/scorecards/values/trends","GET",{},{filterType:t.filterType,referenceWorkday:t.referenceWorkday,startWorkday:e,endWorkday:i,timeZone:t.timeZone},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationStatus(){return this.apiClient.callApi("/api/v2/gamification/status","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "templateId" when calling getGamificationTemplate';return this.apiClient.callApi("/api/v2/gamification/templates/{templateId}","GET",{templateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGamificationTemplates(){return this.apiClient.callApi("/api/v2/gamification/templates","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmployeeperformanceExternalmetricsDefinition(e,i){if(void 0===e||null===e)throw'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';return this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions/{metricId}","PATCH",{metricId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postEmployeeperformanceExternalmetricsData(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/data","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postEmployeeperformanceExternalmetricsDefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/employeeperformance/externalmetrics/definitions","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileActivate(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileActivate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/activate","POST",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileDeactivate(e){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/deactivate","POST",{profileId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMembers';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMembersValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/members/validate","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMetricLink(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';if(void 0===i||null===i)throw'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postGamificationProfileMetricLink';return this.apiClient.callApi("/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link","POST",{sourceProfileId:e,sourceMetricId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfileMetrics(e,i){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling postGamificationProfileMetrics';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfileMetrics';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics","POST",{profileId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfiles(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postGamificationProfiles';return this.apiClient.callApi("/api/v2/gamification/profiles","POST",{},{copyMetrics:i.copyMetrics},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfilesUserQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postGamificationProfilesUserQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGamificationProfilesUserQuery';return this.apiClient.callApi("/api/v2/gamification/profiles/users/{userId}/query","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGamificationProfilesUsersMeQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';return this.apiClient.callApi("/api/v2/gamification/profiles/users/me/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "profileId" when calling putGamificationProfile';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}","PUT",{profileId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationProfileMetric(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "profileId" when calling putGamificationProfileMetric';if(void 0===i||null===i)throw'Missing the required parameter "metricId" when calling putGamificationProfileMetric';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putGamificationProfileMetric';return this.apiClient.callApi("/api/v2/gamification/profiles/{profileId}/metrics/{metricId}","PUT",{profileId:e,metricId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putGamificationStatus(e){if(void 0===e||null===e)throw'Missing the required parameter "status" when calling putGamificationStatus';return this.apiClient.callApi("/api/v2/gamification/status","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class k{constructor(e){this.apiClient=e||d.instance}getGdprRequest(e){if(void 0===e||null===e)throw'Missing the required parameter "requestId" when calling getGdprRequest';return this.apiClient.callApi("/api/v2/gdpr/requests/{requestId}","GET",{requestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGdprRequests(e){return e=e||{},this.apiClient.callApi("/api/v2/gdpr/requests","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGdprSubjects(e,i){if(void 0===e||null===e)throw'Missing the required parameter "searchType" when calling getGdprSubjects';if(void 0===i||null===i)throw'Missing the required parameter "searchValue" when calling getGdprSubjects';return this.apiClient.callApi("/api/v2/gdpr/subjects","GET",{},{searchType:e,searchValue:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGdprRequests(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postGdprRequests';return this.apiClient.callApi("/api/v2/gdpr/requests","POST",{},{deleteConfirmed:i.deleteConfirmed},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class E{constructor(e){this.apiClient=e||d.instance}getGeolocationsSettings(){return this.apiClient.callApi("/api/v2/geolocations/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGeolocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","GET",{userId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchGeolocationsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchGeolocationsSettings';return this.apiClient.callApi("/api/v2/geolocations/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserGeolocation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling patchUserGeolocation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","PATCH",{userId:e,clientId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class G{constructor(e){this.apiClient=e||d.instance}deleteGreeting(e){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling deleteGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","DELETE",{greetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreeting(e){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling getGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","GET",{greetingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling getGreetingMedia';return this.apiClient.callApi("/api/v2/greetings/{greetingId}/media","GET",{greetingId:e},{formatId:i.formatId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetings(e){return e=e||{},this.apiClient.callApi("/api/v2/greetings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGreetingsDefaults(){return this.apiClient.callApi("/api/v2/greetings/defaults","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupGreetings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupGreetings';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupGreetingsDefaults';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings/defaults","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGreetings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGreetings';return this.apiClient.callApi("/api/v2/users/{userId}/greetings","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGreetingsDefaults';return this.apiClient.callApi("/api/v2/users/{userId}/greetings/defaults","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGreetings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGreetings';return this.apiClient.callApi("/api/v2/greetings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupGreetings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling postGroupGreetings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGroupGreetings';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings","POST",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserGreetings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserGreetings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserGreetings';return this.apiClient.callApi("/api/v2/users/{userId}/greetings","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putGreeting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "greetingId" when calling putGreeting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGreeting';return this.apiClient.callApi("/api/v2/greetings/{greetingId}","PUT",{greetingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putGreetingsDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putGreetingsDefaults';return this.apiClient.callApi("/api/v2/greetings/defaults","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGroupGreetingsDefaults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroupGreetingsDefaults';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGroupGreetingsDefaults';return this.apiClient.callApi("/api/v2/groups/{groupId}/greetings/defaults","PUT",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserGreetingsDefaults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserGreetingsDefaults';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';return this.apiClient.callApi("/api/v2/users/{userId}/greetings/defaults","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class U{constructor(e){this.apiClient=e||d.instance}deleteGroup(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","DELETE",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteGroupDynamicsettings(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","DELETE",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteGroupMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling deleteGroupMembers';if(void 0===i||null===i)throw'Missing the required parameter "ids" when calling deleteGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","DELETE",{groupId:e},{ids:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroup(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupDynamicsettings(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupIndividuals(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupIndividuals';return this.apiClient.callApi("/api/v2/groups/{groupId}/individuals","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getGroupProfile';return this.apiClient.callApi("/api/v2/groups/{groupId}/profile","GET",{groupId:e},{fields:i.fields},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/groups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProfilesGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/profiles/groups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling postGroupMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postGroupMembers';return this.apiClient.callApi("/api/v2/groups/{groupId}/members","POST",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postGroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroups';return this.apiClient.callApi("/api/v2/groups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsDynamicsettingsPreview(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsDynamicsettingsPreview';return this.apiClient.callApi("/api/v2/groups/dynamicsettings/preview","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putGroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroup';return this.apiClient.callApi("/api/v2/groups/{groupId}","PUT",{groupId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putGroupDynamicsettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putGroupDynamicsettings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putGroupDynamicsettings';return this.apiClient.callApi("/api/v2/groups/{groupId}/dynamicsettings","PUT",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class D{constructor(e){this.apiClient=e||d.instance}deleteIdentityprovider(e){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling deleteIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","DELETE",{providerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersAdfs(){return this.apiClient.callApi("/api/v2/identityproviders/adfs","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersCic(){return this.apiClient.callApi("/api/v2/identityproviders/cic","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersGeneric(){return this.apiClient.callApi("/api/v2/identityproviders/generic","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersGsuite(){return this.apiClient.callApi("/api/v2/identityproviders/gsuite","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersIdentitynow(){return this.apiClient.callApi("/api/v2/identityproviders/identitynow","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersOkta(){return this.apiClient.callApi("/api/v2/identityproviders/okta","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersOnelogin(){return this.apiClient.callApi("/api/v2/identityproviders/onelogin","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPing(){return this.apiClient.callApi("/api/v2/identityproviders/ping","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPurecloud(){return this.apiClient.callApi("/api/v2/identityproviders/purecloud","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersPureengage(){return this.apiClient.callApi("/api/v2/identityproviders/pureengage","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIdentityprovidersSalesforce(){return this.apiClient.callApi("/api/v2/identityproviders/salesforce","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovider(e){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling getIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","GET",{providerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityproviders(){return this.apiClient.callApi("/api/v2/identityproviders","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersAdfs(){return this.apiClient.callApi("/api/v2/identityproviders/adfs","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersCic(){return this.apiClient.callApi("/api/v2/identityproviders/cic","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersGeneric(){return this.apiClient.callApi("/api/v2/identityproviders/generic","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersGsuite(){return this.apiClient.callApi("/api/v2/identityproviders/gsuite","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersIdentitynow(){return this.apiClient.callApi("/api/v2/identityproviders/identitynow","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersOkta(){return this.apiClient.callApi("/api/v2/identityproviders/okta","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersOnelogin(){return this.apiClient.callApi("/api/v2/identityproviders/onelogin","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPing(){return this.apiClient.callApi("/api/v2/identityproviders/ping","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPurecloud(){return this.apiClient.callApi("/api/v2/identityproviders/purecloud","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersPureengage(){return this.apiClient.callApi("/api/v2/identityproviders/pureengage","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIdentityprovidersSalesforce(){return this.apiClient.callApi("/api/v2/identityproviders/salesforce","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIdentityproviders(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIdentityproviders';return this.apiClient.callApi("/api/v2/identityproviders","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovider(e,i){if(void 0===e||null===e)throw'Missing the required parameter "providerId" when calling putIdentityprovider';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIdentityprovider';return this.apiClient.callApi("/api/v2/identityproviders/{providerId}","PUT",{providerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersAdfs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersAdfs';return this.apiClient.callApi("/api/v2/identityproviders/adfs","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersCic(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersCic';return this.apiClient.callApi("/api/v2/identityproviders/cic","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersGeneric(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersGeneric';return this.apiClient.callApi("/api/v2/identityproviders/generic","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersGsuite(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersGsuite';return this.apiClient.callApi("/api/v2/identityproviders/gsuite","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersIdentitynow(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersIdentitynow';return this.apiClient.callApi("/api/v2/identityproviders/identitynow","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersOkta(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersOkta';return this.apiClient.callApi("/api/v2/identityproviders/okta","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersOnelogin(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersOnelogin';return this.apiClient.callApi("/api/v2/identityproviders/onelogin","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPing(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPing';return this.apiClient.callApi("/api/v2/identityproviders/ping","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPurecloud(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPurecloud';return this.apiClient.callApi("/api/v2/identityproviders/purecloud","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersPureengage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersPureengage';return this.apiClient.callApi("/api/v2/identityproviders/pureengage","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIdentityprovidersSalesforce(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';return this.apiClient.callApi("/api/v2/identityproviders/salesforce","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class x{constructor(e){this.apiClient=e||d.instance}getInfrastructureascodeAccelerator(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "acceleratorId" when calling getInfrastructureascodeAccelerator';return this.apiClient.callApi("/api/v2/infrastructureascode/accelerators/{acceleratorId}","GET",{acceleratorId:e},{preferredLanguage:i.preferredLanguage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeAccelerators(e){return e=e||{},this.apiClient.callApi("/api/v2/infrastructureascode/accelerators","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,description:e.description,origin:e.origin,type:e.type,classification:e.classification,tags:e.tags},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeJob(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getInfrastructureascodeJob';return this.apiClient.callApi("/api/v2/infrastructureascode/jobs/{jobId}","GET",{jobId:e},{details:i.details},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getInfrastructureascodeJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/infrastructureascode/jobs","GET",{},{maxResults:e.maxResults,includeErrors:e.includeErrors,sortBy:e.sortBy,sortOrder:e.sortOrder,acceleratorId:e.acceleratorId,submittedBy:e.submittedBy,status:e.status},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postInfrastructureascodeJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';return this.apiClient.callApi("/api/v2/infrastructureascode/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class R{constructor(e){this.apiClient=e||d.instance}deleteIntegration(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling deleteIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","DELETE",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsAction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling deleteIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","DELETE",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsActionDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling deleteIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","DELETE",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteIntegrationsCredential(e){if(void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling deleteIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","DELETE",{credentialId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","GET",{integrationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationConfigCurrent(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationConfigCurrent';return this.apiClient.callApi("/api/v2/integrations/{integrationId}/config/current","GET",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsAction(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","GET",{actionId:e},{expand:i.expand,includeConfig:i.includeConfig},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraft(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","GET",{actionId:e},{expand:i.expand,includeConfig:i.includeConfig},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftFunction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionDraftTemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftTemplate';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftTemplate';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["text/plain"])}getIntegrationsActionDraftValidation(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftValidation';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/validation","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionFunction(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/function","GET",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/schemas/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionTemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling getIntegrationsActionTemplate';if(void 0===i||null===i)throw'Missing the required parameter "fileName" when calling getIntegrationsActionTemplate';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/templates/{fileName}","GET",{actionId:e,fileName:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["text/plain"])}getIntegrationsActions(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,category:e.category,name:e.name,ids:e.ids,secure:e.secure,includeAuthActions:e.includeAuthActions},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsCategories(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/categories","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,secure:e.secure},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsCertificates(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/certificates","GET",{},{status:e.status,type:e.type},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsDrafts(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/actions/drafts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,nextPage:e.nextPage,previousPage:e.previousPage,sortBy:e.sortBy,sortOrder:e.sortOrder,category:e.category,name:e.name,ids:e.ids,secure:e.secure,includeAuthActions:e.includeAuthActions},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsActionsFunctionsRuntimes(){return this.apiClient.callApi("/api/v2/integrations/actions/functions/runtimes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBot(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBot';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsBotconnectorIntegrationIdBot';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/{botId}","GET",{integrationId:e,botId:i},{version:t.version},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBotVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBotVersions';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsBotconnectorIntegrationIdBotVersions';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions","GET",{integrationId:e,botId:i},{pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBots(e){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots","GET",{integrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsBotconnectorIntegrationIdBotsSummaries(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorIntegrationIdBotsSummaries';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots/summaries","GET",{integrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsClientapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/clientapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsClientappsUnifiedcommunications(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/clientapps/unifiedcommunications","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredential(e){if(void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling getIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","GET",{credentialId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredentials(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/credentials","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsCredentialsTypes(){return this.apiClient.callApi("/api/v2/integrations/credentials/types","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowAgent(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowAgent';return this.apiClient.callApi("/api/v2/integrations/speech/dialogflow/agents/{agentId}","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/dialogflow/agents","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowcxAgent(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowcxAgent';return this.apiClient.callApi("/api/v2/integrations/speech/dialogflowcx/agents/{agentId}","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechDialogflowcxAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/dialogflowcx/agents","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBotAlias(e){if(void 0===e||null===e)throw'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexBotAlias';return this.apiClient.callApi("/api/v2/integrations/speech/lex/bot/alias/{aliasId}","GET",{aliasId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBotBotIdAliases(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechLexBotBotIdAliases';return this.apiClient.callApi("/api/v2/integrations/speech/lex/bot/{botId}/aliases","GET",{botId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,status:i.status,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexBots(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/lex/bots","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2BotAlias(e){if(void 0===e||null===e)throw'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexv2BotAlias';return this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}","GET",{aliasId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2BotBotIdAliases(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechLexv2BotBotIdAliases';return this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bot/{botId}/aliases","GET",{botId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,status:i.status,name:i.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechLexv2Bots(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/lexv2/bots","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBot(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}","GET",{nuanceIntegrationId:e,botId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi"),targetChannel:t.targetChannel},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}","GET",{nuanceIntegrationId:e,botId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results","GET",{nuanceIntegrationId:e,botId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBots(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots","GET",{nuanceIntegrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,onlyRegisteredBots:i.onlyRegisteredBots},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}","GET",{nuanceIntegrationId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results","GET",{nuanceIntegrationId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechSttEngine(e){if(void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechSttEngine';return this.apiClient.callApi("/api/v2/integrations/speech/stt/engines/{engineId}","GET",{engineId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechSttEngines(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/stt/engines","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngine(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngine';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}","GET",{engineId:e},{includeVoices:i.includeVoices},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngineVoice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngineVoice';if(void 0===i||null===i)throw'Missing the required parameter "voiceId" when calling getIntegrationsSpeechTtsEngineVoice';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}","GET",{engineId:e,voiceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngineVoices(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechTtsEngineVoices';return this.apiClient.callApi("/api/v2/integrations/speech/tts/engines/{engineId}/voices","GET",{engineId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsEngines(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/speech/tts/engines","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,includeVoices:e.includeVoices,name:e.name,language:e.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsSpeechTtsSettings(){return this.apiClient.callApi("/api/v2/integrations/speech/tts/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsType(e){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getIntegrationsType';return this.apiClient.callApi("/api/v2/integrations/types/{typeId}","GET",{typeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsTypeConfigschema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "typeId" when calling getIntegrationsTypeConfigschema';if(void 0===i||null===i)throw'Missing the required parameter "configType" when calling getIntegrationsTypeConfigschema';return this.apiClient.callApi("/api/v2/integrations/types/{typeId}/configschemas/{configType}","GET",{typeId:e,configType:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsTypes(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/types","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUnifiedcommunicationsClientapp(e){if(void 0===e||null===e)throw'Missing the required parameter "ucIntegrationId" when calling getIntegrationsUnifiedcommunicationsClientapp';return this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}","GET",{ucIntegrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUnifiedcommunicationsClientapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/clientapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIntegrationsUserapps(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/userapps","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,appHost:e.appHost},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling patchIntegration';return this.apiClient.callApi("/api/v2/integrations/{integrationId}","PATCH",{integrationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegrationsAction(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling patchIntegrationsAction';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchIntegrationsAction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}","PATCH",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchIntegrationsActionDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling patchIntegrationsActionDraft';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","PATCH",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrations(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraft';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft","POST",{actionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftFunctionUpload(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function/upload","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftPublish(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftPublish';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftPublish';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/publish","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftTest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/test","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionExecute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/execute","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionTest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionTest';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/test","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIntegrationsActions';return this.apiClient.callApi("/api/v2/integrations/actions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionsDrafts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postIntegrationsActionsDrafts';return this.apiClient.callApi("/api/v2/integrations/actions/drafts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsCredentials(e){return e=e||{},this.apiClient.callApi("/api/v2/integrations/credentials","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';if(void 0===i||null===i)throw'Missing the required parameter "botId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs","POST",{nuanceIntegrationId:e,botId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs","POST",{nuanceIntegrationId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,onlyRegisteredBots:i.onlyRegisteredBots},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';if(void 0===i||null===i)throw'Missing the required parameter "settings" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate","POST",{nuanceIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationConfigCurrent(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling putIntegrationConfigCurrent';return this.apiClient.callApi("/api/v2/integrations/{integrationId}/config/current","PUT",{integrationId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsActionDraftFunction(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function","PUT",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsBotconnectorIntegrationIdBots(e,i){if(void 0===e||null===e)throw'Missing the required parameter "integrationId" when calling putIntegrationsBotconnectorIntegrationIdBots';if(void 0===i||null===i)throw'Missing the required parameter "botList" when calling putIntegrationsBotconnectorIntegrationIdBots';return this.apiClient.callApi("/api/v2/integrations/botconnector/{integrationId}/bots","PUT",{integrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsCredential(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "credentialId" when calling putIntegrationsCredential';return this.apiClient.callApi("/api/v2/integrations/credentials/{credentialId}","PUT",{credentialId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "nuanceIntegrationId" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';if(void 0===i||null===i)throw'Missing the required parameter "settings" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';return this.apiClient.callApi("/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings","PUT",{nuanceIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsSpeechTtsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putIntegrationsSpeechTtsSettings';return this.apiClient.callApi("/api/v2/integrations/speech/tts/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putIntegrationsUnifiedcommunicationThirdpartypresences(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';return this.apiClient.callApi("/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences","PUT",{ucIntegrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class z{constructor(e){this.apiClient=e||d.instance}deleteJourneyActionmap(e){if(void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling deleteJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","DELETE",{actionMapId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyActiontemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling deleteJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","DELETE",{actionTemplateId:e},{hardDelete:i.hardDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling deleteJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","DELETE",{outcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyOutcomesPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';return this.apiClient.callApi("/api/v2/journey/outcomes/predictors/{predictorId}","DELETE",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneySegment(e){if(void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling deleteJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","DELETE",{segmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteJourneyView(e){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling deleteJourneyView';return this.apiClient.callApi("/api/v2/journey/views/{viewId}","DELETE",{viewId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsJourneysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getExternalcontactsContactJourneySessions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';return this.apiClient.callApi("/api/v2/externalcontacts/contacts/{contactId}/journey/sessions","GET",{contactId:e},{pageSize:i.pageSize,after:i.after,includeMerged:i.includeMerged},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmap(e){if(void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling getJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","GET",{actionMapId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmaps(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actionmaps","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,filterField:e.filterField,filterValue:e.filterValue,actionMapIds:this.apiClient.buildCollectionParam(e.actionMapIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmapsEstimatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActionmapsEstimatesJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontarget(e){if(void 0===e||null===e)throw'Missing the required parameter "actionTargetId" when calling getJourneyActiontarget';return this.apiClient.callApi("/api/v2/journey/actiontargets/{actionTargetId}","GET",{actionTargetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontargets(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontargets","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling getJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","GET",{actionTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyActiontemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontemplates","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,mediaType:e.mediaType,state:e.state,queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyDeploymentCustomerPing(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';if(void 0===i||null===i)throw'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping","GET",{deploymentId:e,customerCookieId:i},{dl:t.dl,dt:t.dt,appNamespace:t.appNamespace,sessionId:t.sessionId,sinceLastBeaconMilliseconds:t.sinceLastBeaconMilliseconds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcome(e){if(void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling getJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","GET",{outcomeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,outcomeIds:this.apiClient.buildCollectionParam(e.outcomeIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesAttributionsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJob';return this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesAttributionsJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJobResults';return this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';return this.apiClient.callApi("/api/v2/journey/outcomes/predictors/{predictorId}","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyOutcomesPredictors(){return this.apiClient.callApi("/api/v2/journey/outcomes/predictors","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySegment(e){if(void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling getJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","GET",{segmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySegments(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/segments","GET",{},{sortBy:e.sortBy,pageSize:e.pageSize,pageNumber:e.pageNumber,isActive:e.isActive,segmentIds:this.apiClient.buildCollectionParam(e.segmentIds,"multi"),queryFields:this.apiClient.buildCollectionParam(e.queryFields,"multi"),queryValue:e.queryValue},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySession(e){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySession';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}","GET",{sessionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySessionEvents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySessionEvents';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}/events","GET",{sessionId:e},{pageSize:i.pageSize,after:i.after},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneySessionOutcomescores(e){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getJourneySessionOutcomescores';return this.apiClient.callApi("/api/v2/journey/sessions/{sessionId}/outcomescores","GET",{sessionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyView(e){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyView';return this.apiClient.callApi("/api/v2/journey/views/{viewId}","GET",{viewId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{versionId}","GET",{viewId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}","GET",{viewId:e,journeyVersionId:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJobResults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';if(void 0===i||null===i)throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';if(void 0===t||null===t)throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results","GET",{viewId:e,journeyViewVersion:i,jobId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewVersionJobsLatest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest","GET",{viewId:e,journeyVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViews(){return this.apiClient.callApi("/api/v2/journey/views","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewsEventdefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';return this.apiClient.callApi("/api/v2/journey/views/eventdefinitions/{eventDefinitionId}","GET",{eventDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getJourneyViewsEventdefinitions(){return this.apiClient.callApi("/api/v2/journey/views/eventdefinitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActionmap(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionMapId" when calling patchJourneyActionmap';return this.apiClient.callApi("/api/v2/journey/actionmaps/{actionMapId}","PATCH",{actionMapId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActiontarget(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTargetId" when calling patchJourneyActiontarget';return this.apiClient.callApi("/api/v2/journey/actiontargets/{actionTargetId}","PATCH",{actionTargetId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyActiontemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "actionTemplateId" when calling patchJourneyActiontemplate';return this.apiClient.callApi("/api/v2/journey/actiontemplates/{actionTemplateId}","PATCH",{actionTemplateId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneyOutcome(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "outcomeId" when calling patchJourneyOutcome';return this.apiClient.callApi("/api/v2/journey/outcomes/{outcomeId}","PATCH",{outcomeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchJourneySegment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "segmentId" when calling patchJourneySegment';return this.apiClient.callApi("/api/v2/journey/segments/{segmentId}","PATCH",{segmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsJourneysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/journeys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActionmaps(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actionmaps","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActionmapsEstimatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';return this.apiClient.callApi("/api/v2/journey/actionmaps/estimates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyActiontemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/actiontemplates","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyDeploymentActionevent(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postJourneyDeploymentActionevent';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/actionevent","POST",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyDeploymentAppevents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';return this.apiClient.callApi("/api/v2/journey/deployments/{deploymentId}/appevents","POST",{deploymentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyFlowsPathsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/flows/paths/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomes(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomesAttributionsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes/attributions/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyOutcomesPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/outcomes/predictors","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneySegments(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/segments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewVersionJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';if(void 0===i||null===i)throw'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs","POST",{viewId:e,journeyVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewVersions(e,i){if(void 0===e||null===e)throw'Missing the required parameter "viewId" when calling postJourneyViewVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postJourneyViewVersions';return this.apiClient.callApi("/api/v2/journey/views/{viewId}/versions","POST",{viewId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViews(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postJourneyViews';return this.apiClient.callApi("/api/v2/journey/views","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postJourneyViewsEncodingsValidate(e){return e=e||{},this.apiClient.callApi("/api/v2/journey/views/encodings/validate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class W{constructor(e){this.apiClient=e||d.instance}deleteKnowledgeKnowledgebase(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","DELETE",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseCategory(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","DELETE",{knowledgeBaseId:e,categoryId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","DELETE",{knowledgeBaseId:e,documentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseDocumentVariation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","DELETE",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling deleteKnowledgeKnowledgebaseExportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}","DELETE",{knowledgeBaseId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseImportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling deleteKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","DELETE",{knowledgeBaseId:e,importJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling deleteKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","DELETE",{knowledgeBaseId:e,labelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","DELETE",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","DELETE",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","DELETE",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionCategories(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionCategories';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/categories","GET",{sessionId:e},{before:i.before,after:i.after,pageSize:i.pageSize,parentId:i.parentId,isRoot:i.isRoot,name:i.name,sortBy:i.sortBy,expand:i.expand,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionDocument(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeGuestSessionDocument';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}","GET",{sessionId:e,documentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeGuestSessionDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents","GET",{sessionId:e},{categoryId:this.apiClient.buildCollectionParam(i.categoryId,"multi"),pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebase(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","GET",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseCategories(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,parentId:i.parentId,isRoot:i.isRoot,name:i.name,sortBy:i.sortBy,expand:i.expand,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseCategory(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","GET",{knowledgeBaseId:e,categoryId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocument(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","GET",{knowledgeBaseId:e,documentId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi"),state:t.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,onlyCommented:t.onlyCommented,documentVersionId:t.documentVersionId,documentVariationId:t.documentVariationId,appType:t.appType,queryType:t.queryType,userId:t.userId,queueId:t.queueId,state:t.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';if(void 0===t||null===t)throw'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}","GET",{knowledgeBaseId:e,documentId:i,feedbackId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVariation(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","GET",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{documentState:n.documentState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVariations(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,documentState:t.documentState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersion(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersion';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersion';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersion';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}","GET",{knowledgeBaseId:e,documentId:i,versionId:t},{expand:this.apiClient.buildCollectionParam(n.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersionVariation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';if(void 0===n||null===n)throw'Missing the required parameter "variationId" when calling getKnowledgeKnowledgebaseDocumentVersionVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}","GET",{knowledgeBaseId:e,documentId:i,versionId:t,variationId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersionVariations(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';if(void 0===t||null===t)throw'Missing the required parameter "versionId" when calling getKnowledgeKnowledgebaseDocumentVersionVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations","GET",{knowledgeBaseId:e,documentId:i,versionId:t},{before:n.before,after:n.after,pageSize:n.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocumentVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVersions';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVersions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions","GET",{knowledgeBaseId:e,documentId:i},{before:t.before,after:t.after,pageSize:t.pageSize,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseDocuments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,interval:i.interval,documentId:this.apiClient.buildCollectionParam(i.documentId,"multi"),categoryId:this.apiClient.buildCollectionParam(i.categoryId,"multi"),includeSubcategories:i.includeSubcategories,includeDrafts:i.includeDrafts,labelIds:this.apiClient.buildCollectionParam(i.labelIds,"multi"),expand:this.apiClient.buildCollectionParam(i.expand,"multi"),externalIds:this.apiClient.buildCollectionParam(i.externalIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseExportJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseExportJob';if(void 0===i||null===i)throw'Missing the required parameter "exportJobId" when calling getKnowledgeKnowledgebaseExportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}","GET",{knowledgeBaseId:e,exportJobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseImportJob(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling getKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","GET",{knowledgeBaseId:e,importJobId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling getKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","GET",{knowledgeBaseId:e,labelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLabels(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLabels';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,name:i.name,includeDocumentCount:i.includeDocumentCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageCategories(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategories';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,name:t.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling getKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","GET",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","GET",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocumentUpload(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';if(void 0===n||null===n)throw'Missing the required parameter "uploadId" when calling getKnowledgeKnowledgebaseLanguageDocumentUpload';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}","GET",{documentId:e,knowledgeBaseId:i,languageCode:t,uploadId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,categories:t.categories,title:t.title,sortBy:t.sortBy,sortOrder:t.sortOrder,documentIds:this.apiClient.buildCollectionParam(t.documentIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling getKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","GET",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageTraining(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTraining';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTraining';if(void 0===t||null===t)throw'Missing the required parameter "trainingId" when calling getKnowledgeKnowledgebaseLanguageTraining';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}","GET",{knowledgeBaseId:e,languageCode:i,trainingId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseLanguageTrainings(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseLanguageTrainings';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling getKnowledgeKnowledgebaseLanguageTrainings';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings","GET",{knowledgeBaseId:e,languageCode:i},{before:t.before,after:t.after,limit:t.limit,pageSize:t.pageSize,knowledgeDocumentsState:t.knowledgeDocumentsState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseOperations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations","GET",{knowledgeBaseId:e},{before:i.before,after:i.after,pageSize:i.pageSize,userId:this.apiClient.buildCollectionParam(i.userId,"multi"),type:this.apiClient.buildCollectionParam(i.type,"multi"),status:this.apiClient.buildCollectionParam(i.status,"multi"),interval:i.interval,sourceId:this.apiClient.buildCollectionParam(i.sourceId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseOperationsUsersQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query","GET",{knowledgeBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseParseJob(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}","GET",{knowledgeBaseId:e,parseJobId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}","GET",{knowledgeBaseId:e,groupId:i},{app:t.app,dateStart:t.dateStart,dateEnd:t.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===t||null===t)throw'Missing the required parameter "phraseGroupId" when calling getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}","GET",{knowledgeBaseId:e,groupId:i,phraseGroupId:t},{app:n.app,dateStart:n.dateStart,dateEnd:n.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUnansweredGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUnansweredGroups';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups","GET",{knowledgeBaseId:e},{app:i.app,dateStart:i.dateStart,dateEnd:i.dateEnd},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebaseUploadsUrlsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}","GET",{knowledgeBaseId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getKnowledgeKnowledgebases(e){return e=e||{},this.apiClient.callApi("/api/v2/knowledge/knowledgebases","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,name:e.name,coreLanguage:e.coreLanguage,published:e.published,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeGuestSessionDocumentsSearchSearchId(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';if(void 0===i||null===i)throw'Missing the required parameter "searchId" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeGuestSessionDocumentsSearchSearchId';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}","PATCH",{sessionId:e,searchId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebase(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebase';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebase';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}","PATCH",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseCategory(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseCategory';if(void 0===i||null===i)throw'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseCategory';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}","PATCH",{knowledgeBaseId:e,categoryId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocument(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocument';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocument';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}","PATCH",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocumentVariation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentVariationId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===t||null===t)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentVariation';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseDocumentVariation';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}","PATCH",{documentVariationId:e,documentId:i,knowledgeBaseId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseDocumentsSearchSearchId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';if(void 0===i||null===i)throw'Missing the required parameter "searchId" when calling patchKnowledgeKnowledgebaseDocumentsSearchSearchId';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}","PATCH",{knowledgeBaseId:e,searchId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseImportJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseImportJob';if(void 0===i||null===i)throw'Missing the required parameter "importJobId" when calling patchKnowledgeKnowledgebaseImportJob';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseImportJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}","PATCH",{knowledgeBaseId:e,importJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLabel(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLabel';if(void 0===i||null===i)throw'Missing the required parameter "labelId" when calling patchKnowledgeKnowledgebaseLabel';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLabel';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}","PATCH",{knowledgeBaseId:e,labelId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageCategory(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageCategory';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageCategory';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}","PATCH",{categoryId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocument(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocument';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocument';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}","PATCH",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocuments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","PATCH",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseLanguageDocumentsImport(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===t||null===t)throw'Missing the required parameter "importId" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseLanguageDocumentsImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}","PATCH",{knowledgeBaseId:e,languageCode:i,importId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseParseJob(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseParseJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}","PATCH",{knowledgeBaseId:e,parseJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===i||null===i)throw'Missing the required parameter "groupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===t||null===t)throw'Missing the required parameter "phraseGroupId" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}","PATCH",{knowledgeBaseId:e,groupId:i,phraseGroupId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeDocumentuploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';return this.apiClient.callApi("/api/v2/knowledge/documentuploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentCopies(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentCopies';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentCopies';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentViews(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentViews';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentViews';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views","POST",{sessionId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsPresentations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsPresentations';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations","POST",{sessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearch';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search","POST",{sessionId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessionDocumentsSearchSuggestions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsSearchSuggestions';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions","POST",{sessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeGuestSessions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeGuestSessions';return this.apiClient.callApi("/api/v2/knowledge/guest/sessions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseCategories(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentCopies(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentCopies';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentCopies';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentFeedback(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentVariations(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVariations';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVariations';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVariations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentVersions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentVersions';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentVersions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentVersions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentViews(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';if(void 0===i||null===i)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views","POST",{knowledgeBaseId:e,documentId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocuments(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocuments';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsBulkRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkRemove';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsBulkUpdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsPresentations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsPresentations';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search","POST",{knowledgeBaseId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsSearchSuggestions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsSearchSuggestions';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseExportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseExportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseExportJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseImportJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseImportJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseImportJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLabels(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLabels';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLabels';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageCategories(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageCategories';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageCategories';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageCategories';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocumentUploads(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===i||null===i)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===t||null===t)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentUploads';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads","POST",{documentId:e,knowledgeBaseId:i,languageCode:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocuments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocuments';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocuments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocuments';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageDocumentsImports(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseLanguageDocumentsImports';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageTrainingPromote(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';if(void 0===t||null===t)throw'Missing the required parameter "trainingId" when calling postKnowledgeKnowledgebaseLanguageTrainingPromote';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote","POST",{knowledgeBaseId:e,languageCode:i,trainingId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseLanguageTrainings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseLanguageTrainings';if(void 0===i||null===i)throw'Missing the required parameter "languageCode" when calling postKnowledgeKnowledgebaseLanguageTrainings';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings","POST",{knowledgeBaseId:e,languageCode:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseParseJobImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobImport';if(void 0===i||null===i)throw'Missing the required parameter "parseJobId" when calling postKnowledgeKnowledgebaseParseJobImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobImport';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import","POST",{knowledgeBaseId:e,parseJobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseParseJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseParseJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseParseJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseUploadsUrlsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebases(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class B{constructor(e){this.apiClient=e||d.instance}deleteLanguageunderstandingDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingDomainFeedbackFeedbackId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomainFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "feedbackId" when calling deleteLanguageunderstandingDomainFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}","DELETE",{domainId:e,feedbackId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingDomainVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling deleteLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","DELETE",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingMiner(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling deleteLanguageunderstandingMiner';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}","DELETE",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLanguageunderstandingMinerDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling deleteLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling deleteLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","DELETE",{minerId:e,draftId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainFeedback(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainFeedback';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback","GET",{domainId:e},{intentName:i.intentName,assessment:i.assessment,dateStart:i.dateStart,dateEnd:i.dateEnd,includeDeleted:i.includeDeleted,language:i.language,pageNumber:i.pageNumber,pageSize:i.pageSize,enableCursorPagination:i.enableCursorPagination,includeTrainingUtterances:i.includeTrainingUtterances,after:i.after,fields:this.apiClient.buildCollectionParam(i.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainFeedbackFeedbackId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainFeedbackFeedbackId';if(void 0===i||null===i)throw'Missing the required parameter "feedbackId" when calling getLanguageunderstandingDomainFeedbackFeedbackId';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}","GET",{domainId:e,feedbackId:i},{fields:this.apiClient.buildCollectionParam(t.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling getLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","GET",{domainId:e,domainVersionId:i},{includeUtterances:t.includeUtterances},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersionReport(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersionReport';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling getLanguageunderstandingDomainVersionReport';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report","GET",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomainVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getLanguageunderstandingDomainVersions';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions","GET",{domainId:e},{includeUtterances:i.includeUtterances,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/languageunderstanding/domains","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMiner(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMiner';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerDraft(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling getLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","GET",{minerId:e,draftId:i},{draftIntentId:t.draftIntentId,draftTopicId:t.draftTopicId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerDrafts(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDrafts';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerIntent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerIntent';if(void 0===i||null===i)throw'Missing the required parameter "intentId" when calling getLanguageunderstandingMinerIntent';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}","GET",{minerId:e,intentId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerIntents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerIntents';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/intents","GET",{minerId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopic(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopic';if(void 0===i||null===i)throw'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopic';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}","GET",{minerId:e,topicId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopicPhrase(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopicPhrase';if(void 0===i||null===i)throw'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopicPhrase';if(void 0===t||null===t)throw'Missing the required parameter "phraseId" when calling getLanguageunderstandingMinerTopicPhrase';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}","GET",{minerId:e,topicId:i,phraseId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMinerTopics(e){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopics';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/topics","GET",{minerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingMiners(e){return e=e||{},this.apiClient.callApi("/api/v2/languageunderstanding/miners","GET",{},{minerType:e.minerType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguageunderstandingSettings(){return this.apiClient.callApi("/api/v2/languageunderstanding/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLanguageunderstandingDomain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchLanguageunderstandingDomain';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchLanguageunderstandingDomain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchLanguageunderstandingMinerDraft(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling patchLanguageunderstandingMinerDraft';if(void 0===i||null===i)throw'Missing the required parameter "draftId" when calling patchLanguageunderstandingMinerDraft';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}","PATCH",{minerId:e,draftId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainFeedback(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainFeedback';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainFeedback';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/feedback","POST",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionDetect(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionDetect';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionDetect';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainVersionDetect';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect","POST",{domainId:e,domainVersionId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionPublish(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionPublish';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionPublish';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish","POST",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersionTrain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersionTrain';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling postLanguageunderstandingDomainVersionTrain';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train","POST",{domainId:e,domainVersionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomainVersions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomainVersions';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions","POST",{domainId:e},{includeUtterances:t.includeUtterances},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguageunderstandingDomains';return this.apiClient.callApi("/api/v2/languageunderstanding/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerDrafts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerDrafts';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingMinerDrafts';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/drafts","POST",{minerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerExecute(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerExecute';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/execute","POST",{minerId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMiners(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguageunderstandingMiners';return this.apiClient.callApi("/api/v2/languageunderstanding/miners","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putLanguageunderstandingDomainVersion(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling putLanguageunderstandingDomainVersion';if(void 0===i||null===i)throw'Missing the required parameter "domainVersionId" when calling putLanguageunderstandingDomainVersion';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';return this.apiClient.callApi("/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}","PUT",{domainId:e,domainVersionId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class L{constructor(e){this.apiClient=e||d.instance}deleteLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling deleteLanguage';return this.apiClient.callApi("/api/v2/languages/{languageId}","DELETE",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling getLanguage';return this.apiClient.callApi("/api/v2/languages/{languageId}","GET",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguages(e){return e=e||{},this.apiClient.callApi("/api/v2/languages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslations(){return this.apiClient.callApi("/api/v2/languages/translations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsBuiltin(e){if(void 0===e||null===e)throw'Missing the required parameter "language" when calling getLanguagesTranslationsBuiltin';return this.apiClient.callApi("/api/v2/languages/translations/builtin","GET",{},{language:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsOrganization(e){if(void 0===e||null===e)throw'Missing the required parameter "language" when calling getLanguagesTranslationsOrganization';return this.apiClient.callApi("/api/v2/languages/translations/organization","GET",{},{language:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLanguagesTranslationsUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getLanguagesTranslationsUser';return this.apiClient.callApi("/api/v2/languages/translations/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLanguages';return this.apiClient.callApi("/api/v2/languages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class N{constructor(e){this.apiClient=e||d.instance}deleteLearningAssignment(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling deleteLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","DELETE",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteLearningModule(e){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling deleteLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","DELETE",{moduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling getLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","GET",{assignmentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignmentStep(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';if(void 0===i||null===i)throw'Missing the required parameter "stepId" when calling getLearningAssignmentStep';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/steps/{stepId}","GET",{assignmentId:e,stepId:i},{shareableContentObjectId:t.shareableContentObjectId,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignments(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pageSize:e.pageSize,pageNumber:e.pageNumber,pass:e.pass,minPercentageScore:e.minPercentageScore,maxPercentageScore:e.maxPercentageScore,sortOrder:e.sortOrder,sortBy:e.sortBy,userId:this.apiClient.buildCollectionParam(e.userId,"multi"),types:this.apiClient.buildCollectionParam(e.types,"multi"),states:this.apiClient.buildCollectionParam(e.states,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningAssignmentsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/me","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pageSize:e.pageSize,pageNumber:e.pageNumber,pass:e.pass,minPercentageScore:e.minPercentageScore,maxPercentageScore:e.maxPercentageScore,sortOrder:e.sortOrder,sortBy:e.sortBy,types:this.apiClient.buildCollectionParam(e.types,"multi"),states:this.apiClient.buildCollectionParam(e.states,"multi"),expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","GET",{moduleId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getLearningModuleJob';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/jobs/{jobId}","GET",{moduleId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModulePreview(e){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModulePreview';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/preview","GET",{moduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleRule(e){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleRule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/rule","GET",{moduleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModuleVersion(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling getLearningModuleVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getLearningModuleVersion';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/versions/{versionId}","GET",{moduleId:e,versionId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModules(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/modules","GET",{},{isArchived:e.isArchived,types:this.apiClient.buildCollectionParam(e.types,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,sortBy:e.sortBy,searchTerm:e.searchTerm,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),isPublished:e.isPublished,statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),externalIds:this.apiClient.buildCollectionParam(e.externalIds,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModulesAssignments(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userIds" when calling getLearningModulesAssignments';return this.apiClient.callApi("/api/v2/learning/modules/assignments","GET",{},{userIds:this.apiClient.buildCollectionParam(e,"multi"),pageSize:i.pageSize,pageNumber:i.pageNumber,searchTerm:i.searchTerm,overdue:i.overdue,assignmentStates:this.apiClient.buildCollectionParam(i.assignmentStates,"multi"),expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningModulesCoverartCoverArtId(e){if(void 0===e||null===e)throw'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';return this.apiClient.callApi("/api/v2/learning/modules/coverart/{coverArtId}","GET",{coverArtId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLearningScormScormId(e){if(void 0===e||null===e)throw'Missing the required parameter "scormId" when calling getLearningScormScormId';return this.apiClient.callApi("/api/v2/learning/scorm/{scormId}","GET",{scormId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningAssignment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling patchLearningAssignment';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}","PATCH",{assignmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningAssignmentReschedule(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reschedule","PATCH",{assignmentId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningAssignmentStep(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';if(void 0===i||null===i)throw'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/steps/{stepId}","PATCH",{assignmentId:e,stepId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchLearningModuleUserAssignments(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/users/{userId}/assignments","PATCH",{moduleId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssessmentsScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningAssessmentsScoring';return this.apiClient.callApi("/api/v2/learning/assessments/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentReassign(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reassign","POST",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentReset(e){if(void 0===e||null===e)throw'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';return this.apiClient.callApi("/api/v2/learning/assignments/{assignmentId}/reset","POST",{assignmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignments(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningAssignmentsAggregatesQuery';return this.apiClient.callApi("/api/v2/learning/assignments/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsBulkadd(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/bulkadd","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningAssignmentsBulkremove(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/assignments/bulkremove","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModuleJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling postLearningModuleJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLearningModuleJobs';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/jobs","POST",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModulePublish(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling postLearningModulePublish';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/publish","POST",{moduleId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningModules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningModules';return this.apiClient.callApi("/api/v2/learning/modules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningRulesQuery(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "pageSize" when calling postLearningRulesQuery';if(void 0===i||null===i)throw'Missing the required parameter "pageNumber" when calling postLearningRulesQuery';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postLearningRulesQuery';return this.apiClient.callApi("/api/v2/learning/rules/query","POST",{},{pageSize:e,pageNumber:i},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningScheduleslotsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';return this.apiClient.callApi("/api/v2/learning/scheduleslots/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLearningScorm(e){return e=e||{},this.apiClient.callApi("/api/v2/learning/scorm","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putLearningModule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling putLearningModule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putLearningModule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}","PUT",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putLearningModulePreview(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling putLearningModulePreview';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putLearningModulePreview';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/preview","PUT",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putLearningModuleRule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "moduleId" when calling putLearningModuleRule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putLearningModuleRule';return this.apiClient.callApi("/api/v2/learning/modules/{moduleId}/rule","PUT",{moduleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class K{constructor(e){this.apiClient=e||d.instance}getLicenseDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "licenseId" when calling getLicenseDefinition';return this.apiClient.callApi("/api/v2/license/definitions/{licenseId}","GET",{licenseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseDefinitions(){return this.apiClient.callApi("/api/v2/license/definitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseToggle(e){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling getLicenseToggle';return this.apiClient.callApi("/api/v2/license/toggles/{featureName}","GET",{featureName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getLicenseUser';return this.apiClient.callApi("/api/v2/license/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLicenseUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/license/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseInfer(e){return e=e||{},this.apiClient.callApi("/api/v2/license/infer","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseOrganization(e){return e=e||{},this.apiClient.callApi("/api/v2/license/organization","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseToggle(e){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling postLicenseToggle';return this.apiClient.callApi("/api/v2/license/toggles/{featureName}","POST",{featureName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postLicenseUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/license/users","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class J{constructor(e){this.apiClient=e||d.instance}deleteLocation(e){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling deleteLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","DELETE",{locationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocation(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "locationId" when calling getLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","GET",{locationId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationSublocations(e){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling getLocationSublocations';return this.apiClient.callApi("/api/v2/locations/{locationId}/sublocations","GET",{locationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocations(e){return e=e||{},this.apiClient.callApi("/api/v2/locations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchLocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "locationId" when calling patchLocation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchLocation';return this.apiClient.callApi("/api/v2/locations/{locationId}","PATCH",{locationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLocations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocations';return this.apiClient.callApi("/api/v2/locations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postLocationsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class V{constructor(e){this.apiClient=e||d.instance}deleteDiagnosticsLogcaptureBrowserUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserEntriesDownloadJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDiagnosticsLogcaptureBrowserUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users","GET",{},{includeExpired:e.includeExpired},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/download/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserEntriesQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/entries/query","POST",{},{before:e.before,after:e.after,pageSize:e.pageSize},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postDiagnosticsLogcaptureBrowserUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';return this.apiClient.callApi("/api/v2/diagnostics/logcapture/browser/users/{userId}","POST",{userId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class F{constructor(e){this.apiClient=e||d.instance}deleteMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","DELETE",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/messaging/settings/default","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling deleteMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","DELETE",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSetting(e){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling getMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","GET",{messageSettingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/messaging/settings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSettingsDefault(){return this.apiClient.callApi("/api/v2/messaging/settings/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSupportedcontent(e){return e=e||{},this.apiClient.callApi("/api/v2/messaging/supportedcontent","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMessagingSupportedcontentSupportedContentId(e){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling getMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","GET",{supportedContentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchMessagingSetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchMessagingSetting';return this.apiClient.callApi("/api/v2/messaging/settings/{messageSettingId}","PATCH",{messageSettingId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchMessagingSupportedcontentSupportedContentId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "supportedContentId" when calling patchMessagingSupportedcontentSupportedContentId';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchMessagingSupportedcontentSupportedContentId';return this.apiClient.callApi("/api/v2/messaging/supportedcontent/{supportedContentId}","PATCH",{supportedContentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postMessagingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMessagingSettings';return this.apiClient.callApi("/api/v2/messaging/settings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postMessagingSupportedcontent(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMessagingSupportedcontent';return this.apiClient.callApi("/api/v2/messaging/supportedcontent","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putMessagingSettingsDefault(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';return this.apiClient.callApi("/api/v2/messaging/settings/default","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Q{constructor(e){this.apiClient=e||d.instance}deleteMobiledevice(e){if(void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling deleteMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","DELETE",{deviceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMobiledevice(e){if(void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling getMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","GET",{deviceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getMobiledevices(e){return e=e||{},this.apiClient.callApi("/api/v2/mobiledevices","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postMobiledevices(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postMobiledevices';return this.apiClient.callApi("/api/v2/mobiledevices","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putMobiledevice(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deviceId" when calling putMobiledevice';return this.apiClient.callApi("/api/v2/mobiledevices/{deviceId}","PUT",{deviceId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class _{constructor(e){this.apiClient=e||d.instance}deleteNotificationsChannelSubscriptions(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling deleteNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","DELETE",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsAvailabletopics(e){return e=e||{},this.apiClient.callApi("/api/v2/notifications/availabletopics","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),includePreview:e.includePreview},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsChannelSubscriptions(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling getNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","GET",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getNotificationsChannels(e){return e=e||{},this.apiClient.callApi("/api/v2/notifications/channels","GET",{},{includechannels:e.includechannels},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}headNotificationsChannel(e){if(void 0===e||null===e)throw'Missing the required parameter "channelId" when calling headNotificationsChannel';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}","HEAD",{channelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postNotificationsChannelSubscriptions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "channelId" when calling postNotificationsChannelSubscriptions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","POST",{channelId:e},{ignoreErrors:t.ignoreErrors},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postNotificationsChannels(){return this.apiClient.callApi("/api/v2/notifications/channels","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putNotificationsChannelSubscriptions(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "channelId" when calling putNotificationsChannelSubscriptions';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';return this.apiClient.callApi("/api/v2/notifications/channels/{channelId}/subscriptions","PUT",{channelId:e},{ignoreErrors:t.ignoreErrors},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class H{constructor(e){this.apiClient=e||d.instance}deleteOauthClient(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling deleteOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","DELETE",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthAuthorization(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthAuthorization';return this.apiClient.callApi("/api/v2/oauth/authorizations/{clientId}","GET",{clientId:e},{},{"Accept-Language":i.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthAuthorizations(e){return e=e||{},this.apiClient.callApi("/api/v2/oauth/authorizations","GET",{},{},{"Accept-Language":e.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClient(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","GET",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageQueryResult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getOauthClientUsageQueryResult';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}","GET",{executionId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageSummary(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClientUsageSummary';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/summary","GET",{clientId:e},{days:i.days},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClients(){return this.apiClient.callApi("/api/v2/oauth/clients","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthScope(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scopeId" when calling getOauthScope';return this.apiClient.callApi("/api/v2/oauth/scopes/{scopeId}","GET",{scopeId:e},{},{"Accept-Language":i.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthScopes(e){return e=e||{},this.apiClient.callApi("/api/v2/oauth/scopes","GET",{},{},{"Accept-Language":e.acceptLanguage},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientSecret(e){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientSecret';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/secret","POST",{clientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientUsageQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOauthClientUsageQuery';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query","POST",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClients(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOauthClients';return this.apiClient.callApi("/api/v2/oauth/clients","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOauthClient(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling putOauthClient';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOauthClient';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}","PUT",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ${constructor(e){this.apiClient=e||d.instance}deleteAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","DELETE",{divisionId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivision(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling getAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","GET",{divisionId:e},{objectCount:i.objectCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisions(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/divisions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,objectCount:e.objectCount,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsHome(){return this.apiClient.callApi("/api/v2/authorization/divisions/home","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionsLimit(){return this.apiClient.callApi("/api/v2/authorization/divisions/limit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionObject(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionObject';if(void 0===i||null===i)throw'Missing the required parameter "objectType" when calling postAuthorizationDivisionObject';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postAuthorizationDivisionObject';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/objects/{objectType}","POST",{divisionId:e,objectType:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisionRestore(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}/restore","POST",{divisionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationDivisions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAuthorizationDivisions';return this.apiClient.callApi("/api/v2/authorization/divisions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putAuthorizationDivision(e,i){if(void 0===e||null===e)throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putAuthorizationDivision';return this.apiClient.callApi("/api/v2/authorization/divisions/{divisionId}","PUT",{divisionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Z{constructor(e){this.apiClient=e||d.instance}getUsageEventsDefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "eventDefinitionId" when calling getUsageEventsDefinition';return this.apiClient.callApi("/api/v2/usage/events/definitions/{eventDefinitionId}","GET",{eventDefinitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageEventsDefinitions(){return this.apiClient.callApi("/api/v2/usage/events/definitions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class X{constructor(e){this.apiClient=e||d.instance}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsAuthenticationSettings(){return this.apiClient.callApi("/api/v2/organizations/authentication/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsEmbeddedintegration(){return this.apiClient.callApi("/api/v2/organizations/embeddedintegration","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsIpaddressauthentication(){return this.apiClient.callApi("/api/v2/organizations/ipaddressauthentication","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsChangerequest(e){if(void 0===e||null===e)throw'Missing the required parameter "requestId" when calling getOrganizationsLimitsChangerequest';return this.apiClient.callApi("/api/v2/organizations/limits/changerequests/{requestId}","GET",{requestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsChangerequests(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/limits/changerequests","GET",{},{after:e.after,before:e.before,status:e.status,pageSize:e.pageSize,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsDocs(){return this.apiClient.callApi("/api/v2/organizations/limits/docs","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsDocsFreetrial(){return this.apiClient.callApi("/api/v2/organizations/limits/docs/freetrial","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespace(e){if(void 0===e||null===e)throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespace';return this.apiClient.callApi("/api/v2/organizations/limits/namespaces/{namespaceName}","GET",{namespaceName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespaceDefaults(e){if(void 0===e||null===e)throw'Missing the required parameter "namespaceName" when calling getOrganizationsLimitsNamespaceDefaults';return this.apiClient.callApi("/api/v2/organizations/limits/namespaces/{namespaceName}/defaults","GET",{namespaceName:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsLimitsNamespaces(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/limits/namespaces","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsMe(){return this.apiClient.callApi("/api/v2/organizations/me","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrganizationsWhitelist(){return this.apiClient.callApi("/api/v2/organizations/whitelist","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchOrganizationsAuthenticationSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchOrganizationsAuthenticationSettings';return this.apiClient.callApi("/api/v2/organizations/authentication/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchOrganizationsFeature(e,i){if(void 0===e||null===e)throw'Missing the required parameter "featureName" when calling patchOrganizationsFeature';if(void 0===i||null===i)throw'Missing the required parameter "enabled" when calling patchOrganizationsFeature';return this.apiClient.callApi("/api/v2/organizations/features/{featureName}","PATCH",{featureName:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsEmbeddedintegration(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsEmbeddedintegration';return this.apiClient.callApi("/api/v2/organizations/embeddedintegration","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsIpaddressauthentication(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsIpaddressauthentication';return this.apiClient.callApi("/api/v2/organizations/ipaddressauthentication","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/organizations/me","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putOrganizationsWhitelist(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';return this.apiClient.callApi("/api/v2/organizations/whitelist","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Y{constructor(e){this.apiClient=e||d.instance}deleteOrgauthorizationTrustee(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","DELETE",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroup';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}","DELETE",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeGroupRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling deleteOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","DELETE",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrusteeUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","DELETE",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustees(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOrgauthorizationTrustees';return this.apiClient.callApi("/api/v2/orgauthorization/trustees","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustor';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}","DELETE",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","DELETE",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling deleteOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","DELETE",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","DELETE",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrgauthorizationTrustors(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOrgauthorizationTrustors';return this.apiClient.callApi("/api/v2/orgauthorization/trustors","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationPairing(e){if(void 0===e||null===e)throw'Missing the required parameter "pairingId" when calling getOrgauthorizationPairing';return this.apiClient.callApi("/api/v2/orgauthorization/pairings/{pairingId}","GET",{pairingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustee(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","GET",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeClonedusers(e){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers","GET",{trusteeOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroup';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}","GET",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroupRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling getOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","GET",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups","GET",{trusteeOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrusteeUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}","GET",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","GET",{trusteeOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteeUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users","GET",{trusteeOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustees(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustees","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi("/api/v2/orgauthorization/trustees/default","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustor(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustor';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}","GET",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","GET",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorClonedusers(e){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers","GET",{trustorOrgId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling getOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","GET",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorGroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups","GET",{trustorOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","GET",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustorUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users","GET",{trustorOrgId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrgauthorizationTrustors(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustors","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationPairings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationPairings';return this.apiClient.callApi("/api/v2/orgauthorization/pairings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteeGroups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeGroups';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteeGroups';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups","POST",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteeUsers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling postOrgauthorizationTrusteeUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteeUsers';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users","POST",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrustees(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrustees';return this.apiClient.callApi("/api/v2/orgauthorization/trustees","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteesAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteesAudits';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrusteesDefault(e){return e=e||{},this.apiClient.callApi("/api/v2/orgauthorization/trustees/default","POST",{},{assignDefaultRole:e.assignDefaultRole,autoExpire:e.autoExpire},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOrgauthorizationTrustorAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOrgauthorizationTrustorAudits';return this.apiClient.callApi("/api/v2/orgauthorization/trustor/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustee(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrustee';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOrgauthorizationTrustee';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}","PUT",{trusteeOrgId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeGroupRoledivisions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoledivisions';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoledivisions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoledivisions';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions","PUT",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeGroupRoles(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeGroupRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeGroupId" when calling putOrgauthorizationTrusteeGroupRoles';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeGroupRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles","PUT",{trusteeOrgId:e,trusteeGroupId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeUserRoledivisions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeUserRoledivisions';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrusteeUserRoledivisions';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeUserRoledivisions';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions","PUT",{trusteeOrgId:e,trusteeUserId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrusteeUserRoles(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "trusteeOrgId" when calling putOrgauthorizationTrusteeUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrusteeUserRoles';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOrgauthorizationTrusteeUserRoles';return this.apiClient.callApi("/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles","PUT",{trusteeOrgId:e,trusteeUserId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorCloneduser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}","PUT",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorGroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorGroup';if(void 0===i||null===i)throw'Missing the required parameter "trustorGroupId" when calling putOrgauthorizationTrustorGroup';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}","PUT",{trustorOrgId:e,trustorGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putOrgauthorizationTrustorUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorUser';if(void 0===i||null===i)throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';return this.apiClient.callApi("/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}","PUT",{trustorOrgId:e,trusteeUserId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class ee{constructor(e){this.apiClient=e||d.instance}deleteOutboundAttemptlimit(e){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling deleteOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","DELETE",{attemptLimitsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCallabletimeset(e){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling deleteOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","DELETE",{callableTimeSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCallanalysisresponseset(e){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling deleteOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","DELETE",{callAnalysisSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundCampaignProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/progress","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundCampaignrule(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling deleteOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","DELETE",{campaignRuleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlist(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","DELETE",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling deleteOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","DELETE",{contactListId:e,contactId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistContacts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling deleteOutboundContactlistContacts';if(void 0===i||null===i)throw'Missing the required parameter "contactIds" when calling deleteOutboundContactlistContacts';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts","DELETE",{contactListId:e},{contactIds:this.apiClient.buildCollectionParam(i,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlistfilter(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling deleteOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","DELETE",{contactListFilterId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlists(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundContactlists';return this.apiClient.callApi("/api/v2/outbound/contactlists","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlisttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","DELETE",{contactListTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundContactlisttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDigitalruleset(e){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling deleteOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","DELETE",{digitalRuleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclist(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","DELETE",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistCustomexclusioncolumns(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistCustomexclusioncolumns';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistEmailaddresses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundDnclistPhonenumbers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","DELETE",{dncListId:e},{expiredOnly:i.expiredOnly},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundFilespecificationtemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling deleteOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","DELETE",{fileSpecificationTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundFilespecificationtemplatesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundFilespecificationtemplatesBulk';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/bulk","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundImporttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","DELETE",{importTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundImporttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling deleteOutboundImporttemplates';return this.apiClient.callApi("/api/v2/outbound/importtemplates","DELETE",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundMessagingcampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundRuleset(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling deleteOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","DELETE",{ruleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling deleteOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","DELETE",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesEmailcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","DELETE",{emailCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","DELETE",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSchedulesSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling deleteOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","DELETE",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOutboundSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling deleteOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","DELETE",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundAttemptlimit(e){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling getOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","GET",{attemptLimitsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundAttemptlimits(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/attemptlimits","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallabletimeset(e){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling getOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","GET",{callableTimeSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallabletimesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/callabletimesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallanalysisresponseset(e){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling getOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","GET",{callAnalysisSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCallanalysisresponsesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignAgentownedmappingpreviewResults(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignAgentownedmappingpreviewResults';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignDiagnostics(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignDiagnostics';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/diagnostics","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignInteractions(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignInteractions';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/interactions","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignLinedistribution(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignLinedistribution';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/linedistribution","GET",{campaignId:e},{includeOnlyActiveCampaigns:i.includeOnlyActiveCampaigns,edgeGroupId:i.edgeGroupId,siteId:i.siteId,useWeight:i.useWeight,relativeWeight:i.relativeWeight,outboundLineCount:i.outboundLineCount},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/progress","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignStats(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignStats';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/stats","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignrule(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling getOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","GET",{campaignRuleId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignrules(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaignrules","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaigns(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),contactListId:e.contactListId,dncListIds:e.dncListIds,distributionQueueId:e.distributionQueueId,edgeGroupId:e.edgeGroupId,callAnalysisResponseSetId:e.callAnalysisResponseSetId,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsAll(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/all","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),mediaType:this.apiClient.buildCollectionParam(e.mediaType,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsAllDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/all/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),mediaType:this.apiClient.buildCollectionParam(e.mediaType,"multi"),sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundCampaignsDivisionview';return this.apiClient.callApi("/api/v2/outbound/campaigns/divisionviews/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundCampaignsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/campaigns/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlist(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","GET",{contactListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistContact(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling getOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","GET",{contactListId:e,contactId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistExport';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/export","GET",{contactListId:e},{download:i.download},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistImportstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistImportstatus';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/importstatus","GET",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistTimezonemappingpreview(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistTimezonemappingpreview';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview","GET",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistfilter(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling getOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","GET",{contactListFilterId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistfilters(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlistfilters","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder,contactListId:e.contactListId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlists(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlists","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistsDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling getOutboundContactlistsDivisionview';return this.apiClient.callApi("/api/v2/outbound/contactlists/divisionviews/{contactListId}","GET",{contactListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlistsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlists/divisionviews","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlisttemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","GET",{contactListTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundContactlisttemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDigitalruleset(e){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling getOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","GET",{digitalRuleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDigitalrulesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/digitalrulesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclist(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","GET",{dncListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistExport';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/export","GET",{dncListId:e},{download:i.download},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistImportstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistImportstatus';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/importstatus","GET",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclists(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/dnclists","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,dncSourceType:e.dncSourceType,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistsDivisionview(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling getOutboundDnclistsDivisionview';return this.apiClient.callApi("/api/v2/outbound/dnclists/divisionviews/{dncListId}","GET",{dncListId:e},{includeImportStatus:i.includeImportStatus,includeSize:i.includeSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundDnclistsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/dnclists/divisionviews","GET",{},{includeImportStatus:e.includeImportStatus,includeSize:e.includeSize,pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,name:e.name,dncSourceType:e.dncSourceType,id:this.apiClient.buildCollectionParam(e.id,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundEvent(e){if(void 0===e||null===e)throw'Missing the required parameter "eventId" when calling getOutboundEvent';return this.apiClient.callApi("/api/v2/outbound/events/{eventId}","GET",{eventId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundEvents(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/events","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,filterType:e.filterType,category:e.category,level:e.level,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundFilespecificationtemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling getOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","GET",{fileSpecificationTemplateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundFilespecificationtemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","GET",{importTemplateId:e},{includeImportStatus:i.includeImportStatus},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplateImportstatus(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}/importstatus","GET",{importTemplateId:e},{listNamePrefix:i.listNamePrefix},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundImporttemplates(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/importtemplates","GET",{},{includeImportStatus:e.includeImportStatus,pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder,contactListTemplateId:e.contactListTemplateId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignDiagnostics(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignDiagnostics';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaigns(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/messagingcampaigns","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,contactListId:e.contactListId,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),type:e.type,senderSmsPhoneNumber:e.senderSmsPhoneNumber,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignsDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundMessagingcampaignsDivisionview';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundMessagingcampaignsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name,type:e.type,id:this.apiClient.buildCollectionParam(e.id,"multi"),senderSmsPhoneNumber:e.senderSmsPhoneNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundRuleset(e){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling getOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","GET",{ruleSetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundRulesets(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/rulesets","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesCampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling getOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","GET",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesCampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesEmailcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","GET",{emailCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesEmailcampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesMessagingcampaign(e){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","GET",{messagingCampaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesMessagingcampaigns(){return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling getOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","GET",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSchedulesSequences(){return this.apiClient.callApi("/api/v2/outbound/schedules/sequences","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSequence(e){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling getOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","GET",{sequenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSequences(e){return e=e||{},this.apiClient.callApi("/api/v2/outbound/sequences","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,allowEmptyResult:e.allowEmptyResult,filterType:e.filterType,name:e.name,sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundSettings(){return this.apiClient.callApi("/api/v2/outbound/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOutboundWrapupcodemappings(){return this.apiClient.callApi("/api/v2/outbound/wrapupcodemappings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistCustomexclusioncolumns(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistCustomexclusioncolumns';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistCustomexclusioncolumns';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistEmailaddresses(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistEmailaddresses';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundDnclistPhonenumbers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","PATCH",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchOutboundSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchOutboundSettings';return this.apiClient.callApi("/api/v2/outbound/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundAttemptlimits(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundAttemptlimits';return this.apiClient.callApi("/api/v2/outbound/attemptlimits","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundAudits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundAudits';return this.apiClient.callApi("/api/v2/outbound/audits","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,sortOrder:i.sortOrder,facetsOnly:i.facetsOnly},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCallabletimesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCallabletimesets';return this.apiClient.callApi("/api/v2/outbound/callabletimesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCallanalysisresponsesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCallanalysisresponsesets';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignAgentownedmappingpreview(e){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling postOutboundCampaignAgentownedmappingpreview';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview","POST",{campaignId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignCallbackSchedule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundCampaignCallbackSchedule';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/callback/schedule","POST",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignrules(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaignrules';return this.apiClient.callApi("/api/v2/outbound/campaignrules","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaigns(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaigns';return this.apiClient.callApi("/api/v2/outbound/campaigns","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundCampaignsProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundCampaignsProgress';return this.apiClient.callApi("/api/v2/outbound/campaigns/progress","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistClear(e){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistClear';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/clear","POST",{contactListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContacts(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContacts';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContacts';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts","POST",{contactListId:e},{priority:t.priority,clearSystemData:t.clearSystemData,doNotQueue:t.doNotQueue},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulk';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulkRemove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkRemove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkRemove';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsBulkUpdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsBulkUpdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsBulkUpdate';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistContactsSearch(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistContactsSearch';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundContactlistContactsSearch';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/search","POST",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling postOutboundContactlistExport';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/export","POST",{contactListId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfilters(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfilters';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfiltersBulkRetrieve(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfiltersBulkRetrieve';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/bulk/retrieve","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlistfiltersPreview(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlistfiltersPreview';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/preview","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlists(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlists';return this.apiClient.callApi("/api/v2/outbound/contactlists","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplates';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplatesBulkAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/bulk/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundContactlisttemplatesBulkRetrieve(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkRetrieve';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/bulk/retrieve","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundConversationDnc(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postOutboundConversationDnc';return this.apiClient.callApi("/api/v2/outbound/conversations/{conversationId}/dnc","POST",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDigitalrulesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundDigitalrulesets';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistEmailaddresses(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/emailaddresses","POST",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistExport(e){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistExport';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/export","POST",{dncListId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclistPhonenumbers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOutboundDnclistPhonenumbers';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}/phonenumbers","POST",{dncListId:e},{expirationDateTime:t.expirationDateTime},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundDnclists(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundDnclists';return this.apiClient.callApi("/api/v2/outbound/dnclists","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundFilespecificationtemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundFilespecificationtemplates';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundImporttemplates(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundImporttemplates';return this.apiClient.callApi("/api/v2/outbound/importtemplates","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundImporttemplatesBulkAdd(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';return this.apiClient.callApi("/api/v2/outbound/importtemplates/bulk/add","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundMessagingcampaigns(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundMessagingcampaigns';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundMessagingcampaignsProgress(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundMessagingcampaignsProgress';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/progress","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundRulesets(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundRulesets';return this.apiClient.callApi("/api/v2/outbound/rulesets","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postOutboundSequences(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postOutboundSequences';return this.apiClient.callApi("/api/v2/outbound/sequences","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundAttemptlimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "attemptLimitsId" when calling putOutboundAttemptlimit';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundAttemptlimit';return this.apiClient.callApi("/api/v2/outbound/attemptlimits/{attemptLimitsId}","PUT",{attemptLimitsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCallabletimeset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "callableTimeSetId" when calling putOutboundCallabletimeset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCallabletimeset';return this.apiClient.callApi("/api/v2/outbound/callabletimesets/{callableTimeSetId}","PUT",{callableTimeSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCallanalysisresponseset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "callAnalysisSetId" when calling putOutboundCallanalysisresponseset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCallanalysisresponseset';return this.apiClient.callApi("/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}","PUT",{callAnalysisSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundCampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCampaign';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}","PUT",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaignAgent(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundCampaignAgent';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling putOutboundCampaignAgent';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOutboundCampaignAgent';return this.apiClient.callApi("/api/v2/outbound/campaigns/{campaignId}/agents/{userId}","PUT",{campaignId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundCampaignrule(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignRuleId" when calling putOutboundCampaignrule';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundCampaignrule';return this.apiClient.callApi("/api/v2/outbound/campaignrules/{campaignRuleId}","PUT",{campaignRuleId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlist(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling putOutboundContactlist';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlist';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}","PUT",{contactListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlistContact(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "contactListId" when calling putOutboundContactlistContact';if(void 0===i||null===i)throw'Missing the required parameter "contactId" when calling putOutboundContactlistContact';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putOutboundContactlistContact';return this.apiClient.callApi("/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}","PUT",{contactListId:e,contactId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlistfilter(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlistfilter';return this.apiClient.callApi("/api/v2/outbound/contactlistfilters/{contactListFilterId}","PUT",{contactListFilterId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundContactlisttemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundContactlisttemplate';return this.apiClient.callApi("/api/v2/outbound/contactlisttemplates/{contactListTemplateId}","PUT",{contactListTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundDigitalruleset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "digitalRuleSetId" when calling putOutboundDigitalruleset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundDigitalruleset';return this.apiClient.callApi("/api/v2/outbound/digitalrulesets/{digitalRuleSetId}","PUT",{digitalRuleSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundDnclist(e,i){if(void 0===e||null===e)throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundDnclist';return this.apiClient.callApi("/api/v2/outbound/dnclists/{dncListId}","PUT",{dncListId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundFilespecificationtemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "fileSpecificationTemplateId" when calling putOutboundFilespecificationtemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundFilespecificationtemplate';return this.apiClient.callApi("/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}","PUT",{fileSpecificationTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundImporttemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundImporttemplate';return this.apiClient.callApi("/api/v2/outbound/importtemplates/{importTemplateId}","PUT",{importTemplateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundMessagingcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling putOutboundMessagingcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/messagingcampaigns/{messagingCampaignId}","PUT",{messagingCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundRuleset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "ruleSetId" when calling putOutboundRuleset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundRuleset';return this.apiClient.callApi("/api/v2/outbound/rulesets/{ruleSetId}","PUT",{ruleSetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesCampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "campaignId" when calling putOutboundSchedulesCampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesCampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/campaigns/{campaignId}","PUT",{campaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesEmailcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}","PUT",{emailCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesMessagingcampaign(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';return this.apiClient.callApi("/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}","PUT",{messagingCampaignId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSchedulesSequence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling putOutboundSchedulesSequence';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSchedulesSequence';return this.apiClient.callApi("/api/v2/outbound/schedules/sequences/{sequenceId}","PUT",{sequenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundSequence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sequenceId" when calling putOutboundSequence';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putOutboundSequence';return this.apiClient.callApi("/api/v2/outbound/sequences/{sequenceId}","PUT",{sequenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putOutboundWrapupcodemappings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';return this.apiClient.callApi("/api/v2/outbound/wrapupcodemappings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class ie{constructor(e){this.apiClient=e||d.instance}deletePresenceDefinition0(e){if(void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","DELETE",{definitionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deletePresenceSource(e){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling deletePresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","DELETE",{sourceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deletePresencedefinition(e){if(void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling deletePresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","DELETE",{presenceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceDefinition0(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling getPresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","GET",{definitionId:e},{localeCode:i.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceDefinitions0(e){return e=e||{},this.apiClient.callApi("/api/v2/presence/definitions","GET",{},{deactivated:e.deactivated,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),localeCode:e.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSettings(){return this.apiClient.callApi("/api/v2/presence/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSource(e){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling getPresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","GET",{sourceId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceSources(e){return e=e||{},this.apiClient.callApi("/api/v2/presence/sources","GET",{},{deactivated:e.deactivated},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresenceUserPrimarysource(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getPresenceUserPrimarysource';return this.apiClient.callApi("/api/v2/presence/users/{userId}/primarysource","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresencedefinition(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling getPresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","GET",{presenceId:e},{localeCode:i.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getPresencedefinitions(e){return e=e||{},this.apiClient.callApi("/api/v2/presencedefinitions","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,deleted:e.deleted,localeCode:e.localeCode},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSystempresences(){return this.apiClient.callApi("/api/v2/systempresences","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserPresence(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserPresence';if(void 0===i||null===i)throw'Missing the required parameter "sourceId" when calling getUserPresence';return this.apiClient.callApi("/api/v2/users/{userId}/presences/{sourceId}","GET",{userId:e,sourceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserPresencesPurecloud(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserPresencesPurecloud';return this.apiClient.callApi("/api/v2/users/{userId}/presences/purecloud","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersPresenceBulk(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';return this.apiClient.callApi("/api/v2/users/presences/{sourceId}/bulk","GET",{sourceId:e},{id:this.apiClient.buildCollectionParam(i.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersPresencesPurecloudBulk(e){return e=e||{},this.apiClient.callApi("/api/v2/users/presences/purecloud/bulk","GET",{},{id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserPresence(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserPresence';if(void 0===i||null===i)throw'Missing the required parameter "sourceId" when calling patchUserPresence';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserPresence';return this.apiClient.callApi("/api/v2/users/{userId}/presences/{sourceId}","PATCH",{userId:e,sourceId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserPresencesPurecloud(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserPresencesPurecloud';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserPresencesPurecloud';return this.apiClient.callApi("/api/v2/users/{userId}/presences/purecloud","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postPresenceDefinitions0(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresenceDefinitions0';return this.apiClient.callApi("/api/v2/presence/definitions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postPresenceSources(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresenceSources';return this.apiClient.callApi("/api/v2/presence/sources","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postPresencedefinitions(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postPresencedefinitions';return this.apiClient.callApi("/api/v2/presencedefinitions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceDefinition0(e,i){if(void 0===e||null===e)throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceDefinition0';return this.apiClient.callApi("/api/v2/presence/definitions/{definitionId}","PUT",{definitionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putPresenceSettings';return this.apiClient.callApi("/api/v2/presence/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceSource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sourceId" when calling putPresenceSource';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceSource';return this.apiClient.callApi("/api/v2/presence/sources/{sourceId}","PUT",{sourceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresenceUserPrimarysource(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putPresenceUserPrimarysource';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresenceUserPrimarysource';return this.apiClient.callApi("/api/v2/presence/users/{userId}/primarysource","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putPresencedefinition(e,i){if(void 0===e||null===e)throw'Missing the required parameter "presenceId" when calling putPresencedefinition';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putPresencedefinition';return this.apiClient.callApi("/api/v2/presencedefinitions/{presenceId}","PUT",{presenceId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUsersPresencesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putUsersPresencesBulk';return this.apiClient.callApi("/api/v2/users/presences/bulk","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class te{constructor(e){this.apiClient=e||d.instance}deleteProcessautomationTrigger(e){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","DELETE",{triggerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTrigger(e){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","GET",{triggerId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTriggers(e){return e=e||{},this.apiClient.callApi("/api/v2/processautomation/triggers","GET",{},{before:e.before,after:e.after,pageSize:e.pageSize,topicName:e.topicName,enabled:e.enabled,hasDelayBy:e.hasDelayBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProcessautomationTriggersTopics(e){return e=e||{},this.apiClient.callApi("/api/v2/processautomation/triggers/topics","GET",{},{before:e.before,after:e.after,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggerTest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}/test","POST",{triggerId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postProcessautomationTriggers';return this.apiClient.callApi("/api/v2/processautomation/triggers","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postProcessautomationTriggersTopicTest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';return this.apiClient.callApi("/api/v2/processautomation/triggers/topics/{topicName}/test","POST",{topicName:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putProcessautomationTrigger(e,i){if(void 0===e||null===e)throw'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putProcessautomationTrigger';return this.apiClient.callApi("/api/v2/processautomation/triggers/{triggerId}","PUT",{triggerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ne{constructor(e){this.apiClient=e||d.instance}deleteQualityCalibration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling deleteQualityCalibration';if(void 0===i||null===i)throw'Missing the required parameter "calibratorId" when calling deleteQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","DELETE",{calibrationId:e},{calibratorId:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityConversationEvaluation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling deleteQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","DELETE",{conversationId:e,evaluationId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityForm(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityFormsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteQualityFormsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling deleteQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","DELETE",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsEvaluationsAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsSurveysAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityAgentsActivity(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/agents/activity","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,startTime:e.startTime,endTime:e.endTime,agentUserId:this.apiClient.buildCollectionParam(e.agentUserId,"multi"),evaluatorUserId:e.evaluatorUserId,name:e.name,group:e.group,agentTeamId:e.agentTeamId,formContextId:e.formContextId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityCalibration(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling getQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","GET",{calibrationId:e},{calibratorId:i.calibratorId,conversationId:i.conversationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityCalibrations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "calibratorId" when calling getQualityCalibrations';return this.apiClient.callApi("/api/v2/quality/calibrations","GET",{},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortBy:i.sortBy,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),nextPage:i.nextPage,previousPage:i.previousPage,conversationId:i.conversationId,startTime:i.startTime,endTime:i.endTime,calibratorId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationEvaluation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling getQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","GET",{conversationId:e,evaluationId:i},{expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getQualityConversationSurveys';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/surveys","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationsAuditsQueryTransactionId(e){if(void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getQualityConversationsAuditsQueryTransactionId';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query/{transactionId}","GET",{transactionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityConversationsAuditsQueryTransactionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "transactionId" when calling getQualityConversationsAuditsQueryTransactionIdResults';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query/{transactionId}/results","GET",{transactionId:e},{cursor:i.cursor,pageSize:i.pageSize,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityEvaluationsQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/evaluations/query","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,conversationId:e.conversationId,agentUserId:e.agentUserId,agentTeamId:e.agentTeamId,evaluatorUserId:e.evaluatorUserId,assigneeUserId:e.assigneeUserId,queueId:e.queueId,startTime:e.startTime,endTime:e.endTime,formContextId:e.formContextId,evaluationState:this.apiClient.buildCollectionParam(e.evaluationState,"multi"),isReleased:e.isReleased,agentHasRead:e.agentHasRead,expandAnswerTotalScores:e.expandAnswerTotalScores,maximum:e.maximum,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityEvaluatorsActivity(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/evaluators/activity","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,startTime:e.startTime,endTime:e.endTime,name:e.name,permission:this.apiClient.buildCollectionParam(e.permission,"multi"),group:e.group,agentTeamId:e.agentTeamId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityForm(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormVersions';return this.apiClient.callApi("/api/v2/quality/forms/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityForms(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluationVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsEvaluationVersions';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluations(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms/evaluations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsEvaluationsBulkContexts(e){if(void 0===e||null===e)throw'Missing the required parameter "contextId" when calling getQualityFormsEvaluationsBulkContexts';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/bulk/contexts","GET",{},{contextId:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveyVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityFormsSurveyVersions';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}/versions","GET",{formId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveys(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/forms/surveys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,nextPage:e.nextPage,previousPage:e.previousPage,expand:e.expand,name:e.name,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveysBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "id" when calling getQualityFormsSurveysBulk';return this.apiClient.callApi("/api/v2/quality/forms/surveys/bulk","GET",{},{id:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityFormsSurveysBulkContexts(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "contextId" when calling getQualityFormsSurveysBulkContexts';return this.apiClient.callApi("/api/v2/quality/forms/surveys/bulk/contexts","GET",{},{contextId:this.apiClient.buildCollectionParam(e,"multi"),published:i.published},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedform(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedform';return this.apiClient.callApi("/api/v2/quality/publishedforms/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedforms(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestPerContext:e.onlyLatestPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsEvaluation(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedformsEvaluation';return this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsEvaluations(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestPerContext:e.onlyLatestPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsSurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling getQualityPublishedformsSurvey';return this.apiClient.callApi("/api/v2/quality/publishedforms/surveys/{formId}","GET",{formId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualityPublishedformsSurveys(e){return e=e||{},this.apiClient.callApi("/api/v2/quality/publishedforms/surveys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,onlyLatestEnabledPerContext:e.onlyLatestEnabledPerContext},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualitySurvey(e){if(void 0===e||null===e)throw'Missing the required parameter "surveyId" when calling getQualitySurvey';return this.apiClient.callApi("/api/v2/quality/surveys/{surveyId}","GET",{surveyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getQualitySurveysScorable(e){if(void 0===e||null===e)throw'Missing the required parameter "customerSurveyUrl" when calling getQualitySurveysScorable';return this.apiClient.callApi("/api/v2/quality/surveys/scorable","GET",{},{customerSurveyUrl:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchQualityFormsSurvey(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling patchQualityFormsSurvey';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","PATCH",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsEvaluationsAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/evaluations/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsSurveysAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/surveys/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityCalibrations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityCalibrations';return this.apiClient.callApi("/api/v2/quality/calibrations","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityConversationEvaluations(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postQualityConversationEvaluations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postQualityConversationEvaluations';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations","POST",{conversationId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityConversationsAuditsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityConversationsAuditsQuery';return this.apiClient.callApi("/api/v2/quality/conversations/audits/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityEvaluationsAggregatesQueryMe(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityEvaluationsAggregatesQueryMe';return this.apiClient.callApi("/api/v2/quality/evaluations/aggregates/query/me","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityEvaluationsScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityEvaluationsScoring';return this.apiClient.callApi("/api/v2/quality/evaluations/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityForms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityForms';return this.apiClient.callApi("/api/v2/quality/forms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityFormsEvaluations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityFormsEvaluations';return this.apiClient.callApi("/api/v2/quality/forms/evaluations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityFormsSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityFormsSurveys';return this.apiClient.callApi("/api/v2/quality/forms/surveys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedforms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedforms';return this.apiClient.callApi("/api/v2/quality/publishedforms","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedformsEvaluations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedformsEvaluations';return this.apiClient.callApi("/api/v2/quality/publishedforms/evaluations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualityPublishedformsSurveys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualityPublishedformsSurveys';return this.apiClient.callApi("/api/v2/quality/publishedforms/surveys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postQualitySurveysScoring(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postQualitySurveysScoring';return this.apiClient.callApi("/api/v2/quality/surveys/scoring","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityCalibration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "calibrationId" when calling putQualityCalibration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityCalibration';return this.apiClient.callApi("/api/v2/quality/calibrations/{calibrationId}","PUT",{calibrationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityConversationEvaluation(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putQualityConversationEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "evaluationId" when calling putQualityConversationEvaluation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putQualityConversationEvaluation';return this.apiClient.callApi("/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}","PUT",{conversationId:e,evaluationId:i},{expand:n.expand},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityForm(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityForm';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityForm';return this.apiClient.callApi("/api/v2/quality/forms/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityFormsEvaluation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityFormsEvaluation';return this.apiClient.callApi("/api/v2/quality/forms/evaluations/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualityFormsSurvey(e,i){if(void 0===e||null===e)throw'Missing the required parameter "formId" when calling putQualityFormsSurvey';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualityFormsSurvey';return this.apiClient.callApi("/api/v2/quality/forms/surveys/{formId}","PUT",{formId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putQualitySurveysScorable(e,i){if(void 0===e||null===e)throw'Missing the required parameter "customerSurveyUrl" when calling putQualitySurveysScorable';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putQualitySurveysScorable';return this.apiClient.callApi("/api/v2/quality/surveys/scorable","PUT",{},{customerSurveyUrl:e},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ae{constructor(e){this.apiClient=e||d.instance}deleteConversationRecordingAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling deleteConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling deleteConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","DELETE",{conversationId:e,recordingId:i,annotationId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteOrphanrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling deleteOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","DELETE",{orphanId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingCrossplatformMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "ids" when calling deleteRecordingCrossplatformMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","DELETE",{},{ids:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingCrossplatformMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling deleteRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","DELETE",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "ids" when calling deleteRecordingMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","DELETE",{},{ids:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRecordingMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling deleteRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","DELETE",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecording(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecording';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecording';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}","GET",{conversationId:e,recordingId:i},{formatId:t.formatId,emailFormatId:t.emailFormatId,chatFormatId:t.chatFormatId,messageFormatId:t.messageFormatId,download:t.download,fileName:t.fileName,locale:t.locale,mediaFormats:this.apiClient.buildCollectionParam(t.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingAnnotation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling getConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","GET",{conversationId:e,recordingId:i,annotationId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingAnnotations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingAnnotations';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations","GET",{conversationId:e,recordingId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingmetadata(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingmetadata';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordingmetadata","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordingmetadataRecordingId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordingmetadataRecordingId';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling getConversationRecordingmetadataRecordingId';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}","GET",{conversationId:e,recordingId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getConversationRecordings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getConversationRecordings';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings","GET",{conversationId:e},{maxWaitMs:i.maxWaitMs,formatId:i.formatId,mediaFormats:this.apiClient.buildCollectionParam(i.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling getOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","GET",{orphanId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecordingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling getOrphanrecordingMedia';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}/media","GET",{orphanId:e},{formatId:i.formatId,emailFormatId:i.emailFormatId,chatFormatId:i.chatFormatId,messageFormatId:i.messageFormatId,download:i.download,fileName:i.fileName,locale:i.locale,mediaFormats:this.apiClient.buildCollectionParam(i.mediaFormats,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOrphanrecordings(e){return e=e||{},this.apiClient.callApi("/api/v2/orphanrecordings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,hasConversation:e.hasConversation,media:e.media},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingBatchrequest(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingBatchrequest';return this.apiClient.callApi("/api/v2/recording/batchrequests/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingCrossplatformMediaretentionpolicies(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,enabled:e.enabled,summary:e.summary,hasErrors:e.hasErrors,deleteDaysThreshold:e.deleteDaysThreshold},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingCrossplatformMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","GET",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJobFailedrecordings(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRecordingJobFailedrecordings';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}/failedrecordings","GET",{jobId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,includeTotal:i.includeTotal,cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/jobs","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,state:e.state,showOnlyMyJobs:e.showOnlyMyJobs,jobType:e.jobType,includeTotal:e.includeTotal,cursor:e.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingKeyconfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/{keyConfigurationId}","GET",{keyConfigurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingKeyconfigurations(){return this.apiClient.callApi("/api/v2/recording/keyconfigurations","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingMediaretentionpolicies(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),nextPage:e.nextPage,previousPage:e.previousPage,name:e.name,enabled:e.enabled,summary:e.summary,hasErrors:e.hasErrors,deleteDaysThreshold:e.deleteDaysThreshold},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingMediaretentionpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","GET",{policyId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingRecordingkeys(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/recordingkeys","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingRecordingkeysRotationschedule(){return this.apiClient.callApi("/api/v2/recording/recordingkeys/rotationschedule","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/recording/settings","GET",{},{createDefault:e.createDefault},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingUploadsReport(e){if(void 0===e||null===e)throw'Missing the required parameter "reportId" when calling getRecordingUploadsReport';return this.apiClient.callApi("/api/v2/recording/uploads/reports/{reportId}","GET",{reportId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsRetentionQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "retentionThresholdDays" when calling getRecordingsRetentionQuery';return this.apiClient.callApi("/api/v2/recordings/retention/query","GET",{},{retentionThresholdDays:e,cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsScreensessions(e){return e=e||{},this.apiClient.callApi("/api/v2/recordings/screensessions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRecordingsScreensessionsDetails(){return this.apiClient.callApi("/api/v2/recordings/screensessions/details","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingCrossplatformMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling patchRecordingCrossplatformMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","PATCH",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling patchRecordingMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","PATCH",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRecordingsScreensession(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';return this.apiClient.callApi("/api/v2/recordings/screensessions/{recordingSessionId}","PATCH",{recordingSessionId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationRecordingAnnotations(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postConversationRecordingAnnotations';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling postConversationRecordingAnnotations';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postConversationRecordingAnnotations';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations","POST",{conversationId:e,recordingId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingBatchrequests(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingBatchrequests';return this.apiClient.callApi("/api/v2/recording/batchrequests","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingCrossplatformMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingCrossplatformMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingJobs';return this.apiClient.callApi("/api/v2/recording/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingKeyconfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingKeyconfigurations';return this.apiClient.callApi("/api/v2/recording/keyconfigurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingKeyconfigurationsValidate(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/validate","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingLocalkeys(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingLocalkeys';return this.apiClient.callApi("/api/v2/recording/localkeys","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingMediaretentionpolicies(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingMediaretentionpolicies';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingRecordingkeys(){return this.apiClient.callApi("/api/v2/recording/recordingkeys","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingUploadsReports(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingUploadsReports';return this.apiClient.callApi("/api/v2/recording/uploads/reports","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsDeletionprotection(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsDeletionprotection';return this.apiClient.callApi("/api/v2/recordings/deletionprotection","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsScreensessionsAcknowledge(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsScreensessionsAcknowledge';return this.apiClient.callApi("/api/v2/recordings/screensessions/acknowledge","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRecordingsScreensessionsMetadata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRecordingsScreensessionsMetadata';return this.apiClient.callApi("/api/v2/recordings/screensessions/metadata","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationRecording(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationRecording';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling putConversationRecording';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putConversationRecording';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}","PUT",{conversationId:e,recordingId:i},{clearExport:n.clearExport},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putConversationRecordingAnnotation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling putConversationRecordingAnnotation';if(void 0===i||null===i)throw'Missing the required parameter "recordingId" when calling putConversationRecordingAnnotation';if(void 0===t||null===t)throw'Missing the required parameter "annotationId" when calling putConversationRecordingAnnotation';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling putConversationRecordingAnnotation';return this.apiClient.callApi("/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}","PUT",{conversationId:e,recordingId:i,annotationId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}putOrphanrecording(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "orphanId" when calling putOrphanrecording';return this.apiClient.callApi("/api/v2/orphanrecordings/{orphanId}","PUT",{orphanId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingCrossplatformMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling putRecordingCrossplatformMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingCrossplatformMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}","PUT",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling putRecordingJob';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingJob';return this.apiClient.callApi("/api/v2/recording/jobs/{jobId}","PUT",{jobId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingKeyconfiguration(e,i){if(void 0===e||null===e)throw'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingKeyconfiguration';return this.apiClient.callApi("/api/v2/recording/keyconfigurations/{keyConfigurationId}","PUT",{keyConfigurationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingMediaretentionpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "policyId" when calling putRecordingMediaretentionpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRecordingMediaretentionpolicy';return this.apiClient.callApi("/api/v2/recording/mediaretentionpolicies/{policyId}","PUT",{policyId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingRecordingkeysRotationschedule(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRecordingRecordingkeysRotationschedule';return this.apiClient.callApi("/api/v2/recording/recordingkeys/rotationschedule","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRecordingSettings';return this.apiClient.callApi("/api/v2/recording/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRecordingsDeletionprotection(e){return e=e||{},this.apiClient.callApi("/api/v2/recordings/deletionprotection","PUT",{},{protect:e.protect},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class oe{constructor(e){this.apiClient=e||d.instance}deleteResponsemanagementLibrary(e){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling deleteResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","DELETE",{libraryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteResponsemanagementResponse(e){if(void 0===e||null===e)throw'Missing the required parameter "responseId" when calling deleteResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","DELETE",{responseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteResponsemanagementResponseasset(e){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling deleteResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","DELETE",{responseAssetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementLibraries(e){return e=e||{},this.apiClient.callApi("/api/v2/responsemanagement/libraries","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,messagingTemplateFilter:e.messagingTemplateFilter,libraryPrefix:e.libraryPrefix},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementLibrary(e){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling getResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","GET",{libraryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponse(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "responseId" when calling getResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","GET",{responseId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponseasset(e){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling getResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","GET",{responseAssetId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponseassetsStatusStatusId(e){if(void 0===e||null===e)throw'Missing the required parameter "statusId" when calling getResponsemanagementResponseassetsStatusStatusId';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/status/{statusId}","GET",{statusId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getResponsemanagementResponses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling getResponsemanagementResponses';return this.apiClient.callApi("/api/v2/responsemanagement/responses","GET",{},{libraryId:e,pageNumber:i.pageNumber,pageSize:i.pageSize,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementLibraries(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementLibraries';return this.apiClient.callApi("/api/v2/responsemanagement/libraries","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementLibrariesBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementLibrariesBulk';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/bulk","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponseassetsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponseassetsSearch';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/search","POST",{},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponseassetsUploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponseassetsUploads';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/uploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponses';return this.apiClient.callApi("/api/v2/responsemanagement/responses","POST",{},{expand:i.expand},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postResponsemanagementResponsesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postResponsemanagementResponsesQuery';return this.apiClient.callApi("/api/v2/responsemanagement/responses/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementLibrary(e,i){if(void 0===e||null===e)throw'Missing the required parameter "libraryId" when calling putResponsemanagementLibrary';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementLibrary';return this.apiClient.callApi("/api/v2/responsemanagement/libraries/{libraryId}","PUT",{libraryId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementResponse(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "responseId" when calling putResponsemanagementResponse';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementResponse';return this.apiClient.callApi("/api/v2/responsemanagement/responses/{responseId}","PUT",{responseId:e},{expand:t.expand},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putResponsemanagementResponseasset(e,i){if(void 0===e||null===e)throw'Missing the required parameter "responseAssetId" when calling putResponsemanagementResponseasset';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';return this.apiClient.callApi("/api/v2/responsemanagement/responseassets/{responseAssetId}","PUT",{responseAssetId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class re{constructor(e){this.apiClient=e||d.instance}deleteRoutingAssessment(e){if(void 0===e||null===e)throw'Missing the required parameter "assessmentId" when calling deleteRoutingAssessment';return this.apiClient.callApi("/api/v2/routing/assessments/{assessmentId}","DELETE",{assessmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailDomainRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling deleteRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling deleteRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","DELETE",{domainName:e,routeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingEmailOutboundDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}","DELETE",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling deleteRoutingLanguage';return this.apiClient.callApi("/api/v2/routing/languages/{languageId}","DELETE",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling deleteRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","DELETE",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueue(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","DELETE",{queueId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteRoutingQueueMember';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members/{memberId}","DELETE",{queueId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueUser';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteRoutingQueueUser';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users/{memberId}","DELETE",{queueId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingQueueWrapupcode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling deleteRoutingQueueWrapupcode';if(void 0===i||null===i)throw'Missing the required parameter "codeId" when calling deleteRoutingQueueWrapupcode';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}","DELETE",{queueId:e,codeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSettings(){return this.apiClient.callApi("/api/v2/routing/settings","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSkill(e){if(void 0===e||null===e)throw'Missing the required parameter "skillId" when calling deleteRoutingSkill';return this.apiClient.callApi("/api/v2/routing/skills/{skillId}","DELETE",{skillId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSkillgroup(e){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling deleteRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","DELETE",{skillGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSmsAddress(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling deleteRoutingSmsAddress';return this.apiClient.callApi("/api/v2/routing/sms/addresses/{addressId}","DELETE",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingSmsPhonenumber(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","DELETE",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilization(){return this.apiClient.callApi("/api/v2/routing/utilization","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilizationLabel(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","DELETE",{labelId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUtilizationTag(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}","DELETE",{tagId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingWrapupcode(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling deleteRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","DELETE",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutinglanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","DELETE",{userId:e,languageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutingskill(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling deleteUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","DELETE",{userId:e,skillId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessment(e){if(void 0===e||null===e)throw'Missing the required parameter "assessmentId" when calling getRoutingAssessment';return this.apiClient.callApi("/api/v2/routing/assessments/{assessmentId}","GET",{assessmentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessments(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,queueId:this.apiClient.buildCollectionParam(e.queueId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessmentsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getRoutingAssessmentsJob';return this.apiClient.callApi("/api/v2/routing/assessments/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAssessmentsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments/jobs","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingAvailablemediatypes(){return this.apiClient.callApi("/api/v2/routing/availablemediatypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomainRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling getRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","GET",{domainName:e,routeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomainRoutes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainName" when calling getRoutingEmailDomainRoutes';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes","GET",{domainName:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,pattern:i.pattern},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/email/domains","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,excludeStatus:e.excludeStatus,filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomain(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomain';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomainActivation(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainActivation';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/activation","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomainSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling getRoutingEmailOutboundDomainSearch';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/search","GET",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailOutboundDomains(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/email/outbound/domains","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingEmailSetup(){return this.apiClient.callApi("/api/v2/routing/email/setup","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingLanguage(e){if(void 0===e||null===e)throw'Missing the required parameter "languageId" when calling getRoutingLanguage';return this.apiClient.callApi("/api/v2/routing/languages/{languageId}","GET",{languageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingLanguages(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/languages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingMessageRecipient(e){if(void 0===e||null===e)throw'Missing the required parameter "recipientId" when calling getRoutingMessageRecipient';return this.apiClient.callApi("/api/v2/routing/message/recipients/{recipientId}","GET",{recipientId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingMessageRecipients(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/message/recipients","GET",{},{messengerType:e.messengerType,name:e.name,pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictor(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorModelFeatures(e,i){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictorModelFeatures';if(void 0===i||null===i)throw'Missing the required parameter "modelId" when calling getRoutingPredictorModelFeatures';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}/models/{modelId}/features","GET",{predictorId:e,modelId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorModels(e){if(void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling getRoutingPredictorModels';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}/models","GET",{predictorId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors","GET",{},{before:e.before,after:e.after,limit:e.limit,pageSize:e.pageSize,queueId:this.apiClient.buildCollectionParam(e.queueId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingPredictorsKeyperformanceindicators(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors/keyperformanceindicators","GET",{},{kpiGroup:e.kpiGroup,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueue(e){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","GET",{queueId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueComparisonperiod(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueComparisonperiod';if(void 0===i||null===i)throw'Missing the required parameter "comparisonPeriodId" when calling getRoutingQueueComparisonperiod';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}","GET",{queueId:e,comparisonPeriodId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueComparisonperiods(e){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueComparisonperiods';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/comparisonperiods","GET",{queueId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueEstimatedwaittime(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueEstimatedwaittime';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/estimatedwaittime","GET",{queueId:e},{conversationId:i.conversationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueMediatypeEstimatedwaittime(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';if(void 0===i||null===i)throw'Missing the required parameter "mediaType" when calling getRoutingQueueMediatypeEstimatedwaittime';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime","GET",{queueId:e,mediaType:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","GET",{queueId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),name:i.name,profileSkills:this.apiClient.buildCollectionParam(i.profileSkills,"multi"),skills:this.apiClient.buildCollectionParam(i.skills,"multi"),languages:this.apiClient.buildCollectionParam(i.languages,"multi"),routingStatus:this.apiClient.buildCollectionParam(i.routingStatus,"multi"),presence:this.apiClient.buildCollectionParam(i.presence,"multi"),memberBy:i.memberBy,joined:i.joined},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueUsers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","GET",{queueId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),joined:i.joined,name:i.name,profileSkills:this.apiClient.buildCollectionParam(i.profileSkills,"multi"),skills:this.apiClient.buildCollectionParam(i.skills,"multi"),languages:this.apiClient.buildCollectionParam(i.languages,"multi"),routingStatus:this.apiClient.buildCollectionParam(i.routingStatus,"multi"),presence:this.apiClient.buildCollectionParam(i.presence,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueueWrapupcodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getRoutingQueueWrapupcodes';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes","GET",{queueId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueues(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),peerId:this.apiClient.buildCollectionParam(e.peerId,"multi"),cannedResponseLibraryId:e.cannedResponseLibraryId,hasPeer:e.hasPeer},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesDivisionviewsAll(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/divisionviews/all","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingQueuesMe(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/queues/me","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,joined:e.joined,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettings(){return this.apiClient.callApi("/api/v2/routing/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettingsContactcenter(){return this.apiClient.callApi("/api/v2/routing/settings/contactcenter","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSettingsTranscription(){return this.apiClient.callApi("/api/v2/routing/settings/transcription","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkill(e){if(void 0===e||null===e)throw'Missing the required parameter "skillId" when calling getRoutingSkill';return this.apiClient.callApi("/api/v2/routing/skills/{skillId}","GET",{skillId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroup(e){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","GET",{skillGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroupMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembers';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members","GET",{skillGroupId:e},{pageSize:i.pageSize,after:i.after,before:i.before,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroupMembersDivisions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling getRoutingSkillgroupMembersDivisions';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members/divisions","GET",{skillGroupId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkillgroups(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/skillgroups","GET",{},{pageSize:e.pageSize,name:e.name,after:e.after,before:e.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSkills(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/skills","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAddress(e){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling getRoutingSmsAddress';return this.apiClient.callApi("/api/v2/routing/sms/addresses/{addressId}","GET",{addressId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAddresses(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/sms/addresses","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsAvailablephonenumbers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "countryCode" when calling getRoutingSmsAvailablephonenumbers';if(void 0===i||null===i)throw'Missing the required parameter "phoneNumberType" when calling getRoutingSmsAvailablephonenumbers';return this.apiClient.callApi("/api/v2/routing/sms/availablephonenumbers","GET",{},{countryCode:e,region:t.region,city:t.city,areaCode:t.areaCode,phoneNumberType:i,pattern:t.pattern,addressRequirement:t.addressRequirement},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsPhonenumber(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "addressId" when calling getRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","GET",{addressId:e},{expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingSmsPhonenumbers(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/sms/phonenumbers","GET",{},{phoneNumber:e.phoneNumber,phoneNumberType:this.apiClient.buildCollectionParam(e.phoneNumberType,"multi"),phoneNumberStatus:this.apiClient.buildCollectionParam(e.phoneNumberStatus,"multi"),countryCode:this.apiClient.buildCollectionParam(e.countryCode,"multi"),pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,language:e.language,"integration.id":e.integrationId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilization(){return this.apiClient.callApi("/api/v2/routing/utilization","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabel(e){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","GET",{labelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabelAgents(e){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}/agents","GET",{labelId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationLabels(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/utilization/labels","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTag(e){if(void 0===e||null===e)throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}","GET",{tagId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTagAgents(e){if(void 0===e||null===e)throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';return this.apiClient.callApi("/api/v2/routing/utilization/tags/{tagId}/agents","GET",{tagId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUtilizationTags(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/utilization/tags","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcode(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling getRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","GET",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodes(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/wrapupcodes","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodesDivisionview(e){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/divisionviews/{codeId}","GET",{codeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingWrapupcodesDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/wrapupcodes/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,id:this.apiClient.buildCollectionParam(e.id,"multi"),divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi"),includeState:e.includeState},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserQueues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,joined:i.joined,divisionId:this.apiClient.buildCollectionParam(i.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutinglanguages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingskills(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSkillgroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSkillgroups';return this.apiClient.callApi("/api/v2/users/{userId}/skillgroups","GET",{userId:e},{pageSize:i.pageSize,after:i.after,before:i.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingConversation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchRoutingConversation';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingConversation';return this.apiClient.callApi("/api/v2/routing/conversations/{conversationId}","PATCH",{conversationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingEmailDomain(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchRoutingEmailDomain';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingEmailDomain';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingEmailDomainValidate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling patchRoutingEmailDomainValidate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingEmailDomainValidate';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}/validate","PATCH",{domainId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingPredictor(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "predictorId" when calling patchRoutingPredictor';return this.apiClient.callApi("/api/v2/routing/predictors/{predictorId}","PATCH",{predictorId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueMember(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling patchRoutingQueueMember';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchRoutingQueueMember';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members/{memberId}","PATCH",{queueId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","PATCH",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueUser(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueUser';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling patchRoutingQueueUser';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchRoutingQueueUser';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users/{memberId}","PATCH",{queueId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingQueueUsers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchRoutingQueueUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","PATCH",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSettingsContactcenter(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchRoutingSettingsContactcenter';return this.apiClient.callApi("/api/v2/routing/settings/contactcenter","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSettingsTranscription(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';return this.apiClient.callApi("/api/v2/routing/settings/transcription","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchRoutingSkillgroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling patchRoutingSkillgroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchRoutingSkillgroup';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}","PATCH",{skillGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchUserQueue';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchUserQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserQueue';return this.apiClient.callApi("/api/v2/users/{userId}/queues/{queueId}","PATCH",{queueId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserQueues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","PATCH",{userId:e},{divisionId:this.apiClient.buildCollectionParam(t.divisionId,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","PATCH",{userId:e,languageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguagesBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsQueuesObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/queues/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsRoutingActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';return this.apiClient.callApi("/api/v2/analytics/routing/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingAssessments(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingAssessmentsJobs(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/assessments/jobs","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomainRoutes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling postRoutingEmailDomainRoutes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingEmailDomainRoutes';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes","POST",{domainName:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomainTestconnection(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "domainId" when calling postRoutingEmailDomainTestconnection';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainId}/testconnection","POST",{domainId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailDomains';return this.apiClient.callApi("/api/v2/routing/email/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailOutboundDomains(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailOutboundDomains';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingEmailOutboundDomainsSimulated(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/simulated","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingLanguages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingLanguages';return this.apiClient.callApi("/api/v2/routing/languages","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingPredictors(e){return e=e||{},this.apiClient.callApi("/api/v2/routing/predictors","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueMembers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueMembers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/members","POST",{queueId:e},{delete:t._delete},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueUsers(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueUsers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueUsers';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/users","POST",{queueId:e},{delete:t._delete},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueueWrapupcodes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling postRoutingQueueWrapupcodes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postRoutingQueueWrapupcodes';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}/wrapupcodes","POST",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingQueues(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingQueues';return this.apiClient.callApi("/api/v2/routing/queues","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkillgroupMembersDivisions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "skillGroupId" when calling postRoutingSkillgroupMembersDivisions';return this.apiClient.callApi("/api/v2/routing/skillgroups/{skillGroupId}/members/divisions","POST",{skillGroupId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkillgroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSkillgroups';return this.apiClient.callApi("/api/v2/routing/skillgroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSkills(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSkills';return this.apiClient.callApi("/api/v2/routing/skills","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsAddresses(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsAddresses';return this.apiClient.callApi("/api/v2/routing/sms/addresses","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbersAlphanumeric(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersAlphanumeric';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/alphanumeric","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingSmsPhonenumbersImport(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersImport';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/import","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingUtilizationLabels(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';return this.apiClient.callApi("/api/v2/routing/utilization/labels","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingUtilizationTags(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingUtilizationTags';return this.apiClient.callApi("/api/v2/routing/utilization/tags","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postRoutingWrapupcodes(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postRoutingWrapupcodes';return this.apiClient.callApi("/api/v2/routing/wrapupcodes","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutinglanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutingskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutingskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingEmailDomainRoute(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "domainName" when calling putRoutingEmailDomainRoute';if(void 0===i||null===i)throw'Missing the required parameter "routeId" when calling putRoutingEmailDomainRoute';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putRoutingEmailDomainRoute';return this.apiClient.callApi("/api/v2/routing/email/domains/{domainName}/routes/{routeId}","PUT",{domainName:e,routeId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingEmailOutboundDomainActivation(e){if(void 0===e||null===e)throw'Missing the required parameter "domainId" when calling putRoutingEmailOutboundDomainActivation';return this.apiClient.callApi("/api/v2/routing/email/outbound/domains/{domainId}/activation","PUT",{domainId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingMessageRecipient(e,i){if(void 0===e||null===e)throw'Missing the required parameter "recipientId" when calling putRoutingMessageRecipient';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingMessageRecipient';return this.apiClient.callApi("/api/v2/routing/message/recipients/{recipientId}","PUT",{recipientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingQueue(e,i){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling putRoutingQueue';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingQueue';return this.apiClient.callApi("/api/v2/routing/queues/{queueId}","PUT",{queueId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingSettings';return this.apiClient.callApi("/api/v2/routing/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSettingsTranscription(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingSettingsTranscription';return this.apiClient.callApi("/api/v2/routing/settings/transcription","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingSmsPhonenumber(e,i){if(void 0===e||null===e)throw'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';return this.apiClient.callApi("/api/v2/routing/sms/phonenumbers/{addressId}","PUT",{addressId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUserUtilization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putRoutingUserUtilization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putRoutingUtilization';return this.apiClient.callApi("/api/v2/routing/utilization","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUtilizationLabel(e,i){if(void 0===e||null===e)throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUtilizationLabel';return this.apiClient.callApi("/api/v2/routing/utilization/labels/{labelId}","PUT",{labelId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingWrapupcode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "codeId" when calling putRoutingWrapupcode';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingWrapupcode';return this.apiClient.callApi("/api/v2/routing/wrapupcodes/{codeId}","PUT",{codeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskill(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling putUserRoutingskill';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","PUT",{userId:e,skillId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class le{constructor(e){this.apiClient=e||d.instance}deleteScimUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","DELETE",{userId:e},{},{"If-Match":i.ifMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}deleteScimV2User(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","DELETE",{userId:e},{},{"If-Match":i.ifMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimGroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","GET",{groupId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimGroups(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/groups","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimResourcetype(e){if(void 0===e||null===e)throw'Missing the required parameter "resourceType" when calling getScimResourcetype';return this.apiClient.callApi("/api/v2/scim/resourcetypes/{resourceType}","GET",{resourceType:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimResourcetypes(){return this.apiClient.callApi("/api/v2/scim/resourcetypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getScimSchema';return this.apiClient.callApi("/api/v2/scim/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimSchemas(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/schemas","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimServiceproviderconfig(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/serviceproviderconfig","GET",{},{},{"If-None-Match":e.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","GET",{userId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/users","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Group(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","GET",{groupId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Groups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "filter" when calling getScimV2Groups';return this.apiClient.callApi("/api/v2/scim/v2/groups","GET",{},{startIndex:i.startIndex,count:i.count,attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi"),filter:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Resourcetype(e){if(void 0===e||null===e)throw'Missing the required parameter "resourceType" when calling getScimV2Resourcetype';return this.apiClient.callApi("/api/v2/scim/v2/resourcetypes/{resourceType}","GET",{resourceType:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Resourcetypes(){return this.apiClient.callApi("/api/v2/scim/v2/resourcetypes","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Schema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getScimV2Schema';return this.apiClient.callApi("/api/v2/scim/v2/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Schemas(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/schemas","GET",{},{filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Serviceproviderconfig(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/serviceproviderconfig","GET",{},{},{"If-None-Match":e.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2User(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","GET",{userId:e},{attributes:this.apiClient.buildCollectionParam(i.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(i.excludedAttributes,"multi")},{"If-None-Match":i.ifNoneMatch},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}getScimV2Users(e){return e=e||{},this.apiClient.callApi("/api/v2/scim/v2/users","GET",{},{startIndex:e.startIndex,count:e.count,attributes:this.apiClient.buildCollectionParam(e.attributes,"multi"),excludedAttributes:this.apiClient.buildCollectionParam(e.excludedAttributes,"multi"),filter:e.filter},{},{},null,["PureCloud OAuth"],["application/json"],["application/scim+json","application/json"])}patchScimGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchScimGroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","PATCH",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchScimUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","PATCH",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimV2Group(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchScimV2Group';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","PATCH",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}patchScimV2User(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchScimV2User';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","PATCH",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}postScimUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postScimUsers';return this.apiClient.callApi("/api/v2/scim/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}postScimV2Users(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postScimV2Users';return this.apiClient.callApi("/api/v2/scim/v2/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimGroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putScimGroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimGroup';return this.apiClient.callApi("/api/v2/scim/groups/{groupId}","PUT",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimUser(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling putScimUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimUser';return this.apiClient.callApi("/api/v2/scim/users/{userId}","PUT",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimV2Group(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling putScimV2Group';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimV2Group';return this.apiClient.callApi("/api/v2/scim/v2/groups/{groupId}","PUT",{groupId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}putScimV2User(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling putScimV2User';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putScimV2User';return this.apiClient.callApi("/api/v2/scim/v2/users/{userId}","PUT",{userId:e},{},{"If-Match":t.ifMatch},{},i,["PureCloud OAuth"],["application/scim+json","application/json"],["application/scim+json","application/json"])}}class se{constructor(e){this.apiClient=e||d.instance}postScreenrecordingToken(e){return e=e||{},this.apiClient.callApi("/api/v2/screenrecording/token","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class pe{constructor(e){this.apiClient=e||d.instance}getScript(e){if(void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScript';return this.apiClient.callApi("/api/v2/scripts/{scriptId}","GET",{scriptId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptPage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptPage';if(void 0===i||null===i)throw'Missing the required parameter "pageId" when calling getScriptPage';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/pages/{pageId}","GET",{scriptId:e,pageId:i},{scriptDataVersion:t.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptPages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptPages';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/pages","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScripts(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,sortBy:e.sortBy,sortOrder:e.sortOrder,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,sortBy:e.sortBy,sortOrder:e.sortOrder,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublished(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published/divisionviews","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,name:e.name,feature:e.feature,flowId:e.flowId,scriptDataVersion:e.scriptDataVersion,divisionIds:e.divisionIds},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptId';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdPage(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdPage';if(void 0===i||null===i)throw'Missing the required parameter "pageId" when calling getScriptsPublishedScriptIdPage';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/pages/{pageId}","GET",{scriptId:e,pageId:i},{scriptDataVersion:t.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdPages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdPages';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/pages","GET",{scriptId:e},{scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsPublishedScriptIdVariables(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling getScriptsPublishedScriptIdVariables';return this.apiClient.callApi("/api/v2/scripts/published/{scriptId}/variables","GET",{scriptId:e},{input:i.input,output:i.output,type:i.type,scriptDataVersion:i.scriptDataVersion},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getScriptsUploadStatus(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "uploadId" when calling getScriptsUploadStatus';return this.apiClient.callApi("/api/v2/scripts/uploads/{uploadId}/status","GET",{uploadId:e},{longPoll:i.longPoll},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postScriptExport(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "scriptId" when calling postScriptExport';return this.apiClient.callApi("/api/v2/scripts/{scriptId}/export","POST",{scriptId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postScriptsPublished(e){return e=e||{},this.apiClient.callApi("/api/v2/scripts/published","POST",{},{scriptDataVersion:e.scriptDataVersion},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class ue{constructor(e){this.apiClient=e||d.instance}getDocumentationGknSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "q64" when calling getDocumentationGknSearch';return this.apiClient.callApi("/api/v2/documentation/gkn/search","GET",{},{q64:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getDocumentationSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "q64" when calling getDocumentationSearch';return this.apiClient.callApi("/api/v2/documentation/search","GET",{},{q64:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getGroupsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getLocationsSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearch';return this.apiClient.callApi("/api/v2/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getUsersSearch';return this.apiClient.callApi("/api/v2/users/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsConversationsTranscriptsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';return this.apiClient.callApi("/api/v2/analytics/conversations/transcripts/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postConversationsParticipantsAttributesSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';return this.apiClient.callApi("/api/v2/conversations/participants/attributes/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationAllSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationAllSearch';return this.apiClient.callApi("/api/v2/documentation/all/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationGknSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationGknSearch';return this.apiClient.callApi("/api/v2/documentation/gkn/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postDocumentationSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postDocumentationSearch';return this.apiClient.callApi("/api/v2/documentation/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postGroupsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postGroupsSearch';return this.apiClient.callApi("/api/v2/groups/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search","POST",{knowledgeBaseId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postLocationsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postLocationsSearch';return this.apiClient.callApi("/api/v2/locations/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearch';return this.apiClient.callApi("/api/v2/search","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTranscriptsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';return this.apiClient.callApi("/api/v2/speechandtextanalytics/transcripts/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeamsSearch';return this.apiClient.callApi("/api/v2/teams/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearch';return this.apiClient.callApi("/api/v2/users/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchConversationTarget(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchConversationTarget';return this.apiClient.callApi("/api/v2/users/search/conversation/target","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchQueuemembersManage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';return this.apiClient.callApi("/api/v2/users/search/queuemembers/manage","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchTeamsAssign(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';return this.apiClient.callApi("/api/v2/users/search/teams/assign","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class de{constructor(e){this.apiClient=e||d.instance}getEmailsSettings(){return this.apiClient.callApi("/api/v2/emails/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSettingsExecutiondata(){return this.apiClient.callApi("/api/v2/settings/executiondata","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchEmailsSettings(e){return e=e||{},this.apiClient.callApi("/api/v2/emails/settings","PATCH",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchSettingsExecutiondata(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';return this.apiClient.callApi("/api/v2/settings/executiondata","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class ce{constructor(e){this.apiClient=e||d.instance}deleteSpeechandtextanalyticsCategory(e){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';return this.apiClient.callApi("/api/v2/speechandtextanalytics/categories/{categoryId}","DELETE",{categoryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","DELETE",{dictionaryFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsProgram(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "programId" when calling deleteSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","DELETE",{programId:e},{forceDelete:i.forceDelete},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsSentimentfeedback(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}","DELETE",{sentimentFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteSpeechandtextanalyticsTopic(e){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling deleteSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","DELETE",{topicId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsCategories(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/categories","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,sortOrder:e.sortOrder,sortBy:e.sortBy,ids:this.apiClient.buildCollectionParam(e.ids,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsCategory(e){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';return this.apiClient.callApi("/api/v2/speechandtextanalytics/categories/{categoryId}","GET",{categoryId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversation';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversationCategories(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}/categories","GET",{conversationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversationCommunicationTranscripturl(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturl';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturl';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsConversationCommunicationTranscripturls(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';return this.apiClient.callApi("/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsDictionaryfeedback(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback","GET",{},{dialect:e.dialect,nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e){if(void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","GET",{dictionaryFeedbackId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgram(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramMappings(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramMappings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/mappings","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramTranscriptionengines(e){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramTranscriptionengines';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines","GET",{programId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsPrograms(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize,state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsGeneralJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsProgramsGeneralJob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsMappings(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/mappings","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsPublishjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsProgramsPublishjob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsTranscriptionenginesDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsProgramsUnpublished(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/unpublished","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSentimentDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentiment/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSentimentfeedback(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsSettings(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopic(e){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling getSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","GET",{topicId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopics(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics","GET",{},{nextPage:e.nextPage,pageSize:e.pageSize,state:e.state,name:e.name,ids:this.apiClient.buildCollectionParam(e.ids,"multi"),dialects:this.apiClient.buildCollectionParam(e.dialects,"multi"),sortBy:e.sortBy,sortOrder:e.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsDialects(){return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/dialects","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsGeneral(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/general","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsGeneralStatus(e){return e=e||{},this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/general/status","GET",{},{dialect:e.dialect},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSpeechandtextanalyticsTopicsPublishjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsPublishjob';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchSpeechandtextanalyticsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchSpeechandtextanalyticsSettings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsCategories(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';return this.apiClient.callApi("/api/v2/speechandtextanalytics/categories","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsDictionaryfeedback(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsDictionaryfeedback';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsPrograms(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsPrograms';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsProgramsGeneralJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsProgramsGeneralJobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/general/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsProgramsPublishjobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsProgramsPublishjobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/publishjobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsSentimentfeedback(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';return this.apiClient.callApi("/api/v2/speechandtextanalytics/sentimentfeedback","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTopics(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopics';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTopicsPublishjobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopicsPublishjobs';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/publishjobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSpeechandtextanalyticsTranscriptsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';return this.apiClient.callApi("/api/v2/speechandtextanalytics/transcripts/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsCategory(e,i){if(void 0===e||null===e)throw'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';return this.apiClient.callApi("/api/v2/speechandtextanalytics/categories/{categoryId}","PUT",{categoryId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "dictionaryFeedbackId" when calling putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';return this.apiClient.callApi("/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}","PUT",{dictionaryFeedbackId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgram(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgram';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgram';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgramMappings(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramMappings';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramMappings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/mappings","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsProgramTranscriptionengines(e,i){if(void 0===e||null===e)throw'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramTranscriptionengines';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramTranscriptionengines';return this.apiClient.callApi("/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines","PUT",{programId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsSettings';return this.apiClient.callApi("/api/v2/speechandtextanalytics/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putSpeechandtextanalyticsTopic(e,i){if(void 0===e||null===e)throw'Missing the required parameter "topicId" when calling putSpeechandtextanalyticsTopic';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';return this.apiClient.callApi("/api/v2/speechandtextanalytics/topics/{topicId}","PUT",{topicId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ge{constructor(e){this.apiClient=e||d.instance}deleteStationAssociateduser(e){if(void 0===e||null===e)throw'Missing the required parameter "stationId" when calling deleteStationAssociateduser';return this.apiClient.callApi("/api/v2/stations/{stationId}/associateduser","DELETE",{stationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getStation(e){if(void 0===e||null===e)throw'Missing the required parameter "stationId" when calling getStation';return this.apiClient.callApi("/api/v2/stations/{stationId}","GET",{stationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getStations(e){return e=e||{},this.apiClient.callApi("/api/v2/stations","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,name:e.name,userSelectable:e.userSelectable,webRtcUserId:e.webRtcUserId,id:e.id,lineAppearanceId:e.lineAppearanceId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class he{constructor(e){this.apiClient=e||d.instance}getSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearch';return this.apiClient.callApi("/api/v2/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),profile:i.profile},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearch';return this.apiClient.callApi("/api/v2/search","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postSearchSuggest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postSearchSuggest';return this.apiClient.callApi("/api/v2/search/suggest","POST",{},{profile:i.profile},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class me{constructor(e){this.apiClient=e||d.instance}deleteTaskmanagementWorkbin(e){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling deleteTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","DELETE",{workbinId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorkitem(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling deleteTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","DELETE",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorkitemsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling deleteTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","DELETE",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorktype(e){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","DELETE",{worktypeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTaskmanagementWorktypeStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling deleteTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","DELETE",{worktypeId:e,statusId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbin(e){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","GET",{workbinId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinHistory';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/history","GET",{workbinId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkbinVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}","GET",{workbinId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkbinVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling getTaskmanagementWorkbinVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}/versions","GET",{workbinId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitem(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","GET",{workitemId:e},{expands:i.expands},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemHistory';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/history","GET",{workitemId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemUserWrapups(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemUserWrapups';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getTaskmanagementWorkitemUserWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups","GET",{workitemId:e,userId:i},{expands:t.expands,after:t.after,pageSize:t.pageSize,sortOrder:t.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorkitemVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}","GET",{workitemId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/versions","GET",{workitemId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemWrapups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitemWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/wrapups","GET",{workitemId:e},{expands:i.expands,after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsQueryJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJob';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsQueryJobResults(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getTaskmanagementWorkitemsQueryJobResults';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchema(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemaVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getTaskmanagementWorkitemsSchemaVersion';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}","GET",{schemaId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemaVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling getTaskmanagementWorkitemsSchemaVersions';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions","GET",{schemaId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorkitemsSchemas(){return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktype(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","GET",{worktypeId:e},{expands:this.apiClient.buildCollectionParam(i.expands,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeHistory(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/history","GET",{worktypeId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeStatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling getTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","GET",{worktypeId:e,statusId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeStatuses(e){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatuses';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses","GET",{worktypeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersion';if(void 0===i||null===i)throw'Missing the required parameter "entityVersion" when calling getTaskmanagementWorktypeVersion';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}","GET",{worktypeId:e,entityVersion:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTaskmanagementWorktypeVersions(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeVersions';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/versions","GET",{worktypeId:e},{after:i.after,pageSize:i.pageSize,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkbin(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workbinId" when calling patchTaskmanagementWorkbin';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkbin';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/{workbinId}","PATCH",{workbinId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitem(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitem';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitem';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemAssignment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemAssignment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemAssignment';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/assignment","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemUserWrapups(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUserWrapups';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchTaskmanagementWorkitemUserWrapups';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUserWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups","PATCH",{workitemId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorkitemUsersMeWrapups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling patchTaskmanagementWorkitemUsersMeWrapups';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTaskmanagementWorkitemUsersMeWrapups';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups","PATCH",{workitemId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorktype(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}","PATCH",{worktypeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchTaskmanagementWorktypeStatus(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';if(void 0===i||null===i)throw'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}","PATCH",{worktypeId:e,statusId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkbins(e){return e=e||{},this.apiClient.callApi("/api/v2/taskmanagement/workbins","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkbinsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkbinsQuery';return this.apiClient.callApi("/api/v2/taskmanagement/workbins/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemAcdCancel(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemAcdCancel';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel","POST",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemDisconnect(e){if(void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemDisconnect';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/disconnect","POST",{workitemId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemTerminate(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "workitemId" when calling postTaskmanagementWorkitemTerminate';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/{workitemId}/terminate","POST",{workitemId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitems(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitems';return this.apiClient.callApi("/api/v2/taskmanagement/workitems","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQuery';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsQueryJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsQueryJobs';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/query/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorkitemsSchemas(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsSchemas';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypeStatuses(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/{worktypeId}/statuses","POST",{worktypeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypes(e){return e=e||{},this.apiClient.callApi("/api/v2/taskmanagement/worktypes","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTaskmanagementWorktypesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTaskmanagementWorktypesQuery';return this.apiClient.callApi("/api/v2/taskmanagement/worktypes/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putTaskmanagementWorkitemsSchema(e,i){if(void 0===e||null===e)throw'Missing the required parameter "schemaId" when calling putTaskmanagementWorkitemsSchema';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';return this.apiClient.callApi("/api/v2/taskmanagement/workitems/schemas/{schemaId}","PUT",{schemaId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ve{constructor(e){this.apiClient=e||d.instance}deleteTeam(e){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling deleteTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","DELETE",{teamId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTeamMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling deleteTeamMembers';if(void 0===i||null===i)throw'Missing the required parameter "id" when calling deleteTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","DELETE",{teamId:e},{id:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeam(e){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling getTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","GET",{teamId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeamMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling getTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","GET",{teamId:e},{pageSize:i.pageSize,before:i.before,after:i.after,expand:i.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTeams(e){return e=e||{},this.apiClient.callApi("/api/v2/teams","GET",{},{pageSize:e.pageSize,name:e.name,after:e.after,before:e.before,expand:e.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTeam(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling patchTeam';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTeam';return this.apiClient.callApi("/api/v2/teams/{teamId}","PATCH",{teamId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsTeamsActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsTeamsActivityQuery';return this.apiClient.callApi("/api/v2/analytics/teams/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamMembers(e,i){if(void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postTeamMembers';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTeamMembers';return this.apiClient.callApi("/api/v2/teams/{teamId}/members","POST",{teamId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTeams(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeams';return this.apiClient.callApi("/api/v2/teams","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTeamsSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTeamsSearch';return this.apiClient.callApi("/api/v2/teams/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class we{constructor(e){this.apiClient=e||d.instance}getTelephonyMediaregions(){return this.apiClient.callApi("/api/v2/telephony/mediaregions","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySipmessagesConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';return this.apiClient.callApi("/api/v2/telephony/sipmessages/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySipmessagesConversationHeaders(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';return this.apiClient.callApi("/api/v2/telephony/sipmessages/conversations/{conversationId}/headers","GET",{conversationId:e},{keys:this.apiClient.buildCollectionParam(i.keys,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySiptraces(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "dateStart" when calling getTelephonySiptraces';if(void 0===i||null===i)throw'Missing the required parameter "dateEnd" when calling getTelephonySiptraces';return this.apiClient.callApi("/api/v2/telephony/siptraces","GET",{},{callId:t.callId,toUser:t.toUser,fromUser:t.fromUser,conversationId:t.conversationId,dateStart:e,dateEnd:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonySiptracesDownloadDownloadId(e){if(void 0===e||null===e)throw'Missing the required parameter "downloadId" when calling getTelephonySiptracesDownloadDownloadId';return this.apiClient.callApi("/api/v2/telephony/siptraces/download/{downloadId}","GET",{downloadId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonySiptracesDownload(e){if(void 0===e||null===e)throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';return this.apiClient.callApi("/api/v2/telephony/siptraces/download","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ce{constructor(e){this.apiClient=e||d.instance}deleteTelephonyProvidersEdge(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","DELETE",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgeLogicalinterface(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling deleteTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","DELETE",{edgeId:e,interfaceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgeSoftwareupdate(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","DELETE",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesCertificateauthority(e){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling deleteTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","DELETE",{certificateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesDidpool(e){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling deleteTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","DELETE",{didPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesEdgegroup(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling deleteTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","DELETE",{edgeGroupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesExtensionpool(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling deleteTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","DELETE",{extensionPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesPhone(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling deleteTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","DELETE",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesPhonebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling deleteTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","DELETE",{phoneBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesSite(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling deleteTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","DELETE",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesSiteOutboundroute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling deleteTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling deleteTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","DELETE",{siteId:e,outboundRouteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTelephonyProvidersEdgesTrunkbasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling deleteTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","DELETE",{trunkBaseSettingsId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdge(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","GET",{edgeId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticNslookup(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticNslookup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticPing(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticPing';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticRoute(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticRoute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeDiagnosticTracepath(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeDiagnosticTracepath';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogicalinterface(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling getTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","GET",{edgeId:e,interfaceId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogicalinterfaces(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces","GET",{edgeId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeLogsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeLogsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getTelephonyProvidersEdgeLogsJob';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}","GET",{edgeId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/metrics","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgePhysicalinterface(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgePhysicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling getTelephonyProvidersEdgePhysicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}","GET",{edgeId:e,interfaceId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgePhysicalinterfaces(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgePhysicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSetuppackage(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSetuppackage';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/setuppackage","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSoftwareupdate(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeSoftwareversions(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeSoftwareversions';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareversions","GET",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgeTrunks(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling getTelephonyProvidersEdgeTrunks';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/trunks","GET",{edgeId:e},{pageNumber:i.pageNumber,pageSize:i.pageSize,sortBy:i.sortBy,sortOrder:i.sortOrder,"trunkBase.id":i.trunkBaseId,trunkType:i.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdges(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,"site.id":e.siteId,"edgeGroup.id":e.edgeGroupId,sortBy:e.sortBy,managed:e.managed,showCloudMedia:e.showCloudMedia},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesCertificateauthority(e){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling getTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","GET",{certificateId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDid(e){if(void 0===e||null===e)throw'Missing the required parameter "didId" when calling getTelephonyProvidersEdgesDid';return this.apiClient.callApi("/api/v2/telephony/providers/edges/dids/{didId}","GET",{didId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpool(e){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling getTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","GET",{didPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpools(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDidpoolsDids(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "type" when calling getTelephonyProvidersEdgesDidpoolsDids';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/dids","GET",{},{type:e,id:this.apiClient.buildCollectionParam(i.id,"multi"),numberMatch:i.numberMatch,pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesDids(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/dids","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,phoneNumber:e.phoneNumber,"owner.id":e.ownerId,"didPool.id":e.didPoolId,id:this.apiClient.buildCollectionParam(e.id,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroup(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling getTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","GET",{edgeGroupId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroupEdgetrunkbase(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgegroupId" when calling getTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===i||null===i)throw'Missing the required parameter "edgetrunkbaseId" when calling getTelephonyProvidersEdgesEdgegroupEdgetrunkbase';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}","GET",{edgegroupId:e,edgetrunkbaseId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgegroups(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,sortBy:e.sortBy,managed:e.managed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesEdgeversionreport(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgeversionreport","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExpired(){return this.apiClient.callApi("/api/v2/telephony/providers/edges/expired","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtension(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionId" when calling getTelephonyProvidersEdgesExtension';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensions/{extensionId}","GET",{extensionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpool(e){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling getTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","GET",{extensionPoolId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpools(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,number:e._number},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensionpoolsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/divisionviews","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,id:this.apiClient.buildCollectionParam(e.id,"multi"),name:e.name,divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesExtensions(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/extensions","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,number:e._number},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLine(e){if(void 0===e||null===e)throw'Missing the required parameter "lineId" when calling getTelephonyProvidersEdgesLine';return this.apiClient.callApi("/api/v2/telephony/providers/edges/lines/{lineId}","GET",{lineId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "lineBaseId" when calling getTelephonyProvidersEdgesLinebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}","GET",{lineBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinebasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/linebasesettings","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLines(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/lines","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,sortBy:e.sortBy,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLinesTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "lineBaseSettingsId" when calling getTelephonyProvidersEdgesLinesTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/lines/template","GET",{},{lineBaseSettingsId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesLogicalinterfaces(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/logicalinterfaces","GET",{},{edgeIds:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMediastatisticsConversation(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversation';return this.apiClient.callApi("/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMediastatisticsConversationCommunication(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';if(void 0===i||null===i)throw'Missing the required parameter "communicationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';return this.apiClient.callApi("/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}","GET",{conversationId:e,communicationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/metrics","GET",{},{edgeIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesOutboundroutes(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/outboundroutes","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,name:e.name,"site.id":e.siteId,"externalTrunkBases.ids":e.externalTrunkBasesIds,sortBy:e.sortBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhone(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling getTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","GET",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesetting(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling getTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","GET",{phoneBaseId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonebasesettingsTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneMetabaseId" when calling getTelephonyProvidersEdgesPhonebasesettingsTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/template","GET",{},{phoneMetabaseId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhones(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/phones","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,"site.id":e.siteId,"webRtcUser.id":e.webRtcUserId,"phoneBaseSettings.id":e.phoneBaseSettingsId,"lines.loggedInUser.id":e.linesLoggedInUserId,"lines.defaultForUser.id":e.linesDefaultForUserId,phone_hardwareId:e.phoneHardwareId,"lines.id":e.linesId,"lines.name":e.linesName,name:e.name,"status.operationalStatus":e.statusOperationalStatus,"secondaryStatus.operationalStatus":e.secondaryStatusOperationalStatus,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),fields:this.apiClient.buildCollectionParam(e.fields,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhonesTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseSettingsId" when calling getTelephonyProvidersEdgesPhonesTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/template","GET",{},{phoneBaseSettingsId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesPhysicalinterfaces(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeIds" when calling getTelephonyProvidersEdgesPhysicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/physicalinterfaces","GET",{},{edgeIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSite(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplan';if(void 0===i||null===i)throw'Missing the required parameter "numberPlanId" when calling getTelephonyProvidersEdgesSiteNumberplan';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}","GET",{siteId:e,numberPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplans(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplans';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteNumberplansClassifications(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteNumberplansClassifications';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications","GET",{siteId:e},{classification:i.classification},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteOutboundroute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling getTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","GET",{siteId:e,outboundRouteId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteOutboundroutes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteOutboundroutes';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes","GET",{siteId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,name:i.name,"externalTrunkBases.ids":i.externalTrunkBasesIds,sortBy:i.sortBy},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSiteSiteconnections(e){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling getTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","GET",{siteId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesSites(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/sites","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,sortBy:e.sortBy,sortOrder:e.sortOrder,name:e.name,"location.id":e.locationId,managed:e.managed,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTimezones(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/timezones","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunk(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkId" when calling getTelephonyProvidersEdgesTrunk';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/{trunkId}","GET",{trunkId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkId" when calling getTelephonyProvidersEdgesTrunkMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics","GET",{trunkId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesetting(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling getTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","GET",{trunkBaseSettingsId:e},{ignoreHidden:i.ignoreHidden},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettings(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,recordingEnabled:e.recordingEnabled,ignoreHidden:e.ignoreHidden,managed:e.managed,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),name:e.name},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases","GET",{},{type:e.type,pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkbasesettingsTemplate(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkMetabaseId" when calling getTelephonyProvidersEdgesTrunkbasesettingsTemplate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/template","GET",{},{trunkMetabaseId:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunks(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks","GET",{},{pageNumber:e.pageNumber,pageSize:e.pageSize,sortBy:e.sortBy,sortOrder:e.sortOrder,"edge.id":e.edgeId,"trunkBase.id":e.trunkBaseId,trunkType:e.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunksMetrics(e){if(void 0===e||null===e)throw'Missing the required parameter "trunkIds" when calling getTelephonyProvidersEdgesTrunksMetrics';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunks/metrics","GET",{},{trunkIds:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTelephonyProvidersEdgesTrunkswithrecording(e){return e=e||{},this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkswithrecording","GET",{},{trunkType:e.trunkType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchTelephonyProvidersEdgesSiteSiteconnections(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling patchTelephonyProvidersEdgesSiteSiteconnections';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","PATCH",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticNslookup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticNslookup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticNslookup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticPing(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticPing';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticPing';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticRoute(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticRoute';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticRoute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeDiagnosticTracepath(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeDiagnosticTracepath';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeDiagnosticTracepath';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogicalinterfaces(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogicalinterfaces';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogicalinterfaces';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogsJobUpload(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogsJobUpload';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling postTelephonyProvidersEdgeLogsJobUpload';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogsJobUpload';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload","POST",{edgeId:e,jobId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeLogsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeLogsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeLogsJobs';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logs/jobs","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeReboot(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/reboot","POST",{edgeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeSoftwareupdate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeSoftwareupdate';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgeSoftwareupdate';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/softwareupdate","POST",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeStatuscode(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeStatuscode';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/statuscode","POST",{edgeId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgeUnpair(e){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling postTelephonyProvidersEdgeUnpair';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/unpair","POST",{edgeId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdges(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdges';return this.apiClient.callApi("/api/v2/telephony/providers/edges","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesAddressvalidation(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesAddressvalidation';return this.apiClient.callApi("/api/v2/telephony/providers/edges/addressvalidation","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesCertificateauthorities(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesCertificateauthorities';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesDidpools(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesDidpools';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesEdgegroups(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesEdgegroups';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesExtensionpools(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesExtensionpools';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhoneReboot(e){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling postTelephonyProvidersEdgesPhoneReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}/reboot","POST",{phoneId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhonebasesettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhonebasesettings';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhones(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhones';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesPhonesReboot(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesPhonesReboot';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/reboot","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesSiteOutboundroutes(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling postTelephonyProvidersEdgesSiteOutboundroutes';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSiteOutboundroutes';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes","POST",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesSites(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSites';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTelephonyProvidersEdgesTrunkbasesettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesTrunkbasesettings';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdge(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdge';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdge';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}","PUT",{edgeId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgeLogicalinterface(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdgeLogicalinterface';if(void 0===i||null===i)throw'Missing the required parameter "interfaceId" when calling putTelephonyProvidersEdgeLogicalinterface';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgeLogicalinterface';return this.apiClient.callApi("/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}","PUT",{edgeId:e,interfaceId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesCertificateauthority(e,i){if(void 0===e||null===e)throw'Missing the required parameter "certificateId" when calling putTelephonyProvidersEdgesCertificateauthority';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesCertificateauthority';return this.apiClient.callApi("/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}","PUT",{certificateId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesDidpool(e,i){if(void 0===e||null===e)throw'Missing the required parameter "didPoolId" when calling putTelephonyProvidersEdgesDidpool';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesDidpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/didpools/{didPoolId}","PUT",{didPoolId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesEdgegroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "edgeGroupId" when calling putTelephonyProvidersEdgesEdgegroup';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesEdgegroup';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}","PUT",{edgeGroupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesEdgegroupEdgetrunkbase(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "edgegroupId" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===i||null===i)throw'Missing the required parameter "edgetrunkbaseId" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesEdgegroupEdgetrunkbase';return this.apiClient.callApi("/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}","PUT",{edgegroupId:e,edgetrunkbaseId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesExtensionpool(e,i){if(void 0===e||null===e)throw'Missing the required parameter "extensionPoolId" when calling putTelephonyProvidersEdgesExtensionpool';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesExtensionpool';return this.apiClient.callApi("/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}","PUT",{extensionPoolId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesPhone(e,i){if(void 0===e||null===e)throw'Missing the required parameter "phoneId" when calling putTelephonyProvidersEdgesPhone';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesPhone';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phones/{phoneId}","PUT",{phoneId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesPhonebasesetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "phoneBaseId" when calling putTelephonyProvidersEdgesPhonebasesetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesPhonebasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}","PUT",{phoneBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSite(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSite';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSite';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteNumberplans(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteNumberplans';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteNumberplans';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/numberplans","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteOutboundroute(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteOutboundroute';if(void 0===i||null===i)throw'Missing the required parameter "outboundRouteId" when calling putTelephonyProvidersEdgesSiteOutboundroute';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteOutboundroute';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}","PUT",{siteId:e,outboundRouteId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesSiteSiteconnections(e,i){if(void 0===e||null===e)throw'Missing the required parameter "siteId" when calling putTelephonyProvidersEdgesSiteSiteconnections';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesSiteSiteconnections';return this.apiClient.callApi("/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections","PUT",{siteId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putTelephonyProvidersEdgesTrunkbasesetting(e,i){if(void 0===e||null===e)throw'Missing the required parameter "trunkBaseSettingsId" when calling putTelephonyProvidersEdgesTrunkbasesetting';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';return this.apiClient.callApi("/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}","PUT",{trunkBaseSettingsId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ie{constructor(e){this.apiClient=e||d.instance}getTextbotsBotsSearch(e){return e=e||{},this.apiClient.callApi("/api/v2/textbots/bots/search","GET",{},{botType:this.apiClient.buildCollectionParam(e.botType,"multi"),botName:e.botName,botId:this.apiClient.buildCollectionParam(e.botId,"multi"),pageSize:e.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotflowsSessionTurns(e,i){if(void 0===e||null===e)throw'Missing the required parameter "sessionId" when calling postTextbotsBotflowsSessionTurns';if(void 0===i||null===i)throw'Missing the required parameter "turnRequest" when calling postTextbotsBotflowsSessionTurns';return this.apiClient.callApi("/api/v2/textbots/botflows/sessions/{sessionId}/turns","POST",{sessionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotflowsSessions(e){if(void 0===e||null===e)throw'Missing the required parameter "launchRequest" when calling postTextbotsBotflowsSessions';return this.apiClient.callApi("/api/v2/textbots/botflows/sessions","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postTextbotsBotsExecute(e){if(void 0===e||null===e)throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';return this.apiClient.callApi("/api/v2/textbots/bots/execute","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class fe{constructor(e){this.apiClient=e||d.instance}deleteToken(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteToken';return this.apiClient.callApi("/api/v2/tokens/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteTokensMe(){return this.apiClient.callApi("/api/v2/tokens/me","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTokensMe(e){return e=e||{},this.apiClient.callApi("/api/v2/tokens/me","GET",{},{preserveIdleTTL:e.preserveIdleTTL},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTokensTimeout(){return this.apiClient.callApi("/api/v2/tokens/timeout","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}headTokensMe(){return this.apiClient.callApi("/api/v2/tokens/me","HEAD",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putTokensTimeout(e){return e=e||{},this.apiClient.callApi("/api/v2/tokens/timeout","PUT",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}}class Ae{constructor(e){this.apiClient=e||d.instance}getKnowledgeKnowledgebaseUploadsUrlsJob(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';if(void 0===i||null===i)throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}","GET",{knowledgeBaseId:e,jobId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postIntegrationsActionDraftFunctionUpload(e,i){if(void 0===e||null===e)throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';return this.apiClient.callApi("/api/v2/integrations/actions/{actionId}/draft/function/upload","POST",{actionId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeDocumentuploads(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';return this.apiClient.callApi("/api/v2/knowledge/documentuploads","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postKnowledgeKnowledgebaseUploadsUrlsJobs(e,i){if(void 0===e||null===e)throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';return this.apiClient.callApi("/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs","POST",{knowledgeBaseId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postLanguageunderstandingMinerUploads(e,i){if(void 0===e||null===e)throw'Missing the required parameter "minerId" when calling postLanguageunderstandingMinerUploads';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postLanguageunderstandingMinerUploads';return this.apiClient.callApi("/api/v2/languageunderstanding/miners/{minerId}/uploads","POST",{minerId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsLearningCoverart(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsLearningCoverart';return this.apiClient.callApi("/api/v2/uploads/learning/coverart","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsPublicassetsImages(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsPublicassetsImages';return this.apiClient.callApi("/api/v2/uploads/publicassets/images","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsRecordings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsRecordings';return this.apiClient.callApi("/api/v2/uploads/recordings","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUploadsWorkforcemanagementHistoricaldataCsv(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';return this.apiClient.callApi("/api/v2/uploads/workforcemanagement/historicaldata/csv","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class be{constructor(e){this.apiClient=e||d.instance}getOauthClientUsageQueryResult(e,i){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getOauthClientUsageQueryResult';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getOauthClientUsageQueryResult';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}","GET",{executionId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getOauthClientUsageSummary(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "clientId" when calling getOauthClientUsageSummary';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/summary","GET",{clientId:e},{days:i.days},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageQueryExecutionIdResults(e){if(void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getUsageQueryExecutionIdResults';return this.apiClient.callApi("/api/v2/usage/query/{executionId}/results","GET",{executionId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsageSimplesearchExecutionIdResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "executionId" when calling getUsageSimplesearchExecutionIdResults';return this.apiClient.callApi("/api/v2/usage/simplesearch/{executionId}/results","GET",{executionId:e},{after:i.after,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postOauthClientUsageQuery(e,i){if(void 0===e||null===e)throw'Missing the required parameter "clientId" when calling postOauthClientUsageQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postOauthClientUsageQuery';return this.apiClient.callApi("/api/v2/oauth/clients/{clientId}/usage/query","POST",{clientId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUsageQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsageQuery';return this.apiClient.callApi("/api/v2/usage/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsageSimplesearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsageSimplesearch';return this.apiClient.callApi("/api/v2/usage/simplesearch","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class je{constructor(e){this.apiClient=e||d.instance}deleteUserrecording(e){if(void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling deleteUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","DELETE",{recordingId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecording(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling getUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","GET",{recordingId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordingMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling getUserrecordingMedia';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}/media","GET",{recordingId:e},{formatId:i.formatId,async:i.async},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordings(e){return e=e||{},this.apiClient.callApi("/api/v2/userrecordings","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserrecordingsSummary(){return this.apiClient.callApi("/api/v2/userrecordings/summary","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserrecording(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "recordingId" when calling putUserrecording';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserrecording';return this.apiClient.callApi("/api/v2/userrecordings/{recordingId}","PUT",{recordingId:e},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Pe{constructor(e){this.apiClient=e||d.instance}deleteAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","DELETE",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteAuthorizationSubjectDivisionRole(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling deleteAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling deleteAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","DELETE",{subjectId:e,divisionId:i,roleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUser(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUser';return this.apiClient.callApi("/api/v2/users/{userId}","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutinglanguage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","DELETE",{userId:e,languageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserRoutingskill(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling deleteUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","DELETE",{userId:e,skillId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserStationAssociatedstation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserStationAssociatedstation';return this.apiClient.callApi("/api/v2/users/{userId}/station/associatedstation","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserStationDefaultstation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserStationDefaultstation';return this.apiClient.callApi("/api/v2/users/{userId}/station/defaultstation","DELETE",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteUserVerifier(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling deleteUserVerifier';if(void 0===i||null===i)throw'Missing the required parameter "verifierId" when calling deleteUserVerifier';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers/{verifierId}","DELETE",{userId:e,verifierId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersAggregatesJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobResults(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/{jobId}/results","GET",{jobId:e},{cursor:i.cursor,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAnalyticsUsersDetailsJobsAvailability(){return this.apiClient.callApi("/api/v2/analytics/users/details/jobs/availability","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/me","GET",{},{name:i.name,permission:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedMe(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedMe';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/me","GET",{},{permission:e,pageNumber:i.pageNumber,pageSize:i.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationDivisionspermittedPagedSubjectId(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationDivisionspermittedPagedSubjectId';if(void 0===i||null===i)throw'Missing the required parameter "permission" when calling getAuthorizationDivisionspermittedPagedSubjectId';return this.apiClient.callApi("/api/v2/authorization/divisionspermitted/paged/{subjectId}","GET",{subjectId:e},{permission:i,pageNumber:t.pageNumber,pageSize:t.pageSize},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubject(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getAuthorizationSubject';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}","GET",{subjectId:e},{includeDuplicates:i.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getAuthorizationSubjectsMe(e){return e=e||{},this.apiClient.callApi("/api/v2/authorization/subjects/me","GET",{},{includeDuplicates:e.includeDuplicates},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getFieldconfig(e){if(void 0===e||null===e)throw'Missing the required parameter "type" when calling getFieldconfig';return this.apiClient.callApi("/api/v2/fieldconfig","GET",{},{type:e},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getProfilesUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/profiles/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jid:this.apiClient.buildCollectionParam(e.jid,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getRoutingUserUtilization(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUser(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUser';return this.apiClient.callApi("/api/v2/users/{userId}","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource,state:i.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserAdjacents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserAdjacents';return this.apiClient.callApi("/api/v2/users/{userId}/adjacents","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserCallforwarding(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserDirectreports(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserDirectreports';return this.apiClient.callApi("/api/v2/users/{userId}/directreports","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserFavorites(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserFavorites';return this.apiClient.callApi("/api/v2/users/{userId}/favorites","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserGeolocation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling getUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","GET",{userId:e,clientId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserOutofoffice(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserOutofoffice';return this.apiClient.callApi("/api/v2/users/{userId}/outofoffice","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserProfile(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserProfile';return this.apiClient.callApi("/api/v2/users/{userId}/profile","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserProfileskills(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserProfileskills';return this.apiClient.callApi("/api/v2/users/{userId}/profileskills","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserQueues(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,joined:i.joined,divisionId:this.apiClient.buildCollectionParam(i.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoles(e){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling getUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","GET",{subjectId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutinglanguages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingskills(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,sortOrder:i.sortOrder},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserRoutingstatus(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserRoutingstatus';return this.apiClient.callApi("/api/v2/users/{userId}/routingstatus","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSkillgroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSkillgroups';return this.apiClient.callApi("/api/v2/users/{userId}/skillgroups","GET",{userId:e},{pageSize:i.pageSize,after:i.after,before:i.before},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserState(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserState';return this.apiClient.callApi("/api/v2/users/{userId}/state","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserStation(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserStation';return this.apiClient.callApi("/api/v2/users/{userId}/station","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserSuperiors(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserSuperiors';return this.apiClient.callApi("/api/v2/users/{userId}/superiors","GET",{userId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserTrustors(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserTrustors';return this.apiClient.callApi("/api/v2/users/{userId}/trustors","GET",{userId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUserVerifiers(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getUserVerifiers';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsers(e){return e=e||{},this.apiClient.callApi("/api/v2/users","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,id:this.apiClient.buildCollectionParam(e.id,"multi"),jabberId:this.apiClient.buildCollectionParam(e.jabberId,"multi"),sortOrder:e.sortOrder,expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource,state:e.state},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivities(e){return e=e||{},this.apiClient.callApi("/api/v2/users/development/activities","GET",{},{userId:this.apiClient.buildCollectionParam(e.userId,"multi"),moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pass:e.pass,pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,types:this.apiClient.buildCollectionParam(e.types,"multi"),statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),relationship:this.apiClient.buildCollectionParam(e.relationship,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivitiesMe(e){return e=e||{},this.apiClient.callApi("/api/v2/users/development/activities/me","GET",{},{moduleId:e.moduleId,interval:e.interval,completionInterval:e.completionInterval,overdue:e.overdue,pass:e.pass,pageSize:e.pageSize,pageNumber:e.pageNumber,sortOrder:e.sortOrder,types:this.apiClient.buildCollectionParam(e.types,"multi"),statuses:this.apiClient.buildCollectionParam(e.statuses,"multi"),relationship:this.apiClient.buildCollectionParam(e.relationship,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersDevelopmentActivity(e,i){if(void 0===e||null===e)throw'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';if(void 0===i||null===i)throw'Missing the required parameter "type" when calling getUsersDevelopmentActivity';return this.apiClient.callApi("/api/v2/users/development/activities/{activityId}","GET",{activityId:e},{type:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersMe(e){return e=e||{},this.apiClient.callApi("/api/v2/users/me","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi"),integrationPresenceSource:e.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getUsersSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getUsersSearch';return this.apiClient.callApi("/api/v2/users/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi"),integrationPresenceSource:i.integrationPresenceSource},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchUser(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUser';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUser';return this.apiClient.callApi("/api/v2/users/{userId}","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserCallforwarding(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserCallforwarding';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserGeolocation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserGeolocation';if(void 0===i||null===i)throw'Missing the required parameter "clientId" when calling patchUserGeolocation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserGeolocation';return this.apiClient.callApi("/api/v2/users/{userId}/geolocations/{clientId}","PATCH",{userId:e,clientId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueue(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "queueId" when calling patchUserQueue';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchUserQueue';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserQueue';return this.apiClient.callApi("/api/v2/users/{userId}/queues/{queueId}","PATCH",{queueId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserQueues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserQueues';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserQueues';return this.apiClient.callApi("/api/v2/users/{userId}/queues","PATCH",{userId:e},{divisionId:this.apiClient.buildCollectionParam(t.divisionId,"multi")},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguage(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';if(void 0===i||null===i)throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/{languageId}","PATCH",{userId:e,languageId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutinglanguagesBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchUsersBulk(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchUsersBulk';return this.apiClient.callApi("/api/v2/users/bulk","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersActivityQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersActivityQuery';return this.apiClient.callApi("/api/v2/analytics/users/activity/query","POST",{},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';return this.apiClient.callApi("/api/v2/analytics/users/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';return this.apiClient.callApi("/api/v2/analytics/users/details/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersDetailsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';return this.apiClient.callApi("/api/v2/analytics/users/details/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAnalyticsUsersObservationsQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';return this.apiClient.callApi("/api/v2/analytics/users/observations/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkadd(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkadd';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkadd';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkadd","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkremove(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkremove';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkremove","POST",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectBulkreplace(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkreplace';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postAuthorizationSubjectBulkreplace';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/bulkreplace","POST",{subjectId:e},{subjectType:t.subjectType},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postAuthorizationSubjectDivisionRole(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling postAuthorizationSubjectDivisionRole';if(void 0===i||null===i)throw'Missing the required parameter "divisionId" when calling postAuthorizationSubjectDivisionRole';if(void 0===t||null===t)throw'Missing the required parameter "roleId" when calling postAuthorizationSubjectDivisionRole';return this.apiClient.callApi("/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}","POST",{subjectId:e,divisionId:i,roleId:t},{subjectType:n.subjectType},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postUserExternalid(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserExternalid';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserExternalid';return this.apiClient.callApi("/api/v2/users/{userId}/externalid","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserInvite(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserInvite';return this.apiClient.callApi("/api/v2/users/{userId}/invite","POST",{userId:e},{force:i.force},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postUserPassword(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserPassword';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserPassword';return this.apiClient.callApi("/api/v2/users/{userId}/password","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutinglanguages(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutinglanguages';return this.apiClient.callApi("/api/v2/users/{userId}/routinglanguages","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUserRoutingskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling postUserRoutingskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postUserRoutingskills';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills","POST",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsers';return this.apiClient.callApi("/api/v2/users","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersDevelopmentActivitiesAggregatesQuery(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';return this.apiClient.callApi("/api/v2/users/development/activities/aggregates/query","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersMePassword(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersMePassword';return this.apiClient.callApi("/api/v2/users/me/password","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearch';return this.apiClient.callApi("/api/v2/users/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchConversationTarget(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchConversationTarget';return this.apiClient.callApi("/api/v2/users/search/conversation/target","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchQueuemembersManage(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';return this.apiClient.callApi("/api/v2/users/search/queuemembers/manage","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postUsersSearchTeamsAssign(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';return this.apiClient.callApi("/api/v2/users/search/teams/assign","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putRoutingUserUtilization(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putRoutingUserUtilization';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putRoutingUserUtilization';return this.apiClient.callApi("/api/v2/routing/users/{userId}/utilization","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserCallforwarding(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserCallforwarding';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserCallforwarding';return this.apiClient.callApi("/api/v2/users/{userId}/callforwarding","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserOutofoffice(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserOutofoffice';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserOutofoffice';return this.apiClient.callApi("/api/v2/users/{userId}/outofoffice","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserProfileskills(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserProfileskills';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserProfileskills';return this.apiClient.callApi("/api/v2/users/{userId}/profileskills","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoles(e,i){if(void 0===e||null===e)throw'Missing the required parameter "subjectId" when calling putUserRoles';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoles';return this.apiClient.callApi("/api/v2/users/{subjectId}/roles","PUT",{subjectId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskill(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskill';if(void 0===i||null===i)throw'Missing the required parameter "skillId" when calling putUserRoutingskill';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserRoutingskill';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/{skillId}","PUT",{userId:e,skillId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingskillsBulk(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';return this.apiClient.callApi("/api/v2/users/{userId}/routingskills/bulk","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserRoutingstatus(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserRoutingstatus';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserRoutingstatus';return this.apiClient.callApi("/api/v2/users/{userId}/routingstatus","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserState(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserState';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putUserState';return this.apiClient.callApi("/api/v2/users/{userId}/state","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putUserStationAssociatedstationStationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserStationAssociatedstationStationId';if(void 0===i||null===i)throw'Missing the required parameter "stationId" when calling putUserStationAssociatedstationStationId';return this.apiClient.callApi("/api/v2/users/{userId}/station/associatedstation/{stationId}","PUT",{userId:e,stationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserStationDefaultstationStationId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserStationDefaultstationStationId';if(void 0===i||null===i)throw'Missing the required parameter "stationId" when calling putUserStationDefaultstationStationId';return this.apiClient.callApi("/api/v2/users/{userId}/station/defaultstation/{stationId}","PUT",{userId:e,stationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}putUserVerifier(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putUserVerifier';if(void 0===i||null===i)throw'Missing the required parameter "verifierId" when calling putUserVerifier';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling putUserVerifier';return this.apiClient.callApi("/api/v2/users/{userId}/verifiers/{verifierId}","PUT",{userId:e,verifierId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}}class ye{constructor(e){this.apiClient=e||d.instance}getDate(){return this.apiClient.callApi("/api/v2/date","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getIpranges(){return this.apiClient.callApi("/api/v2/ipranges","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getTimezones(e){return e=e||{},this.apiClient.callApi("/api/v2/timezones","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postCertificateDetails(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postCertificateDetails';return this.apiClient.callApi("/api/v2/certificate/details","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Oe{constructor(e){this.apiClient=e||d.instance}deleteVoicemailMessage(e){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling deleteVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","DELETE",{messageId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteVoicemailMessages(){return this.apiClient.callApi("/api/v2/voicemail/messages","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupMailbox(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupMailbox';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/mailbox","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupMessages';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/messages","GET",{groupId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailGroupPolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling getVoicemailGroupPolicy';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/policy","GET",{groupId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMailbox(){return this.apiClient.callApi("/api/v2/voicemail/mailbox","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMeMailbox(){return this.apiClient.callApi("/api/v2/voicemail/me/mailbox","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMeMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/me/messages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMePolicy(){return this.apiClient.callApi("/api/v2/voicemail/me/policy","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessage(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","GET",{messageId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessageMedia(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "messageId" when calling getVoicemailMessageMedia';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}/media","GET",{messageId:e},{formatId:i.formatId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/messages","GET",{},{ids:e.ids,expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailPolicy(){return this.apiClient.callApi("/api/v2/voicemail/policy","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailQueueMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "queueId" when calling getVoicemailQueueMessages';return this.apiClient.callApi("/api/v2/voicemail/queues/{queueId}/messages","GET",{queueId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "q64" when calling getVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","GET",{},{q64:e,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getVoicemailUserpolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","GET",{userId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailGroupPolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "groupId" when calling patchVoicemailGroupPolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailGroupPolicy';return this.apiClient.callApi("/api/v2/voicemail/groups/{groupId}/policy","PATCH",{groupId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailMePolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling patchVoicemailMePolicy';return this.apiClient.callApi("/api/v2/voicemail/me/policy","PATCH",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling patchVoicemailMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","PATCH",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}patchVoicemailUserpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling patchVoicemailUserpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling patchVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","PATCH",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/voicemail/messages","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postVoicemailSearch(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postVoicemailSearch';return this.apiClient.callApi("/api/v2/voicemail/search","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "messageId" when calling putVoicemailMessage';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putVoicemailMessage';return this.apiClient.callApi("/api/v2/voicemail/messages/{messageId}","PUT",{messageId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailPolicy(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putVoicemailPolicy';return this.apiClient.callApi("/api/v2/voicemail/policy","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putVoicemailUserpolicy(e,i){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling putVoicemailUserpolicy';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';return this.apiClient.callApi("/api/v2/voicemail/userpolicies/{userId}","PUT",{userId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class Me{constructor(e){this.apiClient=e||d.instance}deleteWebchatDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebchatGuestConversationMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling deleteWebchatGuestConversationMember';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}","DELETE",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebchatSettings(){return this.apiClient.callApi("/api/v2/webchat/settings","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","GET",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatDeployments(){return this.apiClient.callApi("/api/v2/webchat/deployments","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMediarequest(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequest';if(void 0===i||null===i)throw'Missing the required parameter "mediaRequestId" when calling getWebchatGuestConversationMediarequest';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}","GET",{conversationId:e,mediaRequestId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMediarequests(e){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMediarequests';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests","GET",{conversationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMember(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMember';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling getWebchatGuestConversationMember';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}","GET",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMembers(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMembers';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members","GET",{conversationId:e},{pageSize:i.pageSize,pageNumber:i.pageNumber,excludeDisconnectedMembers:i.excludeDisconnectedMembers},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMessage(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessage';if(void 0===i||null===i)throw'Missing the required parameter "messageId" when calling getWebchatGuestConversationMessage';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}","GET",{conversationId:e,messageId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatGuestConversationMessages(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessages';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/messages","GET",{conversationId:e},{after:i.after,before:i.before,sortOrder:i.sortOrder,maxResults:i.maxResults},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebchatSettings(){return this.apiClient.callApi("/api/v2/webchat/settings","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchWebchatGuestConversationMediarequest(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling patchWebchatGuestConversationMediarequest';if(void 0===i||null===i)throw'Missing the required parameter "mediaRequestId" when calling patchWebchatGuestConversationMediarequest';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchWebchatGuestConversationMediarequest';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}","PATCH",{conversationId:e,mediaRequestId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebchatDeployments';return this.apiClient.callApi("/api/v2/webchat/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversationMemberMessages(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberMessages';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberMessages';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWebchatGuestConversationMemberMessages';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages","POST",{conversationId:e,memberId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversationMemberTyping(e,i){if(void 0===e||null===e)throw'Missing the required parameter "conversationId" when calling postWebchatGuestConversationMemberTyping';if(void 0===i||null===i)throw'Missing the required parameter "memberId" when calling postWebchatGuestConversationMemberTyping';return this.apiClient.callApi("/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing","POST",{conversationId:e,memberId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebchatGuestConversations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebchatGuestConversations';return this.apiClient.callApi("/api/v2/webchat/guest/conversations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putWebchatDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWebchatDeployment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWebchatDeployment';return this.apiClient.callApi("/api/v2/webchat/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWebchatSettings(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling putWebchatSettings';return this.apiClient.callApi("/api/v2/webchat/settings","PUT",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}}class Te{constructor(e){this.apiClient=e||d.instance}deleteWebdeploymentsConfiguration(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling deleteWebdeploymentsConfiguration';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}","DELETE",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsDeploymentCobrowseSessionId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';if(void 0===i||null===i)throw'Missing the required parameter "sessionId" when calling deleteWebdeploymentsDeploymentCobrowseSessionId';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}","DELETE",{deploymentId:e,sessionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWebdeploymentsTokenRevoke(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/token/revoke","DELETE",{},{},{"X-Journey-Session-Id":e.xJourneySessionId,"X-Journey-Session-Type":e.xJourneySessionType},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersion(e,i){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersion';if(void 0===i||null===i)throw'Missing the required parameter "versionId" when calling getWebdeploymentsConfigurationVersion';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}","GET",{configurationId:e,versionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersions(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersions';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions","GET",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurationVersionsDraft(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling getWebdeploymentsConfigurationVersionsDraft';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft","GET",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsConfigurations(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/configurations","GET",{},{showOnlyPublished:e.showOnlyPublished},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeployment(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","GET",{deploymentId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeploymentCobrowseSessionId(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentCobrowseSessionId';if(void 0===i||null===i)throw'Missing the required parameter "sessionId" when calling getWebdeploymentsDeploymentCobrowseSessionId';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}","GET",{deploymentId:e,sessionId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeploymentConfigurations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeploymentConfigurations';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}/configurations","GET",{deploymentId:e},{type:i.type,expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWebdeploymentsDeployments(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/deployments","GET",{},{expand:this.apiClient.buildCollectionParam(e.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsConfigurationVersionsDraftPublish(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling postWebdeploymentsConfigurationVersionsDraftPublish';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish","POST",{configurationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsConfigurations(e){if(void 0===e||null===e)throw'Missing the required parameter "configurationVersion" when calling postWebdeploymentsConfigurations';return this.apiClient.callApi("/api/v2/webdeployments/configurations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "deployment" when calling postWebdeploymentsDeployments';return this.apiClient.callApi("/api/v2/webdeployments/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsTokenOauthcodegrantjwtexchange(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWebdeploymentsTokenOauthcodegrantjwtexchange';return this.apiClient.callApi("/api/v2/webdeployments/token/oauthcodegrantjwtexchange","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWebdeploymentsTokenRefresh(e){return e=e||{},this.apiClient.callApi("/api/v2/webdeployments/token/refresh","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWebdeploymentsConfigurationVersionsDraft(e,i){if(void 0===e||null===e)throw'Missing the required parameter "configurationId" when calling putWebdeploymentsConfigurationVersionsDraft';if(void 0===i||null===i)throw'Missing the required parameter "configurationVersion" when calling putWebdeploymentsConfigurationVersionsDraft';return this.apiClient.callApi("/api/v2/webdeployments/configurations/{configurationId}/versions/draft","PUT",{configurationId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWebdeploymentsDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWebdeploymentsDeployment';if(void 0===i||null===i)throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';return this.apiClient.callApi("/api/v2/webdeployments/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class qe{constructor(e){this.apiClient=e||d.instance}getWebmessagingMessages(e){return e=e||{},this.apiClient.callApi("/api/v2/webmessaging/messages","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}}class Se{constructor(e){this.apiClient=e||d.instance}deleteWidgetsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling deleteWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","DELETE",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWidgetsDeployment(e){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling getWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","GET",{deploymentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWidgetsDeployments(){return this.apiClient.callApi("/api/v2/widgets/deployments","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWidgetsDeployments(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWidgetsDeployments';return this.apiClient.callApi("/api/v2/widgets/deployments","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}putWidgetsDeployment(e,i){if(void 0===e||null===e)throw'Missing the required parameter "deploymentId" when calling putWidgetsDeployment';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWidgetsDeployment';return this.apiClient.callApi("/api/v2/widgets/deployments/{deploymentId}","PUT",{deploymentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}}class ke{constructor(e){this.apiClient=e||d.instance}deleteWorkforcemanagementBusinessunit(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","DELETE",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitActivitycode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling deleteWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","DELETE",{businessUnitId:e,activityCodeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitPlanninggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling deleteWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","DELETE",{businessUnitId:e,planningGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitSchedulingRun(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling deleteWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","DELETE",{businessUnitId:e,runId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitServicegoaltemplate(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","DELETE",{businessUnitId:e,serviceGoalTemplateId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitStaffinggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","DELETE",{businessUnitId:e,staffingGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}","DELETE",{businessUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","DELETE",{businessUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitWeekSchedule(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementBusinessunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}","DELETE",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementBusinessunitWeekShorttermforecast(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementBusinessunitWeekShorttermforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}","DELETE",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","DELETE",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunit(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","DELETE",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","DELETE",{managementUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","DELETE",{managementUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitWorkplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","DELETE",{managementUnitId:e,workPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}deleteWorkforcemanagementManagementunitWorkplanrotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","DELETE",{managementUnitId:e,workPlanRotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherence(e){if(void 0===e||null===e)throw'Missing the required parameter "userId" when calling getWorkforcemanagementAdherence';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence","GET",{},{userId:this.apiClient.buildCollectionParam(e,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceExplanation(e){if(void 0===e||null===e)throw'Missing the required parameter "explanationId" when calling getWorkforcemanagementAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/{explanationId}","GET",{explanationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceExplanationsJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceExplanationsJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceHistoricalBulkJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalBulkJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdherenceHistoricalJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAdhocmodelingjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';return this.apiClient.callApi("/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentAdherenceExplanation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentAdherenceExplanation';if(void 0===i||null===i)throw'Missing the required parameter "explanationId" when calling getWorkforcemanagementAgentAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}","GET",{agentId:e,explanationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentManagementunit(e){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/managementunit","GET",{agentId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementAgentsMeManagementunit(){return this.apiClient.callApi("/api/v2/workforcemanagement/agents/me/managementunit","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","GET",{businessUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitActivitycode(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling getWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","GET",{businessUnitId:e,activityCodeId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitActivitycodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes","GET",{businessUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitIntradayPlanninggroups(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitIntradayPlanninggroups';if(void 0===i||null===i)throw'Missing the required parameter "_date" when calling getWorkforcemanagementBusinessunitIntradayPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups","GET",{businessUnitId:e},{date:i},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitManagementunits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitManagementunits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits","GET",{businessUnitId:e},{feature:i.feature,divisionId:i.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitPlanninggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling getWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","GET",{businessUnitId:e,planningGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitPlanninggroups(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups","GET",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRun(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling getWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","GET",{businessUnitId:e,runId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRunResult(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===t||null===t)throw'Missing the required parameter "managementUnitIds" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';if(void 0===n||null===n)throw'Missing the required parameter "expand" when calling getWorkforcemanagementBusinessunitSchedulingRunResult';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result","GET",{businessUnitId:e,runId:i},{managementUnitIds:this.apiClient.buildCollectionParam(t,"multi"),expand:this.apiClient.buildCollectionParam(n,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitSchedulingRuns(e){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulingRuns';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs","GET",{businessUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitServicegoaltemplate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","GET",{businessUnitId:e,serviceGoalTemplateId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitServicegoaltemplates(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates","GET",{businessUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitStaffinggroup(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","GET",{businessUnitId:e,staffingGroupId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitStaffinggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}","GET",{businessUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","GET",{businessUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans","GET",{businessUnitId:e},{managementUnitId:i.managementUnitId,forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedule(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}","GET",{businessUnitId:e,weekId:i,scheduleId:t},{expand:n.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleGenerationresults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleGenerationresults';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults","GET",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast","GET",{businessUnitId:e,weekId:i,scheduleId:t},{forceDownload:n.forceDownload},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';if(void 0===n||null===n)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}","GET",{businessUnitId:e,weekId:i,scheduleId:t,agentId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions","GET",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';if(void 0===n||null===n)throw'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}","GET",{businessUnitId:e,weekId:i,scheduleId:t,recalculationId:n},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekSchedules(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules","GET",{businessUnitId:e,weekId:i},{includeOnlyPublished:t.includeOnlyPublished,expand:t.expand},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecast(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecast';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{expand:this.apiClient.buildCollectionParam(n.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastData(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastData';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{weekNumber:n.weekNumber,forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement","GET",{businessUnitId:e,weekDateId:i,forecastId:t},{weekNumbers:this.apiClient.buildCollectionParam(n.weekNumbers,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitWeekShorttermforecasts(e,i){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecasts';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecasts';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts","GET",{businessUnitId:e,weekDateId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits","GET",{},{feature:e.feature,divisionId:e.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementBusinessunitsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/divisionviews","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementCalendarDataIcs(e){if(void 0===e||null===e)throw'Missing the required parameter "calendarId" when calling getWorkforcemanagementCalendarDataIcs';return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/data/ics","GET",{},{calendarId:e},{},{},null,["PureCloud OAuth"],["application/json"],["text/calendar"])}getWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/deletejob","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementHistoricaldataImportstatus(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/importstatus","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementIntegrationsHris(){return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementIntegrationsHrisTimeofftypesJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitActivitycodes(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAdherence(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAdherence';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence","GET",{managementUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAgent(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';if(void 0===i||null===i)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgent';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}","GET",{managementUnitId:e,agentId:i},{excludeCapabilities:t.excludeCapabilities,expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitAgentShifttrades(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgentShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades","GET",{managementUnitId:e,agentId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitShifttradesMatched(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesMatched';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitShifttradesUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesUsers';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeofflimit(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","GET",{managementUnitId:e,timeOffLimitId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeofflimits(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeoffplan(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","GET",{managementUnitId:e,timeOffPlanId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitTimeoffplans(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequest(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}","GET",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits","GET",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUserTimeoffrequests(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequests';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests","GET",{managementUnitId:e,userId:i},{recentlyReviewed:t.recentlyReviewed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitUsers(e){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUsers';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users","GET",{managementUnitId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekSchedule(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekSchedule';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}","GET",{managementUnitId:e,weekId:i,scheduleId:t},{expand:n.expand,forceDownloadService:n.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekSchedules(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules","GET",{managementUnitId:e,weekId:i},{includeOnlyPublished:t.includeOnlyPublished,earliestWeekDate:t.earliestWeekDate,latestWeekDate:t.latestWeekDate},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWeekShifttrades(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades","GET",{managementUnitId:e,weekDateId:i},{evaluateMatches:t.evaluateMatches,forceDownloadService:t.forceDownloadService},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling getWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","GET",{managementUnitId:e,workPlanId:i},{includeOnly:this.apiClient.buildCollectionParam(t.includeOnly,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplanrotation(e,i){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","GET",{managementUnitId:e,workPlanRotationId:i},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplanrotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitWorkplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans","GET",{managementUnitId:e},{expand:this.apiClient.buildCollectionParam(i.expand,"multi"),exclude:this.apiClient.buildCollectionParam(i.exclude,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits","GET",{},{pageSize:e.pageSize,pageNumber:e.pageNumber,expand:e.expand,feature:e.feature,divisionId:e.divisionId},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementManagementunitsDivisionviews(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/divisionviews","GET",{},{divisionId:this.apiClient.buildCollectionParam(e.divisionId,"multi")},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementNotifications(){return this.apiClient.callApi("/api/v2/workforcemanagement/notifications","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementSchedulingjob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementSchedulingjob';return this.apiClient.callApi("/api/v2/workforcemanagement/schedulingjobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementShifttrades(){return this.apiClient.callApi("/api/v2/workforcemanagement/shifttrades","GET",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementShrinkageJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementShrinkageJob';return this.apiClient.callApi("/api/v2/workforcemanagement/shrinkage/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffbalanceJob(e){if(void 0===e||null===e)throw'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}","GET",{jobId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequest(e){if(void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}","GET",{timeOffRequestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequestWaitlistpositions(e){if(void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions","GET",{timeOffRequestId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}getWorkforcemanagementTimeoffrequests(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests","GET",{},{recentlyReviewed:e.recentlyReviewed},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementAgentAdherenceExplanation(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling patchWorkforcemanagementAgentAdherenceExplanation';if(void 0===i||null===i)throw'Missing the required parameter "explanationId" when calling patchWorkforcemanagementAgentAdherenceExplanation';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling patchWorkforcemanagementAgentAdherenceExplanation';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}","PATCH",{agentId:e,explanationId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}","PATCH",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitActivitycode(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';if(void 0===i||null===i)throw'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}","PATCH",{businessUnitId:e,activityCodeId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitPlanninggroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';if(void 0===i||null===i)throw'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}","PATCH",{businessUnitId:e,planningGroupId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitSchedulingRun(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';if(void 0===i||null===i)throw'Missing the required parameter "runId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}","PATCH",{businessUnitId:e,runId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitServicegoaltemplate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';if(void 0===i||null===i)throw'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}","PATCH",{businessUnitId:e,serviceGoalTemplateId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitStaffinggroup(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';if(void 0===i||null===i)throw'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}","PATCH",{businessUnitId:e,staffingGroupId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementBusinessunitTimeoffplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}","PATCH",{businessUnitId:e,timeOffPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunit(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}","PATCH",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitAgents(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents","PATCH",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeofflimit(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}","PATCH",{managementUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeoffplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';if(void 0===i||null===i)throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}","PATCH",{managementUnitId:e,timeOffPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';if(void 0===i||null===i)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';if(void 0===t||null===t)throw'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus","PATCH",{managementUnitId:e,timeOffRequestId:i,userId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitUserTimeoffrequest(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}","PATCH",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWeekShifttrade(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===t||null===t)throw'Missing the required parameter "tradeId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWeekShifttrade';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}","PATCH",{managementUnitId:e,weekDateId:i,tradeId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWorkplan(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplan';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}","PATCH",{managementUnitId:e,workPlanId:i},{validationMode:t.validationMode},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementManagementunitWorkplanrotation(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}","PATCH",{managementUnitId:e,workPlanRotationId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}patchWorkforcemanagementTimeoffrequest(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementTimeoffrequest';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}","PATCH",{timeOffRequestId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceExplanations(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanations';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceExplanationsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/adherence/explanations/query","POST",{},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceHistorical(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAdherenceHistoricalBulk(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/adherence/historical/bulk","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentAdherenceExplanations(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanations';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanations';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations","POST",{agentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentAdherenceExplanationsQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "agentId" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query","POST",{agentId:e},{forceAsync:t.forceAsync,forceDownloadService:t.forceDownloadService},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgents(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agents","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentsIntegrationsHrisQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agents/integrations/hris/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentsMePossibleworkshifts(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/me/possibleworkshifts","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementAgentschedulesMine(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/agentschedules/mine","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitActivitycodes(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAdherenceExplanationsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query","POST",{businessUnitId:e},{forceAsync:t.forceAsync,forceDownloadService:t.forceDownloadService},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitAgentschedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search","POST",{businessUnitId:e},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitIntraday(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday","POST",{businessUnitId:e},{forceAsync:i.forceAsync},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitPlanninggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitPlanninggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitServicegoaltemplates(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitStaffinggroups(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitStaffinggroupsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans","POST",{businessUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query","POST",{businessUnitId:e,weekId:i,scheduleId:t},{forceAsync:a.forceAsync,forceDownloadService:a.forceDownloadService},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleCopy(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleReschedule(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleReschedule';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleUpdate(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl","POST",{businessUnitId:e,weekId:i,scheduleId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedules(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedules';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedules';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedules';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesGenerate(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesGenerate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl","POST",{businessUnitId:e,weekId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastCopy(e,i,t,n,a){if(a=a||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===t||null===t)throw'Missing the required parameter "forecastId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy","POST",{businessUnitId:e,weekDateId:i,forecastId:t},{forceAsync:a.forceAsync},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate","POST",{businessUnitId:e,weekDateId:i},{forceAsync:n.forceAsync},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import","POST",{businessUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl","POST",{businessUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementBusinessunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/businessunits","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementCalendarUrlIcs(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/calendar/url/ics","POST",{},{language:e.language},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/deletejob","POST",{},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementHistoricaldataValidate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/historicaldata/validate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementIntegrationsHriTimeofftypesJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs","POST",{hrisIntegrationId:e},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitAgentschedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search","POST",{managementUnitId:e},{forceAsync:i.forceAsync,forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitHistoricaladherencequery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitMove(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitMove';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/move","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitSchedulesSearch(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitSchedulesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitShrinkageJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeofflimits(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequests(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequests';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query","POST",{managementUnitId:e},{forceDownloadService:i.forceDownloadService},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffbalanceJobs(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs","POST",{managementUnitId:e,userId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';if(void 0===t||null===t)throw'Missing the required parameter "timeOffRequestId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs","POST",{managementUnitId:e,userId:i,timeOffRequestId:t},{},{},{},null,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';if(void 0===i||null===i)throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate","POST",{managementUnitId:e,userId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradeMatch(e,i,t,n){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===t||null===t)throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';if(void 0===n||null===n)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match","POST",{managementUnitId:e,weekDateId:i,tradeId:t},{},{},{},n,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttrades(e,i,t){if(void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttrades';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades","POST",{managementUnitId:e,weekDateId:i},{},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradesSearch(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search","POST",{managementUnitId:e,weekDateId:i},{forceDownloadService:n.forceDownloadService},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWeekShifttradesStateBulk(e,i,t,n){if(n=n||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';if(void 0===i||null===i)throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';if(void 0===t||null===t)throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk","POST",{managementUnitId:e,weekDateId:i},{forceAsync:n.forceAsync},{},{},t,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanCopy(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy","POST",{managementUnitId:e,workPlanId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanValidate(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';if(void 0===i||null===i)throw'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate","POST",{managementUnitId:e,workPlanId:i},{expand:this.apiClient.buildCollectionParam(t.expand,"multi")},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanrotationCopy(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';if(void 0===i||null===i)throw'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy","POST",{managementUnitId:e,workPlanRotationId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplanrotations(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations","POST",{managementUnitId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunitWorkplans(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplans';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans","POST",{managementUnitId:e},{validationMode:i.validationMode},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementManagementunits(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/managementunits","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementNotificationsUpdate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/notifications/update","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementSchedules(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/schedules","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTeamAdherenceHistorical(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';return this.apiClient.callApi("/api/v2/workforcemanagement/teams/{teamId}/adherence/historical","POST",{teamId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTeamShrinkageJobs(e,i){if(i=i||{},void 0===e||null===e)throw'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs","POST",{teamId:e},{},{},{},i.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffbalanceJobs(e){if(void 0===e||null===e)throw'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';return this.apiClient.callApi("/api/v2/workforcemanagement/timeoffbalance/jobs","POST",{},{},{},{},e,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeofflimitsAvailableQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeofflimits/available/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequests(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequestsEstimate(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/estimate","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(e){return e=e||{},this.apiClient.callApi("/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query","POST",{},{},{},{},e.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementAgentIntegrationsHris(e,i){if(void 0===e||null===e)throw'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';if(void 0===i||null===i)throw'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';return this.apiClient.callApi("/api/v2/workforcemanagement/agents/{agentId}/integrations/hris","PUT",{agentId:e},{},{},{},i,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementBusinessunitTimeofflimitValues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';return this.apiClient.callApi("/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values","PUT",{businessUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}putWorkforcemanagementManagementunitTimeofflimitValues(e,i,t){if(t=t||{},void 0===e||null===e)throw'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';if(void 0===i||null===i)throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';return this.apiClient.callApi("/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values","PUT",{managementUnitId:e,timeOffLimitId:i},{},{},{},t.body,["PureCloud OAuth"],["application/json"],["application/json"])}}return new class{constructor(){this.ApiClient=new d,this.ApiClientClass=d,this.AlertingApi=c,this.AnalyticsApi=g,this.ArchitectApi=h,this.AuditApi=m,this.AuthorizationApi=v,this.BillingApi=w,this.CarrierServicesApi=C,this.ChatApi=I,this.CoachingApi=f,this.ContentManagementApi=A,this.ConversationsApi=b,this.DataExtensionsApi=j,this.DownloadsApi=P,this.EmailsApi=y,this.EventsApi=O,this.ExternalContactsApi=M,this.FaxApi=T,this.FlowsApi=q,this.GamificationApi=S,this.GeneralDataProtectionRegulationApi=k,this.GeolocationApi=E,this.GreetingsApi=G,this.GroupsApi=U,this.IdentityProviderApi=D,this.InfrastructureAsCodeApi=x,this.IntegrationsApi=R,this.JourneyApi=z,this.KnowledgeApi=W,this.LanguageUnderstandingApi=B,this.LanguagesApi=L,this.LearningApi=N,this.LicenseApi=K,this.LocationsApi=J,this.LogCaptureApi=V,this.MessagingApi=F,this.MobileDevicesApi=Q,this.NotificationsApi=_,this.OAuthApi=H,this.ObjectsApi=$,this.OperationalEventsApi=Z,this.OrganizationApi=X,this.OrganizationAuthorizationApi=Y,this.OutboundApi=ee,this.PresenceApi=ie,this.ProcessAutomationApi=te,this.QualityApi=ne,this.RecordingApi=ae,this.ResponseManagementApi=oe,this.RoutingApi=re,this.SCIMApi=le,this.ScreenRecordingApi=se,this.ScriptsApi=pe,this.SearchApi=ue,this.SettingsApi=de,this.SpeechTextAnalyticsApi=ce,this.StationsApi=ge,this.SuggestApi=he,this.TaskManagementApi=me,this.TeamsApi=ve,this.TelephonyApi=we,this.TelephonyProvidersEdgeApi=Ce,this.TextbotsApi=Ie,this.TokensApi=fe,this.UploadsApi=Ae,this.UsageApi=be,this.UserRecordingsApi=je,this.UsersApi=Pe,this.UtilitiesApi=ye,this.VoicemailApi=Oe,this.WebChatApi=Me,this.WebDeploymentsApi=Te,this.WebMessagingApi=qe,this.WidgetsApi=Se,this.WorkforceManagementApi=ke,this.PureCloudRegionHosts=o}}}); \ No newline at end of file diff --git a/build/dist/web-cjs/bundle.js b/build/dist/web-cjs/bundle.js index 20e8cd97..86a8ebfa 100644 --- a/build/dist/web-cjs/bundle.js +++ b/build/dist/web-cjs/bundle.js @@ -855,7 +855,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/** * @module purecloud-platform-client-v2/ApiClient - * @version 194.0.0 + * @version 195.0.0 */var ApiClient=/*#__PURE__*/function(){/** * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an * application to use this class directly - the *Api and model classes provide the public API for the service. The @@ -1084,7 +1084,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/** * Returns a string representation for an actual parameter. * @param param The actual parameter. * @returns {String} The string representation of param. - */},{key:"paramToString",value:function paramToString(param){if(!param){return'';}if(param instanceof Date){return param.toJSON();}return param.toString();}/** + */},{key:"paramToString",value:function paramToString(param){if(!param){return'';}if(param instanceof Date){return param.toJSON();}if(param instanceof Boolean){return param.toString().toLowerCase();}return param.toString();}/** * Returns query parameters serialized in the format needed for an axios request. * @param param The unserialized query parameters. * @returns {Object} The serialized representation the query parameters. @@ -1167,7 +1167,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AlertingApi=/*#__PURE__*/function(){/** * Alerting service. * @module purecloud-platform-client-v2/api/AlertingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AlertingApi. * @alias module:purecloud-platform-client-v2/api/AlertingApi @@ -1324,7 +1324,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/** * Analytics service. * @module purecloud-platform-client-v2/api/AnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AnalyticsApi. * @alias module:purecloud-platform-client-v2/api/AnalyticsApi @@ -1356,6 +1356,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get status for async query for agent copilot aggregates + * + * @param {String} jobId jobId + * getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"getAnalyticsAgentcopilotsAggregatesJob",value:function getAnalyticsAgentcopilotsAggregatesJob(jobId){// verify the required parameter 'jobId' is set +if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Fetch a page of results for an async aggregates query + * + * @param {String} jobId jobId + * @param {Object} opts Optional parameters + * @param {String} opts.cursor Cursor token to retrieve next page + * getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"getAnalyticsAgentcopilotsAggregatesJobResults",value:function getAnalyticsAgentcopilotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set +if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get Reporting Turns (division aware). * Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. * @param {String} botFlowId ID of the bot flow. @@ -1547,6 +1561,17 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * Get AnalyticsReportingSettings for an organization * */},{key:"getAnalyticsReportingSettings",value:function getAnalyticsReportingSettings(){return this.apiClient.callApi('/api/v2/analytics/reporting/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get list of dashboard configurations + * + * @param {Object} dashboardType List dashboard of given type + * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard + * @param {Object} opts Optional parameters + * @param {String} opts.sortBy (default to desc) + * @param {Number} opts.pageNumber (default to 1) + * @param {Number} opts.pageSize (default to 9) + */},{key:"getAnalyticsReportingSettingsDashboardsQuery",value:function getAnalyticsReportingSettingsDashboardsQuery(dashboardType,dashboardAccessFilter,opts){opts=opts||{};// verify the required parameter 'dashboardType' is set +if(dashboardType===undefined||dashboardType===null){throw'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';}// verify the required parameter 'dashboardAccessFilter' is set +if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/dashboards/query','GET',{},{'dashboardType':dashboardType,'dashboardAccessFilter':dashboardAccessFilter,'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of dashboards for an user * * @param {String} userId User ID @@ -1661,6 +1686,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body query */},{key:"postAnalyticsActionsAggregatesQuery",value:function postAnalyticsActionsAggregatesQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Query for agent copilot aggregates asynchronously + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"postAnalyticsAgentcopilotsAggregatesJobs",value:function postAnalyticsAgentcopilotsAggregatesJobs(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Query for agent copilot aggregates + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"postAnalyticsAgentcopilotsAggregatesQuery",value:function postAnalyticsAgentcopilotsAggregatesQuery(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Query for bot aggregates asynchronously * * @param {Object} body query @@ -1786,8 +1823,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body query */},{key:"postAnalyticsQueuesObservationsQuery",value:function postAnalyticsQueuesObservationsQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/queues/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** - * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded - * + * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + * The max property can be used to determine estimated rate limit value hit. * @param {Object} body query */},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/ratelimits/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** @@ -1908,7 +1945,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/** * Architect service. * @module purecloud-platform-client-v2/api/ArchitectApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ArchitectApi. * @alias module:purecloud-platform-client-v2/api/ArchitectApi @@ -3024,7 +3061,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/** * Audit service. * @module purecloud-platform-client-v2/api/AuditApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AuditApi. * @alias module:purecloud-platform-client-v2/api/AuditApi @@ -3073,7 +3110,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/** * Authorization service. * @module purecloud-platform-client-v2/api/AuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AuthorizationApi. * @alias module:purecloud-platform-client-v2/api/AuthorizationApi @@ -3388,7 +3425,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/** * Billing service. * @module purecloud-platform-client-v2/api/BillingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new BillingApi. * @alias module:purecloud-platform-client-v2/api/BillingApi @@ -3412,7 +3449,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/** * CarrierServices service. * @module purecloud-platform-client-v2/api/CarrierServicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new CarrierServicesApi. * @alias module:purecloud-platform-client-v2/api/CarrierServicesApi @@ -3432,7 +3469,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param */},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/** * Chat service. * @module purecloud-platform-client-v2/api/ChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ChatApi. * @alias module:purecloud-platform-client-v2/api/ChatApi @@ -3657,7 +3694,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/** * Coaching service. * @module purecloud-platform-client-v2/api/CoachingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new CoachingApi. * @alias module:purecloud-platform-client-v2/api/CoachingApi @@ -3810,7 +3847,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/** * ContentManagement service. * @module purecloud-platform-client-v2/api/ContentManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ContentManagementApi. * @alias module:purecloud-platform-client-v2/api/ContentManagementApi @@ -4093,7 +4130,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId" if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/** * Conversations service. * @module purecloud-platform-client-v2/api/ConversationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ConversationsApi. * @alias module:purecloud-platform-client-v2/api/ConversationsApi @@ -4662,15 +4699,6 @@ if(messageSettingId===undefined||messageSettingId===null){throw'Missing the requ * Get the organization's default settings that will be used as the default when creating an integration. * When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it. */},{key:"getConversationsMessagingSettingsDefault",value:function getConversationsMessagingSettingsDefault(){return this.apiClient.callApi('/api/v2/conversations/messaging/settings/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** - * Get a list of Messaging Stickers (Deprecated) - * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - * @param {Object} messengerType Messenger Type - * @param {Object} opts Optional parameters - * @param {Number} opts.pageSize Page size (default to 25) - * @param {Number} opts.pageNumber Page number (default to 1) - * @deprecated - */},{key:"getConversationsMessagingSticker",value:function getConversationsMessagingSticker(messengerType,opts){opts=opts||{};// verify the required parameter 'messengerType' is set -if(messengerType===undefined||messengerType===null){throw'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';}return this.apiClient.callApi('/api/v2/conversations/messaging/stickers/{messengerType}','GET',{'messengerType':messengerType},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get a list of Supported Content profiles * * @param {Object} opts Optional parameters @@ -5445,6 +5473,11 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantReplace';}// verify the required parameter 'participantId' is set if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantReplace';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsEmailParticipantReplace';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + * + * @param {String} conversationId conversationId + */},{key:"postConversationsEmailReconnect",value:function postConversationsEmailReconnect(conversationId){// verify the required parameter 'conversationId' is set +if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/reconnect','POST',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create an email conversation * If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. * @param {Object} body Create email request @@ -5777,7 +5810,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/** * DataExtensions service. * @module purecloud-platform-client-v2/api/DataExtensionsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new DataExtensionsApi. * @alias module:purecloud-platform-client-v2/api/DataExtensionsApi @@ -5798,7 +5831,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par */},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/** * Downloads service. * @module purecloud-platform-client-v2/api/DownloadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new DownloadsApi. * @alias module:purecloud-platform-client-v2/api/DownloadsApi @@ -5817,7 +5850,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/** * Emails service. * @module purecloud-platform-client-v2/api/EmailsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new EmailsApi. * @alias module:purecloud-platform-client-v2/api/EmailsApi @@ -5835,7 +5868,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet */},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/** * Events service. * @module purecloud-platform-client-v2/api/EventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new EventsApi. * @alias module:purecloud-platform-client-v2/api/EventsApi @@ -5860,7 +5893,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/** * ExternalContacts service. * @module purecloud-platform-client-v2/api/ExternalContactsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ExternalContactsApi. * @alias module:purecloud-platform-client-v2/api/ExternalContactsApi @@ -6315,7 +6348,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/** * Fax service. * @module purecloud-platform-client-v2/api/FaxApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new FaxApi. * @alias module:purecloud-platform-client-v2/api/FaxApi @@ -6364,7 +6397,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/** * Flows service. * @module purecloud-platform-client-v2/api/FlowsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new FlowsApi. * @alias module:purecloud-platform-client-v2/api/FlowsApi @@ -6412,7 +6445,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/** * Gamification service. * @module purecloud-platform-client-v2/api/GamificationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GamificationApi. * @alias module:purecloud-platform-client-v2/api/GamificationApi @@ -6952,7 +6985,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/** * GeneralDataProtectionRegulation service. * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GeneralDataProtectionRegulationApi. * @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi @@ -6987,7 +7020,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/** * Geolocation service. * @module purecloud-platform-client-v2/api/GeolocationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GeolocationApi. * @alias module:purecloud-platform-client-v2/api/GeolocationApi @@ -7021,7 +7054,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/** * Greetings service. * @module purecloud-platform-client-v2/api/GreetingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GreetingsApi. * @alias module:purecloud-platform-client-v2/api/GreetingsApi @@ -7128,7 +7161,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/** * Groups service. * @module purecloud-platform-client-v2/api/GroupsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GroupsApi. * @alias module:purecloud-platform-client-v2/api/GroupsApi @@ -7261,7 +7294,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/** * IdentityProvider service. * @module purecloud-platform-client-v2/api/IdentityProviderApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new IdentityProviderApi. * @alias module:purecloud-platform-client-v2/api/IdentityProviderApi @@ -7417,7 +7450,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/** * InfrastructureAsCode service. * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new InfrastructureAsCodeApi. * @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi @@ -7471,7 +7504,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/** * Integrations service. * @module purecloud-platform-client-v2/api/IntegrationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new IntegrationsApi. * @alias module:purecloud-platform-client-v2/api/IntegrationsApi @@ -8082,7 +8115,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/** * Journey service. * @module purecloud-platform-client-v2/api/JourneyApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new JourneyApi. * @alias module:purecloud-platform-client-v2/api/JourneyApi @@ -8470,7 +8503,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/** * Knowledge service. * @module purecloud-platform-client-v2/api/KnowledgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new KnowledgeApi. * @alias module:purecloud-platform-client-v2/api/KnowledgeApi @@ -8883,9 +8916,10 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par * @param {Array.} opts.type If specified, retrieves operations with specified operation type, comma separated values expected. * @param {Array.} opts.status If specified, retrieves operations with specified operation status, comma separated values expected. * @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + * @param {Array.} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected. * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set -if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** +if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval'],'sourceId':this.apiClient.buildCollectionParam(opts['sourceId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get ids of operation creator users and oauth clients * * @param {String} knowledgeBaseId Knowledge base ID @@ -9382,7 +9416,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/** * LanguageUnderstanding service. * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LanguageUnderstandingApi. * @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi @@ -9642,7 +9676,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/** * Languages service. * @module purecloud-platform-client-v2/api/LanguagesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LanguagesApi. * @alias module:purecloud-platform-client-v2/api/LanguagesApi @@ -9697,7 +9731,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/** * Learning service. * @module purecloud-platform-client-v2/api/LearningApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LearningApi. * @alias module:purecloud-platform-client-v2/api/LearningApi @@ -9722,6 +9756,16 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " * @param {Array.} opts.expand Fields to expand in response */},{key:"getLearningAssignment",value:function getLearningAssignment(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling getLearningAssignment';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}','GET',{'assignmentId':assignmentId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {String} opts.shareableContentObjectId The ID of SCO to load + * @param {Array.} opts.expand Fields to expand in response + */},{key:"getLearningAssignmentStep",value:function getLearningAssignmentStep(assignmentId,stepId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set +if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';}// verify the required parameter 'stepId' is set +if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling getLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','GET',{'assignmentId':assignmentId,'stepId':stepId},{'shareableContentObjectId':opts['shareableContentObjectId'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * List of Learning module Assignments * Either moduleId or user value is required * @param {Object} opts Optional parameters @@ -9773,6 +9817,11 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " */},{key:"getLearningModuleJob",value:function getLearningModuleJob(moduleId,jobId){// verify the required parameter 'moduleId' is set if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling getLearningModuleJob';}// verify the required parameter 'jobId' is set if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getLearningModuleJob';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/jobs/{jobId}','GET',{'moduleId':moduleId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get a learning module preview + * + * @param {String} moduleId The ID of the learning module + */},{key:"getLearningModulePreview",value:function getLearningModulePreview(moduleId){// verify the required parameter 'moduleId' is set +if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling getLearningModulePreview';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/preview','GET',{'moduleId':moduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get a learning module rule * * @param {String} moduleId The ID of the learning module @@ -9819,6 +9868,11 @@ if(userIds===undefined||userIds===null){throw'Missing the required parameter "us * @param {String} coverArtId Key identifier for the cover art */},{key:"getLearningModulesCoverartCoverArtId",value:function getLearningModulesCoverartCoverArtId(coverArtId){// verify the required parameter 'coverArtId' is set if(coverArtId===undefined||coverArtId===null){throw'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';}return this.apiClient.callApi('/api/v2/learning/modules/coverart/{coverArtId}','GET',{'coverArtId':coverArtId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get Learning SCORM Result + * + * @param {String} scormId The ID of the SCORM package + */},{key:"getLearningScormScormId",value:function getLearningScormScormId(scormId){// verify the required parameter 'scormId' is set +if(scormId===undefined||scormId===null){throw'Missing the required parameter "scormId" when calling getLearningScormScormId';}return this.apiClient.callApi('/api/v2/learning/scorm/{scormId}','GET',{'scormId':scormId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update Learning Assignment * * @param {String} assignmentId The ID of Learning Assignment @@ -9833,6 +9887,15 @@ if(assignmentId===undefined||assignmentId===null){throw'Missing the required par * @param {Object} opts.body The Learning assignment reschedule model */},{key:"patchLearningAssignmentReschedule",value:function patchLearningAssignmentReschedule(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/reschedule','PATCH',{'assignmentId':assignmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {Object} opts.body The Learning Assignment Step to be updated + */},{key:"patchLearningAssignmentStep",value:function patchLearningAssignmentStep(assignmentId,stepId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set +if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';}// verify the required parameter 'stepId' is set +if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','PATCH',{'assignmentId':assignmentId,'stepId':stepId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update an external assignment for a specific user * * @param {String} moduleId Key identifier for the module @@ -9910,6 +9973,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body The slot search request */},{key:"postLearningScheduleslotsQuery",value:function postLearningScheduleslotsQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/learning/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Create a SCORM package upload request + * + * @param {Object} opts Optional parameters + * @param {Object} opts.body The SCORM package to be uploaded + */},{key:"postLearningScorm",value:function postLearningScorm(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/learning/scorm','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update a learning module * This will update the name, description, completion time in days and inform steps for a learning module * @param {String} moduleId The ID of the learning module @@ -9917,6 +9985,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putLearningModule",value:function putLearningModule(moduleId,body){// verify the required parameter 'moduleId' is set if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling putLearningModule';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update a learning module preview + * This will update a learning module preview + * @param {String} moduleId The ID of the learning module + * @param {Object} body The learning module to be updated + */},{key:"putLearningModulePreview",value:function putLearningModulePreview(moduleId,body){// verify the required parameter 'moduleId' is set +if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling putLearningModulePreview';}// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModulePreview';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/preview','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update a learning module rule * This will update a learning module rule with the specified fields. * @param {String} moduleId The ID of the learning module @@ -9926,7 +10001,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/** * License service. * @module purecloud-platform-client-v2/api/LicenseApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LicenseApi. * @alias module:purecloud-platform-client-v2/api/LicenseApi @@ -9980,7 +10055,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param */},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/** * Locations service. * @module purecloud-platform-client-v2/api/LocationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LocationsApi. * @alias module:purecloud-platform-client-v2/api/LocationsApi @@ -10039,7 +10114,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/** * LogCapture service. * @module purecloud-platform-client-v2/api/LogCaptureApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LogCaptureApi. * @alias module:purecloud-platform-client-v2/api/LogCaptureApi @@ -10089,7 +10164,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/** * Messaging service. * @module purecloud-platform-client-v2/api/MessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new MessagingApi. * @alias module:purecloud-platform-client-v2/api/MessagingApi @@ -10179,7 +10254,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/** * MobileDevices service. * @module purecloud-platform-client-v2/api/MobileDevicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new MobileDevicesApi. * @alias module:purecloud-platform-client-v2/api/MobileDevicesApi @@ -10218,7 +10293,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/** * Notifications service. * @module purecloud-platform-client-v2/api/NotificationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new NotificationsApi. * @alias module:purecloud-platform-client-v2/api/NotificationsApi @@ -10275,7 +10350,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/** * OAuth service. * @module purecloud-platform-client-v2/api/OAuthApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OAuthApi. * @alias module:purecloud-platform-client-v2/api/OAuthApi @@ -10360,7 +10435,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/** * Objects service. * @module purecloud-platform-client-v2/api/ObjectsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ObjectsApi. * @alias module:purecloud-platform-client-v2/api/ObjectsApi @@ -10431,7 +10506,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/** * OperationalEvents service. * @module purecloud-platform-client-v2/api/OperationalEventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OperationalEventsApi. * @alias module:purecloud-platform-client-v2/api/OperationalEventsApi @@ -10449,7 +10524,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re */},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/** * Organization service. * @module purecloud-platform-client-v2/api/OrganizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OrganizationApi. * @alias module:purecloud-platform-client-v2/api/OrganizationApi @@ -10554,7 +10629,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/** * OrganizationAuthorization service. * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OrganizationAuthorizationApi. * @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi @@ -10877,7 +10952,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/** * Outbound service. * @module purecloud-platform-client-v2/api/OutboundApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OutboundApi. * @alias module:purecloud-platform-client-v2/api/OutboundApi @@ -11949,7 +12024,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/** * Presence service. * @module purecloud-platform-client-v2/api/PresenceApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new PresenceApi. * @alias module:purecloud-platform-client-v2/api/PresenceApi @@ -12122,7 +12197,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/** * ProcessAutomation service. * @module purecloud-platform-client-v2/api/ProcessAutomationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ProcessAutomationApi. * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi @@ -12185,7 +12260,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/** * Quality service. * @module purecloud-platform-client-v2/api/QualityApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new QualityApi. * @alias module:purecloud-platform-client-v2/api/QualityApi @@ -12656,7 +12731,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/** * Recording service. * @module purecloud-platform-client-v2/api/RecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new RecordingApi. * @alias module:purecloud-platform-client-v2/api/RecordingApi @@ -13067,7 +13142,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/** * ResponseManagement service. * @module purecloud-platform-client-v2/api/ResponseManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ResponseManagementApi. * @alias module:purecloud-platform-client-v2/api/ResponseManagementApi @@ -13188,7 +13263,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/** * Routing service. * @module purecloud-platform-client-v2/api/RoutingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new RoutingApi. * @alias module:purecloud-platform-client-v2/api/RoutingApi @@ -13293,7 +13368,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * @param {String} labelId Utilization Label ID * @param {Object} opts Optional parameters * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false) - * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','DELETE',{'labelId':labelId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete an utilization tag @@ -13683,13 +13757,11 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * Get details about this utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of agent ids associated with a utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}/agents','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of utilization labels @@ -13699,7 +13771,6 @@ if(labelId===undefined||labelId===null){throw'Missing the required parameter "la * @param {Number} opts.pageNumber Page number (default to 1) * @param {Object} opts.sortOrder Sort order by name (default to ascending) * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' - * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabels",value:function getRoutingUtilizationLabels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/labels','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get details about this utilization tag * @@ -14044,7 +14115,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * Create a utilization label * * @param {Object} body UtilizationLabel - * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';}return this.apiClient.callApi('/api/v2/routing/utilization/labels','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create an utilization tag @@ -14133,7 +14203,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * * @param {String} labelId Utilization Label ID * @param {Object} body UtilizationLabel - * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','PUT',{'labelId':labelId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** @@ -14162,7 +14231,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/** * SCIM service. * @module purecloud-platform-client-v2/api/SCIMApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SCIMApi. * @alias module:purecloud-platform-client-v2/api/SCIMApi @@ -14387,7 +14456,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/** * ScreenRecording service. * @module purecloud-platform-client-v2/api/ScreenRecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ScreenRecordingApi. * @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi @@ -14402,7 +14471,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/** * Scripts service. * @module purecloud-platform-client-v2/api/ScriptsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ScriptsApi. * @alias module:purecloud-platform-client-v2/api/ScriptsApi @@ -14538,7 +14607,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter " */},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/** * Search service. * @module purecloud-platform-client-v2/api/SearchApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SearchApi. * @alias module:purecloud-platform-client-v2/api/SearchApi @@ -14698,7 +14767,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/** * Settings service. * @module purecloud-platform-client-v2/api/SettingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SettingsApi. * @alias module:purecloud-platform-client-v2/api/SettingsApi @@ -14726,7 +14795,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/** * SpeechTextAnalytics service. * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SpeechTextAnalyticsApi. * @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi @@ -14734,10 +14803,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use, * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified. */function SpeechTextAnalyticsApi(apiClient){_classCallCheck(this,SpeechTextAnalyticsApi);this.apiClient=apiClient||ApiClient.instance;}/** + * Delete a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + */return _createClass(SpeechTextAnalyticsApi,[{key:"deleteSpeechandtextanalyticsCategory",value:function deleteSpeechandtextanalyticsCategory(categoryId){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','DELETE',{'categoryId':categoryId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete a Speech and Text Analytics DictionaryFeedback by Id * * @param {String} dictionaryFeedbackId The Id of the Dictionary Feedback - */return _createClass(SpeechTextAnalyticsApi,[{key:"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId",value:function deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId){// verify the required parameter 'dictionaryFeedbackId' is set + */},{key:"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId",value:function deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId){// verify the required parameter 'dictionaryFeedbackId' is set if(dictionaryFeedbackId===undefined||dictionaryFeedbackId===null){throw'Missing the required parameter "dictionaryFeedbackId" when calling deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}','DELETE',{'dictionaryFeedbackId':dictionaryFeedbackId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete a Speech and Text Analytics program by id * @@ -14759,11 +14833,34 @@ if(sentimentFeedbackId===undefined||sentimentFeedbackId===null){throw'Missing th * @param {String} topicId The id of the topic */},{key:"deleteSpeechandtextanalyticsTopic",value:function deleteSpeechandtextanalyticsTopic(topicId){// verify the required parameter 'topicId' is set if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','DELETE',{'topicId':topicId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get the list of Speech and Text Analytics categories + * + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + * @param {String} opts.name The category name filter applied to the listing + * @param {Object} opts.sortOrder The sort order for the listing (default to asc) + * @param {Object} opts.sortBy The field to sort by for the listing (default to name) + * @param {Array.} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. + */},{key:"getSpeechandtextanalyticsCategories",value:function getSpeechandtextanalyticsCategories(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get a Speech and Text Analytics Category by ID + * + * @param {String} categoryId The id of the category + */},{key:"getSpeechandtextanalyticsCategory",value:function getSpeechandtextanalyticsCategory(categoryId){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','GET',{'categoryId':categoryId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get Speech and Text Analytics for a specific conversation * * @param {String} conversationId Conversation Id */},{key:"getSpeechandtextanalyticsConversation",value:function getSpeechandtextanalyticsConversation(conversationId){// verify the required parameter 'conversationId' is set if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversation';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/conversations/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get the list of detected Speech and Text Analytics categories of conversation + * + * @param {String} conversationId The id of the conversation + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + */},{key:"getSpeechandtextanalyticsConversationCategories",value:function getSpeechandtextanalyticsConversationCategories(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set +if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/conversations/{conversationId}/categories','GET',{'conversationId':conversationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation * * @param {String} conversationId Conversation ID @@ -14888,6 +14985,11 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" * @param {Object} body Speech And Text Analytics Settings */},{key:"patchSpeechandtextanalyticsSettings",value:function patchSpeechandtextanalyticsSettings(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSpeechandtextanalyticsSettings';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/settings','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Create new Speech and Text Analytics category + * + * @param {Object} body The category to create + */},{key:"postSpeechandtextanalyticsCategories",value:function postSpeechandtextanalyticsCategories(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create a Speech and Text Analytics DictionaryFeedback * * @param {Object} body The DictionaryFeedback to create @@ -14928,6 +15030,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body Search request options */},{key:"postSpeechandtextanalyticsTranscriptsSearch",value:function postSpeechandtextanalyticsTranscriptsSearch(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/transcripts/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + * @param {Object} body The updated category + */},{key:"putSpeechandtextanalyticsCategory",value:function putSpeechandtextanalyticsCategory(categoryId,body){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';}// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','PUT',{'categoryId':categoryId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update existing Speech and Text Analytics dictionary feedback by id * * @param {String} dictionaryFeedbackId The Id of the Dictionary Feedback @@ -14970,7 +15079,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/** * Stations service. * @module purecloud-platform-client-v2/api/StationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new StationsApi. * @alias module:purecloud-platform-client-v2/api/StationsApi @@ -15002,7 +15111,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter */},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/** * Suggest service. * @module purecloud-platform-client-v2/api/SuggestApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SuggestApi. * @alias module:purecloud-platform-client-v2/api/SuggestApi @@ -15042,7 +15151,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/** * TaskManagement service. * @module purecloud-platform-client-v2/api/TaskManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TaskManagementApi. * @alias module:purecloud-platform-client-v2/api/TaskManagementApi @@ -15371,7 +15480,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/** * Teams service. * @module purecloud-platform-client-v2/api/TeamsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TeamsApi. * @alias module:purecloud-platform-client-v2/api/TeamsApi @@ -15449,7 +15558,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/** * Telephony service. * @module purecloud-platform-client-v2/api/TelephonyApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TelephonyApi. * @alias module:purecloud-platform-client-v2/api/TelephonyApi @@ -15496,7 +15605,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/** * TelephonyProvidersEdge service. * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TelephonyProvidersEdgeApi. * @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi @@ -16306,7 +16415,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/** * Textbots service. * @module purecloud-platform-client-v2/api/TextbotsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TextbotsApi. * @alias module:purecloud-platform-client-v2/api/TextbotsApi @@ -16341,7 +16450,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/** * Tokens service. * @module purecloud-platform-client-v2/api/TokensApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TokensApi. * @alias module:purecloud-platform-client-v2/api/TokensApi @@ -16375,7 +16484,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user */},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/** * Uploads service. * @module purecloud-platform-client-v2/api/UploadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UploadsApi. * @alias module:purecloud-platform-client-v2/api/UploadsApi @@ -16441,7 +16550,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/** * Usage service. * @module purecloud-platform-client-v2/api/UsageApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UsageApi. * @alias module:purecloud-platform-client-v2/api/UsageApi @@ -16495,7 +16604,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/** * UserRecordings service. * @module purecloud-platform-client-v2/api/UserRecordingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UserRecordingsApi. * @alias module:purecloud-platform-client-v2/api/UserRecordingsApi @@ -16544,7 +16653,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/** * Users service. * @module purecloud-platform-client-v2/api/UsersApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UsersApi. * @alias module:purecloud-platform-client-v2/api/UsersApi @@ -17206,7 +17315,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/** * Utilities service. * @module purecloud-platform-client-v2/api/UtilitiesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UtilitiesApi. * @alias module:purecloud-platform-client-v2/api/UtilitiesApi @@ -17233,7 +17342,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/** * Voicemail service. * @module purecloud-platform-client-v2/api/VoicemailApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new VoicemailApi. * @alias module:purecloud-platform-client-v2/api/VoicemailApi @@ -17382,7 +17491,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/** * WebChat service. * @module purecloud-platform-client-v2/api/WebChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebChatApi. * @alias module:purecloud-platform-client-v2/api/WebChatApi @@ -17517,7 +17626,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/** * WebDeployments service. * @module purecloud-platform-client-v2/api/WebDeploymentsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebDeploymentsApi. * @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi @@ -17638,7 +17747,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/** * WebMessaging service. * @module purecloud-platform-client-v2/api/WebMessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebMessagingApi. * @alias module:purecloud-platform-client-v2/api/WebMessagingApi @@ -17654,7 +17763,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet */return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/** * Widgets service. * @module purecloud-platform-client-v2/api/WidgetsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WidgetsApi. * @alias module:purecloud-platform-client-v2/api/WidgetsApi @@ -17689,7 +17798,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/** * WorkforceManagement service. * @module purecloud-platform-client-v2/api/WorkforceManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WorkforceManagementApi. * @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi @@ -19169,7 +19278,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required * *

* @module purecloud-platform-client-v2/index - * @version 194.0.0 + * @version 195.0.0 */var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/** * The ApiClient constructor. * @property {module:purecloud-platform-client-v2/ApiClient} diff --git a/build/dist/web-cjs/purecloud-platform-client-v2.js b/build/dist/web-cjs/purecloud-platform-client-v2.js index a38935a0..e9cc24ac 100644 --- a/build/dist/web-cjs/purecloud-platform-client-v2.js +++ b/build/dist/web-cjs/purecloud-platform-client-v2.js @@ -6054,7 +6054,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/** * @module purecloud-platform-client-v2/ApiClient - * @version 194.0.0 + * @version 195.0.0 */var ApiClient=/*#__PURE__*/function(){/** * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an * application to use this class directly - the *Api and model classes provide the public API for the service. The @@ -6283,7 +6283,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/** * Returns a string representation for an actual parameter. * @param param The actual parameter. * @returns {String} The string representation of param. - */},{key:"paramToString",value:function paramToString(param){if(!param){return'';}if(param instanceof Date){return param.toJSON();}return param.toString();}/** + */},{key:"paramToString",value:function paramToString(param){if(!param){return'';}if(param instanceof Date){return param.toJSON();}if(param instanceof Boolean){return param.toString().toLowerCase();}return param.toString();}/** * Returns query parameters serialized in the format needed for an axios request. * @param param The unserialized query parameters. * @returns {Object} The serialized representation the query parameters. @@ -6366,7 +6366,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AlertingApi=/*#__PURE__*/function(){/** * Alerting service. * @module purecloud-platform-client-v2/api/AlertingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AlertingApi. * @alias module:purecloud-platform-client-v2/api/AlertingApi @@ -6523,7 +6523,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/** * Analytics service. * @module purecloud-platform-client-v2/api/AnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AnalyticsApi. * @alias module:purecloud-platform-client-v2/api/AnalyticsApi @@ -6555,6 +6555,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get status for async query for agent copilot aggregates + * + * @param {String} jobId jobId + * getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"getAnalyticsAgentcopilotsAggregatesJob",value:function getAnalyticsAgentcopilotsAggregatesJob(jobId){// verify the required parameter 'jobId' is set +if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Fetch a page of results for an async aggregates query + * + * @param {String} jobId jobId + * @param {Object} opts Optional parameters + * @param {String} opts.cursor Cursor token to retrieve next page + * getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"getAnalyticsAgentcopilotsAggregatesJobResults",value:function getAnalyticsAgentcopilotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set +if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get Reporting Turns (division aware). * Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. * @param {String} botFlowId ID of the bot flow. @@ -6746,6 +6760,17 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * Get AnalyticsReportingSettings for an organization * */},{key:"getAnalyticsReportingSettings",value:function getAnalyticsReportingSettings(){return this.apiClient.callApi('/api/v2/analytics/reporting/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get list of dashboard configurations + * + * @param {Object} dashboardType List dashboard of given type + * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard + * @param {Object} opts Optional parameters + * @param {String} opts.sortBy (default to desc) + * @param {Number} opts.pageNumber (default to 1) + * @param {Number} opts.pageSize (default to 9) + */},{key:"getAnalyticsReportingSettingsDashboardsQuery",value:function getAnalyticsReportingSettingsDashboardsQuery(dashboardType,dashboardAccessFilter,opts){opts=opts||{};// verify the required parameter 'dashboardType' is set +if(dashboardType===undefined||dashboardType===null){throw'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';}// verify the required parameter 'dashboardAccessFilter' is set +if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/dashboards/query','GET',{},{'dashboardType':dashboardType,'dashboardAccessFilter':dashboardAccessFilter,'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of dashboards for an user * * @param {String} userId User ID @@ -6860,6 +6885,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body query */},{key:"postAnalyticsActionsAggregatesQuery",value:function postAnalyticsActionsAggregatesQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Query for agent copilot aggregates asynchronously + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"postAnalyticsAgentcopilotsAggregatesJobs",value:function postAnalyticsAgentcopilotsAggregatesJobs(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Query for agent copilot aggregates + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */},{key:"postAnalyticsAgentcopilotsAggregatesQuery",value:function postAnalyticsAgentcopilotsAggregatesQuery(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/agentcopilots/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Query for bot aggregates asynchronously * * @param {Object} body query @@ -6985,8 +7022,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body query */},{key:"postAnalyticsQueuesObservationsQuery",value:function postAnalyticsQueuesObservationsQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/queues/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** - * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded - * + * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + * The max property can be used to determine estimated rate limit value hit. * @param {Object} body query */},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/ratelimits/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** @@ -7107,7 +7144,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/** * Architect service. * @module purecloud-platform-client-v2/api/ArchitectApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ArchitectApi. * @alias module:purecloud-platform-client-v2/api/ArchitectApi @@ -8223,7 +8260,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/** * Audit service. * @module purecloud-platform-client-v2/api/AuditApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AuditApi. * @alias module:purecloud-platform-client-v2/api/AuditApi @@ -8272,7 +8309,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/** * Authorization service. * @module purecloud-platform-client-v2/api/AuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new AuthorizationApi. * @alias module:purecloud-platform-client-v2/api/AuthorizationApi @@ -8587,7 +8624,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/** * Billing service. * @module purecloud-platform-client-v2/api/BillingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new BillingApi. * @alias module:purecloud-platform-client-v2/api/BillingApi @@ -8611,7 +8648,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/** * CarrierServices service. * @module purecloud-platform-client-v2/api/CarrierServicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new CarrierServicesApi. * @alias module:purecloud-platform-client-v2/api/CarrierServicesApi @@ -8631,7 +8668,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param */},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/** * Chat service. * @module purecloud-platform-client-v2/api/ChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ChatApi. * @alias module:purecloud-platform-client-v2/api/ChatApi @@ -8856,7 +8893,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/** * Coaching service. * @module purecloud-platform-client-v2/api/CoachingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new CoachingApi. * @alias module:purecloud-platform-client-v2/api/CoachingApi @@ -9009,7 +9046,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/** * ContentManagement service. * @module purecloud-platform-client-v2/api/ContentManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ContentManagementApi. * @alias module:purecloud-platform-client-v2/api/ContentManagementApi @@ -9292,7 +9329,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId" if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/** * Conversations service. * @module purecloud-platform-client-v2/api/ConversationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ConversationsApi. * @alias module:purecloud-platform-client-v2/api/ConversationsApi @@ -9861,15 +9898,6 @@ if(messageSettingId===undefined||messageSettingId===null){throw'Missing the requ * Get the organization's default settings that will be used as the default when creating an integration. * When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it. */},{key:"getConversationsMessagingSettingsDefault",value:function getConversationsMessagingSettingsDefault(){return this.apiClient.callApi('/api/v2/conversations/messaging/settings/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** - * Get a list of Messaging Stickers (Deprecated) - * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - * @param {Object} messengerType Messenger Type - * @param {Object} opts Optional parameters - * @param {Number} opts.pageSize Page size (default to 25) - * @param {Number} opts.pageNumber Page number (default to 1) - * @deprecated - */},{key:"getConversationsMessagingSticker",value:function getConversationsMessagingSticker(messengerType,opts){opts=opts||{};// verify the required parameter 'messengerType' is set -if(messengerType===undefined||messengerType===null){throw'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker';}return this.apiClient.callApi('/api/v2/conversations/messaging/stickers/{messengerType}','GET',{'messengerType':messengerType},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get a list of Supported Content profiles * * @param {Object} opts Optional parameters @@ -10644,6 +10672,11 @@ if(communicationId===undefined||communicationId===null){throw'Missing the requir if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsEmailParticipantReplace';}// verify the required parameter 'participantId' is set if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsEmailParticipantReplace';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsEmailParticipantReplace';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + * + * @param {String} conversationId conversationId + */},{key:"postConversationsEmailReconnect",value:function postConversationsEmailReconnect(conversationId){// verify the required parameter 'conversationId' is set +if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/reconnect','POST',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create an email conversation * If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. * @param {Object} body Create email request @@ -10976,7 +11009,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/** * DataExtensions service. * @module purecloud-platform-client-v2/api/DataExtensionsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new DataExtensionsApi. * @alias module:purecloud-platform-client-v2/api/DataExtensionsApi @@ -10997,7 +11030,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par */},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/** * Downloads service. * @module purecloud-platform-client-v2/api/DownloadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new DownloadsApi. * @alias module:purecloud-platform-client-v2/api/DownloadsApi @@ -11016,7 +11049,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/** * Emails service. * @module purecloud-platform-client-v2/api/EmailsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new EmailsApi. * @alias module:purecloud-platform-client-v2/api/EmailsApi @@ -11034,7 +11067,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet */},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/** * Events service. * @module purecloud-platform-client-v2/api/EventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new EventsApi. * @alias module:purecloud-platform-client-v2/api/EventsApi @@ -11059,7 +11092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/** * ExternalContacts service. * @module purecloud-platform-client-v2/api/ExternalContactsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ExternalContactsApi. * @alias module:purecloud-platform-client-v2/api/ExternalContactsApi @@ -11514,7 +11547,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/** * Fax service. * @module purecloud-platform-client-v2/api/FaxApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new FaxApi. * @alias module:purecloud-platform-client-v2/api/FaxApi @@ -11563,7 +11596,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/** * Flows service. * @module purecloud-platform-client-v2/api/FlowsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new FlowsApi. * @alias module:purecloud-platform-client-v2/api/FlowsApi @@ -11611,7 +11644,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/** * Gamification service. * @module purecloud-platform-client-v2/api/GamificationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GamificationApi. * @alias module:purecloud-platform-client-v2/api/GamificationApi @@ -12151,7 +12184,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/** * GeneralDataProtectionRegulation service. * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GeneralDataProtectionRegulationApi. * @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi @@ -12186,7 +12219,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/** * Geolocation service. * @module purecloud-platform-client-v2/api/GeolocationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GeolocationApi. * @alias module:purecloud-platform-client-v2/api/GeolocationApi @@ -12220,7 +12253,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/** * Greetings service. * @module purecloud-platform-client-v2/api/GreetingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GreetingsApi. * @alias module:purecloud-platform-client-v2/api/GreetingsApi @@ -12327,7 +12360,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/** * Groups service. * @module purecloud-platform-client-v2/api/GroupsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new GroupsApi. * @alias module:purecloud-platform-client-v2/api/GroupsApi @@ -12460,7 +12493,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/** * IdentityProvider service. * @module purecloud-platform-client-v2/api/IdentityProviderApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new IdentityProviderApi. * @alias module:purecloud-platform-client-v2/api/IdentityProviderApi @@ -12616,7 +12649,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/** * InfrastructureAsCode service. * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new InfrastructureAsCodeApi. * @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi @@ -12670,7 +12703,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/** * Integrations service. * @module purecloud-platform-client-v2/api/IntegrationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new IntegrationsApi. * @alias module:purecloud-platform-client-v2/api/IntegrationsApi @@ -13281,7 +13314,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/** * Journey service. * @module purecloud-platform-client-v2/api/JourneyApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new JourneyApi. * @alias module:purecloud-platform-client-v2/api/JourneyApi @@ -13669,7 +13702,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/** * Knowledge service. * @module purecloud-platform-client-v2/api/KnowledgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new KnowledgeApi. * @alias module:purecloud-platform-client-v2/api/KnowledgeApi @@ -14082,9 +14115,10 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par * @param {Array.} opts.type If specified, retrieves operations with specified operation type, comma separated values expected. * @param {Array.} opts.status If specified, retrieves operations with specified operation status, comma separated values expected. * @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + * @param {Array.} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected. * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set -if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** +if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval'],'sourceId':this.apiClient.buildCollectionParam(opts['sourceId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get ids of operation creator users and oauth clients * * @param {String} knowledgeBaseId Knowledge base ID @@ -14581,7 +14615,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/** * LanguageUnderstanding service. * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LanguageUnderstandingApi. * @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi @@ -14841,7 +14875,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/** * Languages service. * @module purecloud-platform-client-v2/api/LanguagesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LanguagesApi. * @alias module:purecloud-platform-client-v2/api/LanguagesApi @@ -14896,7 +14930,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/** * Learning service. * @module purecloud-platform-client-v2/api/LearningApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LearningApi. * @alias module:purecloud-platform-client-v2/api/LearningApi @@ -14921,6 +14955,16 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " * @param {Array.} opts.expand Fields to expand in response */},{key:"getLearningAssignment",value:function getLearningAssignment(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling getLearningAssignment';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}','GET',{'assignmentId':assignmentId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {String} opts.shareableContentObjectId The ID of SCO to load + * @param {Array.} opts.expand Fields to expand in response + */},{key:"getLearningAssignmentStep",value:function getLearningAssignmentStep(assignmentId,stepId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set +if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';}// verify the required parameter 'stepId' is set +if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling getLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','GET',{'assignmentId':assignmentId,'stepId':stepId},{'shareableContentObjectId':opts['shareableContentObjectId'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * List of Learning module Assignments * Either moduleId or user value is required * @param {Object} opts Optional parameters @@ -14972,6 +15016,11 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " */},{key:"getLearningModuleJob",value:function getLearningModuleJob(moduleId,jobId){// verify the required parameter 'moduleId' is set if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling getLearningModuleJob';}// verify the required parameter 'jobId' is set if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getLearningModuleJob';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/jobs/{jobId}','GET',{'moduleId':moduleId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get a learning module preview + * + * @param {String} moduleId The ID of the learning module + */},{key:"getLearningModulePreview",value:function getLearningModulePreview(moduleId){// verify the required parameter 'moduleId' is set +if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling getLearningModulePreview';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/preview','GET',{'moduleId':moduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get a learning module rule * * @param {String} moduleId The ID of the learning module @@ -15018,6 +15067,11 @@ if(userIds===undefined||userIds===null){throw'Missing the required parameter "us * @param {String} coverArtId Key identifier for the cover art */},{key:"getLearningModulesCoverartCoverArtId",value:function getLearningModulesCoverartCoverArtId(coverArtId){// verify the required parameter 'coverArtId' is set if(coverArtId===undefined||coverArtId===null){throw'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';}return this.apiClient.callApi('/api/v2/learning/modules/coverart/{coverArtId}','GET',{'coverArtId':coverArtId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get Learning SCORM Result + * + * @param {String} scormId The ID of the SCORM package + */},{key:"getLearningScormScormId",value:function getLearningScormScormId(scormId){// verify the required parameter 'scormId' is set +if(scormId===undefined||scormId===null){throw'Missing the required parameter "scormId" when calling getLearningScormScormId';}return this.apiClient.callApi('/api/v2/learning/scorm/{scormId}','GET',{'scormId':scormId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update Learning Assignment * * @param {String} assignmentId The ID of Learning Assignment @@ -15032,6 +15086,15 @@ if(assignmentId===undefined||assignmentId===null){throw'Missing the required par * @param {Object} opts.body The Learning assignment reschedule model */},{key:"patchLearningAssignmentReschedule",value:function patchLearningAssignmentReschedule(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/reschedule','PATCH',{'assignmentId':assignmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {Object} opts.body The Learning Assignment Step to be updated + */},{key:"patchLearningAssignmentStep",value:function patchLearningAssignmentStep(assignmentId,stepId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set +if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep';}// verify the required parameter 'stepId' is set +if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling patchLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','PATCH',{'assignmentId':assignmentId,'stepId':stepId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update an external assignment for a specific user * * @param {String} moduleId Key identifier for the module @@ -15109,6 +15172,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body The slot search request */},{key:"postLearningScheduleslotsQuery",value:function postLearningScheduleslotsQuery(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/learning/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Create a SCORM package upload request + * + * @param {Object} opts Optional parameters + * @param {Object} opts.body The SCORM package to be uploaded + */},{key:"postLearningScorm",value:function postLearningScorm(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/learning/scorm','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update a learning module * This will update the name, description, completion time in days and inform steps for a learning module * @param {String} moduleId The ID of the learning module @@ -15116,6 +15184,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putLearningModule",value:function putLearningModule(moduleId,body){// verify the required parameter 'moduleId' is set if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling putLearningModule';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update a learning module preview + * This will update a learning module preview + * @param {String} moduleId The ID of the learning module + * @param {Object} body The learning module to be updated + */},{key:"putLearningModulePreview",value:function putLearningModulePreview(moduleId,body){// verify the required parameter 'moduleId' is set +if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling putLearningModulePreview';}// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModulePreview';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/preview','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update a learning module rule * This will update a learning module rule with the specified fields. * @param {String} moduleId The ID of the learning module @@ -15125,7 +15200,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/** * License service. * @module purecloud-platform-client-v2/api/LicenseApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LicenseApi. * @alias module:purecloud-platform-client-v2/api/LicenseApi @@ -15179,7 +15254,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param */},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/** * Locations service. * @module purecloud-platform-client-v2/api/LocationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LocationsApi. * @alias module:purecloud-platform-client-v2/api/LocationsApi @@ -15238,7 +15313,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/** * LogCapture service. * @module purecloud-platform-client-v2/api/LogCaptureApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new LogCaptureApi. * @alias module:purecloud-platform-client-v2/api/LogCaptureApi @@ -15288,7 +15363,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/** * Messaging service. * @module purecloud-platform-client-v2/api/MessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new MessagingApi. * @alias module:purecloud-platform-client-v2/api/MessagingApi @@ -15378,7 +15453,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/** * MobileDevices service. * @module purecloud-platform-client-v2/api/MobileDevicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new MobileDevicesApi. * @alias module:purecloud-platform-client-v2/api/MobileDevicesApi @@ -15417,7 +15492,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/** * Notifications service. * @module purecloud-platform-client-v2/api/NotificationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new NotificationsApi. * @alias module:purecloud-platform-client-v2/api/NotificationsApi @@ -15474,7 +15549,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/** * OAuth service. * @module purecloud-platform-client-v2/api/OAuthApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OAuthApi. * @alias module:purecloud-platform-client-v2/api/OAuthApi @@ -15559,7 +15634,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/** * Objects service. * @module purecloud-platform-client-v2/api/ObjectsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ObjectsApi. * @alias module:purecloud-platform-client-v2/api/ObjectsApi @@ -15630,7 +15705,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/** * OperationalEvents service. * @module purecloud-platform-client-v2/api/OperationalEventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OperationalEventsApi. * @alias module:purecloud-platform-client-v2/api/OperationalEventsApi @@ -15648,7 +15723,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re */},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/** * Organization service. * @module purecloud-platform-client-v2/api/OrganizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OrganizationApi. * @alias module:purecloud-platform-client-v2/api/OrganizationApi @@ -15753,7 +15828,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/** * OrganizationAuthorization service. * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OrganizationAuthorizationApi. * @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi @@ -16076,7 +16151,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/** * Outbound service. * @module purecloud-platform-client-v2/api/OutboundApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new OutboundApi. * @alias module:purecloud-platform-client-v2/api/OutboundApi @@ -17148,7 +17223,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/** * Presence service. * @module purecloud-platform-client-v2/api/PresenceApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new PresenceApi. * @alias module:purecloud-platform-client-v2/api/PresenceApi @@ -17321,7 +17396,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/** * ProcessAutomation service. * @module purecloud-platform-client-v2/api/ProcessAutomationApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ProcessAutomationApi. * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi @@ -17384,7 +17459,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/** * Quality service. * @module purecloud-platform-client-v2/api/QualityApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new QualityApi. * @alias module:purecloud-platform-client-v2/api/QualityApi @@ -17855,7 +17930,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/** * Recording service. * @module purecloud-platform-client-v2/api/RecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new RecordingApi. * @alias module:purecloud-platform-client-v2/api/RecordingApi @@ -18266,7 +18341,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/** * ResponseManagement service. * @module purecloud-platform-client-v2/api/ResponseManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ResponseManagementApi. * @alias module:purecloud-platform-client-v2/api/ResponseManagementApi @@ -18387,7 +18462,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/** * Routing service. * @module purecloud-platform-client-v2/api/RoutingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new RoutingApi. * @alias module:purecloud-platform-client-v2/api/RoutingApi @@ -18492,7 +18567,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * @param {String} labelId Utilization Label ID * @param {Object} opts Optional parameters * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false) - * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','DELETE',{'labelId':labelId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete an utilization tag @@ -18882,13 +18956,11 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user * Get details about this utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of agent ids associated with a utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}/agents','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get list of utilization labels @@ -18898,7 +18970,6 @@ if(labelId===undefined||labelId===null){throw'Missing the required parameter "la * @param {Number} opts.pageNumber Page number (default to 1) * @param {Object} opts.sortOrder Sort order by name (default to ascending) * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' - * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"getRoutingUtilizationLabels",value:function getRoutingUtilizationLabels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/labels','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get details about this utilization tag * @@ -19243,7 +19314,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * Create a utilization label * * @param {Object} body UtilizationLabel - * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';}return this.apiClient.callApi('/api/v2/routing/utilization/labels','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create an utilization tag @@ -19332,7 +19402,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * * @param {String} labelId Utilization Label ID * @param {Object} body UtilizationLabel - * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','PUT',{'labelId':labelId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** @@ -19361,7 +19430,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/** * SCIM service. * @module purecloud-platform-client-v2/api/SCIMApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SCIMApi. * @alias module:purecloud-platform-client-v2/api/SCIMApi @@ -19586,7 +19655,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/** * ScreenRecording service. * @module purecloud-platform-client-v2/api/ScreenRecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ScreenRecordingApi. * @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi @@ -19601,7 +19670,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh */return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/** * Scripts service. * @module purecloud-platform-client-v2/api/ScriptsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new ScriptsApi. * @alias module:purecloud-platform-client-v2/api/ScriptsApi @@ -19737,7 +19806,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter " */},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/** * Search service. * @module purecloud-platform-client-v2/api/SearchApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SearchApi. * @alias module:purecloud-platform-client-v2/api/SearchApi @@ -19897,7 +19966,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/** * Settings service. * @module purecloud-platform-client-v2/api/SettingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SettingsApi. * @alias module:purecloud-platform-client-v2/api/SettingsApi @@ -19925,7 +19994,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/** * SpeechTextAnalytics service. * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SpeechTextAnalyticsApi. * @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi @@ -19933,10 +20002,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use, * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified. */function SpeechTextAnalyticsApi(apiClient){_classCallCheck(this,SpeechTextAnalyticsApi);this.apiClient=apiClient||ApiClient.instance;}/** + * Delete a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + */return _createClass(SpeechTextAnalyticsApi,[{key:"deleteSpeechandtextanalyticsCategory",value:function deleteSpeechandtextanalyticsCategory(categoryId){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','DELETE',{'categoryId':categoryId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete a Speech and Text Analytics DictionaryFeedback by Id * * @param {String} dictionaryFeedbackId The Id of the Dictionary Feedback - */return _createClass(SpeechTextAnalyticsApi,[{key:"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId",value:function deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId){// verify the required parameter 'dictionaryFeedbackId' is set + */},{key:"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId",value:function deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId){// verify the required parameter 'dictionaryFeedbackId' is set if(dictionaryFeedbackId===undefined||dictionaryFeedbackId===null){throw'Missing the required parameter "dictionaryFeedbackId" when calling deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}','DELETE',{'dictionaryFeedbackId':dictionaryFeedbackId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Delete a Speech and Text Analytics program by id * @@ -19958,11 +20032,34 @@ if(sentimentFeedbackId===undefined||sentimentFeedbackId===null){throw'Missing th * @param {String} topicId The id of the topic */},{key:"deleteSpeechandtextanalyticsTopic",value:function deleteSpeechandtextanalyticsTopic(topicId){// verify the required parameter 'topicId' is set if(topicId===undefined||topicId===null){throw'Missing the required parameter "topicId" when calling deleteSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','DELETE',{'topicId':topicId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get the list of Speech and Text Analytics categories + * + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + * @param {String} opts.name The category name filter applied to the listing + * @param {Object} opts.sortOrder The sort order for the listing (default to asc) + * @param {Object} opts.sortBy The field to sort by for the listing (default to name) + * @param {Array.} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. + */},{key:"getSpeechandtextanalyticsCategories",value:function getSpeechandtextanalyticsCategories(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get a Speech and Text Analytics Category by ID + * + * @param {String} categoryId The id of the category + */},{key:"getSpeechandtextanalyticsCategory",value:function getSpeechandtextanalyticsCategory(categoryId){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','GET',{'categoryId':categoryId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get Speech and Text Analytics for a specific conversation * * @param {String} conversationId Conversation Id */},{key:"getSpeechandtextanalyticsConversation",value:function getSpeechandtextanalyticsConversation(conversationId){// verify the required parameter 'conversationId' is set if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversation';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/conversations/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Get the list of detected Speech and Text Analytics categories of conversation + * + * @param {String} conversationId The id of the conversation + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + */},{key:"getSpeechandtextanalyticsConversationCategories",value:function getSpeechandtextanalyticsConversationCategories(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set +if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/conversations/{conversationId}/categories','GET',{'conversationId':conversationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation * * @param {String} conversationId Conversation ID @@ -20087,6 +20184,11 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" * @param {Object} body Speech And Text Analytics Settings */},{key:"patchSpeechandtextanalyticsSettings",value:function patchSpeechandtextanalyticsSettings(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSpeechandtextanalyticsSettings';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/settings','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Create new Speech and Text Analytics category + * + * @param {Object} body The category to create + */},{key:"postSpeechandtextanalyticsCategories",value:function postSpeechandtextanalyticsCategories(body){// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Create a Speech and Text Analytics DictionaryFeedback * * @param {Object} body The DictionaryFeedback to create @@ -20127,6 +20229,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh * @param {Object} body Search request options */},{key:"postSpeechandtextanalyticsTranscriptsSearch",value:function postSpeechandtextanalyticsTranscriptsSearch(body){// verify the required parameter 'body' is set if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSpeechandtextanalyticsTranscriptsSearch';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/transcripts/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** + * Update a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + * @param {Object} body The updated category + */},{key:"putSpeechandtextanalyticsCategory",value:function putSpeechandtextanalyticsCategory(categoryId,body){// verify the required parameter 'categoryId' is set +if(categoryId===undefined||categoryId===null){throw'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory';}// verify the required parameter 'body' is set +if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories/{categoryId}','PUT',{'categoryId':categoryId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/** * Update existing Speech and Text Analytics dictionary feedback by id * * @param {String} dictionaryFeedbackId The Id of the Dictionary Feedback @@ -20169,7 +20278,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/** * Stations service. * @module purecloud-platform-client-v2/api/StationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new StationsApi. * @alias module:purecloud-platform-client-v2/api/StationsApi @@ -20201,7 +20310,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter */},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/** * Suggest service. * @module purecloud-platform-client-v2/api/SuggestApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new SuggestApi. * @alias module:purecloud-platform-client-v2/api/SuggestApi @@ -20241,7 +20350,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/** * TaskManagement service. * @module purecloud-platform-client-v2/api/TaskManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TaskManagementApi. * @alias module:purecloud-platform-client-v2/api/TaskManagementApi @@ -20570,7 +20679,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter " if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/** * Teams service. * @module purecloud-platform-client-v2/api/TeamsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TeamsApi. * @alias module:purecloud-platform-client-v2/api/TeamsApi @@ -20648,7 +20757,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/** * Telephony service. * @module purecloud-platform-client-v2/api/TelephonyApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TelephonyApi. * @alias module:purecloud-platform-client-v2/api/TelephonyApi @@ -20695,7 +20804,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/** * TelephonyProvidersEdge service. * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TelephonyProvidersEdgeApi. * @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi @@ -21505,7 +21614,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/** * Textbots service. * @module purecloud-platform-client-v2/api/TextbotsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TextbotsApi. * @alias module:purecloud-platform-client-v2/api/TextbotsApi @@ -21540,7 +21649,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/** * Tokens service. * @module purecloud-platform-client-v2/api/TokensApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new TokensApi. * @alias module:purecloud-platform-client-v2/api/TokensApi @@ -21574,7 +21683,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user */},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/** * Uploads service. * @module purecloud-platform-client-v2/api/UploadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UploadsApi. * @alias module:purecloud-platform-client-v2/api/UploadsApi @@ -21640,7 +21749,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/** * Usage service. * @module purecloud-platform-client-v2/api/UsageApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UsageApi. * @alias module:purecloud-platform-client-v2/api/UsageApi @@ -21694,7 +21803,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/** * UserRecordings service. * @module purecloud-platform-client-v2/api/UserRecordingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UserRecordingsApi. * @alias module:purecloud-platform-client-v2/api/UserRecordingsApi @@ -21743,7 +21852,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/** * Users service. * @module purecloud-platform-client-v2/api/UsersApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UsersApi. * @alias module:purecloud-platform-client-v2/api/UsersApi @@ -22405,7 +22514,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/** * Utilities service. * @module purecloud-platform-client-v2/api/UtilitiesApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new UtilitiesApi. * @alias module:purecloud-platform-client-v2/api/UtilitiesApi @@ -22432,7 +22541,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/** * Voicemail service. * @module purecloud-platform-client-v2/api/VoicemailApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new VoicemailApi. * @alias module:purecloud-platform-client-v2/api/VoicemailApi @@ -22581,7 +22690,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/** * WebChat service. * @module purecloud-platform-client-v2/api/WebChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebChatApi. * @alias module:purecloud-platform-client-v2/api/WebChatApi @@ -22716,7 +22825,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/** * WebDeployments service. * @module purecloud-platform-client-v2/api/WebDeploymentsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebDeploymentsApi. * @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi @@ -22837,7 +22946,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/** * WebMessaging service. * @module purecloud-platform-client-v2/api/WebMessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WebMessagingApi. * @alias module:purecloud-platform-client-v2/api/WebMessagingApi @@ -22853,7 +22962,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet */return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/** * Widgets service. * @module purecloud-platform-client-v2/api/WidgetsApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WidgetsApi. * @alias module:purecloud-platform-client-v2/api/WidgetsApi @@ -22888,7 +22997,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/** * WorkforceManagement service. * @module purecloud-platform-client-v2/api/WorkforceManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** * Constructs a new WorkforceManagementApi. * @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi @@ -24368,7 +24477,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required * *

* @module purecloud-platform-client-v2/index - * @version 194.0.0 + * @version 195.0.0 */var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/** * The ApiClient constructor. * @property {module:purecloud-platform-client-v2/ApiClient} diff --git a/build/dist/web-cjs/purecloud-platform-client-v2.min.js b/build/dist/web-cjs/purecloud-platform-client-v2.min.js index 221da90e..da122372 100644 --- a/build/dist/web-cjs/purecloud-platform-client-v2.min.js +++ b/build/dist/web-cjs/purecloud-platform-client-v2.min.js @@ -1 +1 @@ -require=function(){return function e(i,t,n){function a(r,l){if(!t[r]){if(!i[r]){var s="function"==typeof require&&require;if(!l&&s)return s(r,!0);if(o)return o(r,!0);var u=new Error("Cannot find module '"+r+"'");throw u.code="MODULE_NOT_FOUND",u}var p=t[r]={exports:{}};i[r][0].call(p.exports,function(e){return a(i[r][1][e]||e)},p,p.exports,e,i,t,n)}return t[r].exports}for(var o="function"==typeof require&&require,r=0;r0?r-4:r;for(t=0;t>16&255,s[p++]=i>>8&255,s[p++]=255&i;2===l&&(i=a[e.charCodeAt(t)]<<2|a[e.charCodeAt(t+1)]>>4,s[p++]=255&i);1===l&&(i=a[e.charCodeAt(t)]<<10|a[e.charCodeAt(t+1)]<<4|a[e.charCodeAt(t+2)]>>2,s[p++]=i>>8&255,s[p++]=255&i);return s},t.fromByteArray=function(e){for(var i,t=e.length,a=t%3,o=[],r=0,l=t-a;rl?l:r+16383));1===a?(i=e[t-1],o.push(n[i>>2]+n[i<<4&63]+"==")):2===a&&(i=(e[t-2]<<8)+e[t-1],o.push(n[i>>10]+n[i>>4&63]+n[i<<2&63]+"="));return o.join("")};for(var n=[],a=[],o="undefined"!=typeof Uint8Array?Uint8Array:Array,r="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",l=0,s=r.length;l0)throw new Error("Invalid string. Length must be a multiple of 4");var t=e.indexOf("=");return-1===t&&(t=i),[t,t===i?0:4-t%4]}function p(e,i,t){for(var a,o,r=[],l=i;l>18&63]+n[o>>12&63]+n[o>>6&63]+n[63&o]);return r.join("")}a["-".charCodeAt(0)]=62,a["_".charCodeAt(0)]=63},{}],2:[function(e,i,t){},{}],3:[function(e,i,t){(function(i){(function(){"use strict";var i=e("base64-js"),n=e("ieee754");t.Buffer=r,t.SlowBuffer=function(e){+e!=e&&(e=0);return r.alloc(+e)},t.INSPECT_MAX_BYTES=50;var a=2147483647;function o(e){if(e>a)throw new RangeError('The value "'+e+'" is invalid for option "size"');var i=new Uint8Array(e);return i.__proto__=r.prototype,i}function r(e,i,t){if("number"==typeof e){if("string"==typeof i)throw new TypeError('The "string" argument must be of type string. Received type number');return u(e)}return l(e,i,t)}function l(e,i,t){if("string"==typeof e)return function(e,i){"string"==typeof i&&""!==i||(i="utf8");if(!r.isEncoding(i))throw new TypeError("Unknown encoding: "+i);var t=0|d(e,i),n=o(t),a=n.write(e,i);a!==t&&(n=n.slice(0,a));return n}(e,i);if(ArrayBuffer.isView(e))return p(e);if(null==e)throw TypeError("The first argument must be one of type string, Buffer, ArrayBuffer, Array, or Array-like Object. Received type "+typeof e);if(W(e,ArrayBuffer)||e&&W(e.buffer,ArrayBuffer))return function(e,i,t){if(i<0||e.byteLength=a)throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+a.toString(16)+" bytes");return 0|e}function d(e,i){if(r.isBuffer(e))return e.length;if(ArrayBuffer.isView(e)||W(e,ArrayBuffer))return e.byteLength;if("string"!=typeof e)throw new TypeError('The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type '+typeof e);var t=e.length,n=arguments.length>2&&!0===arguments[2];if(!n&&0===t)return 0;for(var a=!1;;)switch(i){case"ascii":case"latin1":case"binary":return t;case"utf8":case"utf-8":return x(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*t;case"hex":return t>>>1;case"base64":return D(e).length;default:if(a)return n?-1:x(e).length;i=(""+i).toLowerCase(),a=!0}}function g(e,i,t){var n=e[i];e[i]=e[t],e[t]=n}function h(e,i,t,n,a){if(0===e.length)return-1;if("string"==typeof t?(n=t,t=0):t>2147483647?t=2147483647:t<-2147483648&&(t=-2147483648),B(t=+t)&&(t=a?0:e.length-1),t<0&&(t=e.length+t),t>=e.length){if(a)return-1;t=e.length-1}else if(t<0){if(!a)return-1;t=0}if("string"==typeof i&&(i=r.from(i,n)),r.isBuffer(i))return 0===i.length?-1:m(e,i,t,n,a);if("number"==typeof i)return i&=255,"function"==typeof Uint8Array.prototype.indexOf?a?Uint8Array.prototype.indexOf.call(e,i,t):Uint8Array.prototype.lastIndexOf.call(e,i,t):m(e,[i],t,n,a);throw new TypeError("val must be string, number or Buffer")}function m(e,i,t,n,a){var o,r=1,l=e.length,s=i.length;if(void 0!==n&&("ucs2"===(n=String(n).toLowerCase())||"ucs-2"===n||"utf16le"===n||"utf-16le"===n)){if(e.length<2||i.length<2)return-1;r=2,l/=2,s/=2,t/=2}function u(e,i){return 1===r?e[i]:e.readUInt16BE(i*r)}if(a){var p=-1;for(o=t;ol&&(t=l-s),o=t;o>=0;o--){for(var c=!0,d=0;da&&(n=a):n=a;var o=i.length;n>o/2&&(n=o/2);for(var r=0;r>8,a=t%256,o.push(a),o.push(n);return o}(i,e.length-t),e,t,n)}function A(e,t,n){return 0===t&&n===e.length?i.fromByteArray(e):i.fromByteArray(e.slice(t,n))}function b(e,i,t){t=Math.min(e.length,t);for(var n=[],a=i;a239?4:u>223?3:u>191?2:1;if(a+c<=t)switch(c){case 1:u<128&&(p=u);break;case 2:128==(192&(o=e[a+1]))&&(s=(31&u)<<6|63&o)>127&&(p=s);break;case 3:o=e[a+1],r=e[a+2],128==(192&o)&&128==(192&r)&&(s=(15&u)<<12|(63&o)<<6|63&r)>2047&&(s<55296||s>57343)&&(p=s);break;case 4:o=e[a+1],r=e[a+2],l=e[a+3],128==(192&o)&&128==(192&r)&&128==(192&l)&&(s=(15&u)<<18|(63&o)<<12|(63&r)<<6|63&l)>65535&&s<1114112&&(p=s)}null===p?(p=65533,c=1):p>65535&&(p-=65536,n.push(p>>>10&1023|55296),p=56320|1023&p),n.push(p),a+=c}return function(e){var i=e.length;if(i<=j)return String.fromCharCode.apply(String,e);var t="",n=0;for(;nthis.length)return"";if((void 0===t||t>this.length)&&(t=this.length),t<=0)return"";if((t>>>=0)<=(i>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return O(this,i,t);case"utf8":case"utf-8":return b(this,i,t);case"ascii":return k(this,i,t);case"latin1":case"binary":return P(this,i,t);case"base64":return A(this,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return M(this,i,t);default:if(n)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),n=!0}}.apply(this,arguments)},r.prototype.toLocaleString=r.prototype.toString,r.prototype.equals=function(e){if(!r.isBuffer(e))throw new TypeError("Argument must be a Buffer");return this===e||0===r.compare(this,e)},r.prototype.inspect=function(){var e="",i=t.INSPECT_MAX_BYTES;return e=this.toString("hex",0,i).replace(/(.{2})/g,"$1 ").trim(),this.length>i&&(e+=" ... "),""},r.prototype.compare=function(e,i,t,n,a){if(W(e,Uint8Array)&&(e=r.from(e,e.offset,e.byteLength)),!r.isBuffer(e))throw new TypeError('The "target" argument must be one of type Buffer or Uint8Array. Received type '+typeof e);if(void 0===i&&(i=0),void 0===t&&(t=e?e.length:0),void 0===n&&(n=0),void 0===a&&(a=this.length),i<0||t>e.length||n<0||a>this.length)throw new RangeError("out of range index");if(n>=a&&i>=t)return 0;if(n>=a)return-1;if(i>=t)return 1;if(i>>>=0,t>>>=0,n>>>=0,a>>>=0,this===e)return 0;for(var o=a-n,l=t-i,s=Math.min(o,l),u=this.slice(n,a),p=e.slice(i,t),c=0;c>>=0,isFinite(t)?(t>>>=0,void 0===n&&(n="utf8")):(n=t,t=void 0)}var a=this.length-i;if((void 0===t||t>a)&&(t=a),e.length>0&&(t<0||i<0)||i>this.length)throw new RangeError("Attempt to write outside buffer bounds");n||(n="utf8");for(var o=!1;;)switch(n){case"hex":return v(this,e,i,t);case"utf8":case"utf-8":return f(this,e,i,t);case"ascii":return w(this,e,i,t);case"latin1":case"binary":return y(this,e,i,t);case"base64":return C(this,e,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return I(this,e,i,t);default:if(o)throw new TypeError("Unknown encoding: "+n);n=(""+n).toLowerCase(),o=!0}},r.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var j=4096;function k(e,i,t){var n="";t=Math.min(e.length,t);for(var a=i;an)&&(t=n);for(var a="",o=i;ot)throw new RangeError("Trying to access beyond buffer length")}function q(e,i,t,n,a,o){if(!r.isBuffer(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(i>a||ie.length)throw new RangeError("Index out of range")}function S(e,i,t,n,a,o){if(t+n>e.length)throw new RangeError("Index out of range");if(t<0)throw new RangeError("Index out of range")}function E(e,i,t,a,o){return i=+i,t>>>=0,o||S(e,0,t,4),n.write(e,i,t,a,23,4),t+4}function G(e,i,t,a,o){return i=+i,t>>>=0,o||S(e,0,t,8),n.write(e,i,t,a,52,8),t+8}r.prototype.slice=function(e,i){var t=this.length;e=~~e,i=void 0===i?t:~~i,e<0?(e+=t)<0&&(e=0):e>t&&(e=t),i<0?(i+=t)<0&&(i=0):i>t&&(i=t),i>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e],a=1,o=0;++o>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e+--i],a=1;i>0&&(a*=256);)n+=this[e+--i]*a;return n},r.prototype.readUInt8=function(e,i){return e>>>=0,i||T(e,1,this.length),this[e]},r.prototype.readUInt16LE=function(e,i){return e>>>=0,i||T(e,2,this.length),this[e]|this[e+1]<<8},r.prototype.readUInt16BE=function(e,i){return e>>>=0,i||T(e,2,this.length),this[e]<<8|this[e+1]},r.prototype.readUInt32LE=function(e,i){return e>>>=0,i||T(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},r.prototype.readUInt32BE=function(e,i){return e>>>=0,i||T(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},r.prototype.readIntLE=function(e,i,t){e>>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e],a=1,o=0;++o=(a*=128)&&(n-=Math.pow(2,8*i)),n},r.prototype.readIntBE=function(e,i,t){e>>>=0,i>>>=0,t||T(e,i,this.length);for(var n=i,a=1,o=this[e+--n];n>0&&(a*=256);)o+=this[e+--n]*a;return o>=(a*=128)&&(o-=Math.pow(2,8*i)),o},r.prototype.readInt8=function(e,i){return e>>>=0,i||T(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},r.prototype.readInt16LE=function(e,i){e>>>=0,i||T(e,2,this.length);var t=this[e]|this[e+1]<<8;return 32768&t?4294901760|t:t},r.prototype.readInt16BE=function(e,i){e>>>=0,i||T(e,2,this.length);var t=this[e+1]|this[e]<<8;return 32768&t?4294901760|t:t},r.prototype.readInt32LE=function(e,i){return e>>>=0,i||T(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},r.prototype.readInt32BE=function(e,i){return e>>>=0,i||T(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},r.prototype.readFloatLE=function(e,i){return e>>>=0,i||T(e,4,this.length),n.read(this,e,!0,23,4)},r.prototype.readFloatBE=function(e,i){return e>>>=0,i||T(e,4,this.length),n.read(this,e,!1,23,4)},r.prototype.readDoubleLE=function(e,i){return e>>>=0,i||T(e,8,this.length),n.read(this,e,!0,52,8)},r.prototype.readDoubleBE=function(e,i){return e>>>=0,i||T(e,8,this.length),n.read(this,e,!1,52,8)},r.prototype.writeUIntLE=function(e,i,t,n){(e=+e,i>>>=0,t>>>=0,n)||q(this,e,i,t,Math.pow(2,8*t)-1,0);var a=1,o=0;for(this[i]=255&e;++o>>=0,t>>>=0,n)||q(this,e,i,t,Math.pow(2,8*t)-1,0);var a=t-1,o=1;for(this[i+a]=255&e;--a>=0&&(o*=256);)this[i+a]=e/o&255;return i+t},r.prototype.writeUInt8=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,1,255,0),this[i]=255&e,i+1},r.prototype.writeUInt16LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,65535,0),this[i]=255&e,this[i+1]=e>>>8,i+2},r.prototype.writeUInt16BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,65535,0),this[i]=e>>>8,this[i+1]=255&e,i+2},r.prototype.writeUInt32LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,4294967295,0),this[i+3]=e>>>24,this[i+2]=e>>>16,this[i+1]=e>>>8,this[i]=255&e,i+4},r.prototype.writeUInt32BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,4294967295,0),this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e,i+4},r.prototype.writeIntLE=function(e,i,t,n){if(e=+e,i>>>=0,!n){var a=Math.pow(2,8*t-1);q(this,e,i,t,a-1,-a)}var o=0,r=1,l=0;for(this[i]=255&e;++o>0)-l&255;return i+t},r.prototype.writeIntBE=function(e,i,t,n){if(e=+e,i>>>=0,!n){var a=Math.pow(2,8*t-1);q(this,e,i,t,a-1,-a)}var o=t-1,r=1,l=0;for(this[i+o]=255&e;--o>=0&&(r*=256);)e<0&&0===l&&0!==this[i+o+1]&&(l=1),this[i+o]=(e/r>>0)-l&255;return i+t},r.prototype.writeInt8=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,1,127,-128),e<0&&(e=255+e+1),this[i]=255&e,i+1},r.prototype.writeInt16LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,32767,-32768),this[i]=255&e,this[i+1]=e>>>8,i+2},r.prototype.writeInt16BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,32767,-32768),this[i]=e>>>8,this[i+1]=255&e,i+2},r.prototype.writeInt32LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,2147483647,-2147483648),this[i]=255&e,this[i+1]=e>>>8,this[i+2]=e>>>16,this[i+3]=e>>>24,i+4},r.prototype.writeInt32BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e,i+4},r.prototype.writeFloatLE=function(e,i,t){return E(this,e,i,!0,t)},r.prototype.writeFloatBE=function(e,i,t){return E(this,e,i,!1,t)},r.prototype.writeDoubleLE=function(e,i,t){return G(this,e,i,!0,t)},r.prototype.writeDoubleBE=function(e,i,t){return G(this,e,i,!1,t)},r.prototype.copy=function(e,i,t,n){if(!r.isBuffer(e))throw new TypeError("argument should be a Buffer");if(t||(t=0),n||0===n||(n=this.length),i>=e.length&&(i=e.length),i||(i=0),n>0&&n=this.length)throw new RangeError("Index out of range");if(n<0)throw new RangeError("sourceEnd out of bounds");n>this.length&&(n=this.length),e.length-i=0;--o)e[o+i]=this[o+t];else Uint8Array.prototype.set.call(e,this.subarray(t,n),i);return a},r.prototype.fill=function(e,i,t,n){if("string"==typeof e){if("string"==typeof i?(n=i,i=0,t=this.length):"string"==typeof t&&(n=t,t=this.length),void 0!==n&&"string"!=typeof n)throw new TypeError("encoding must be a string");if("string"==typeof n&&!r.isEncoding(n))throw new TypeError("Unknown encoding: "+n);if(1===e.length){var a=e.charCodeAt(0);("utf8"===n&&a<128||"latin1"===n)&&(e=a)}}else"number"==typeof e&&(e&=255);if(i<0||this.length>>=0,t=void 0===t?this.length:t>>>0,e||(e=0),"number"==typeof e)for(o=i;o55295&&t<57344){if(!a){if(t>56319){(i-=3)>-1&&o.push(239,191,189);continue}if(r+1===n){(i-=3)>-1&&o.push(239,191,189);continue}a=t;continue}if(t<56320){(i-=3)>-1&&o.push(239,191,189),a=t;continue}t=65536+(a-55296<<10|t-56320)}else a&&(i-=3)>-1&&o.push(239,191,189);if(a=null,t<128){if((i-=1)<0)break;o.push(t)}else if(t<2048){if((i-=2)<0)break;o.push(t>>6|192,63&t|128)}else if(t<65536){if((i-=3)<0)break;o.push(t>>12|224,t>>6&63|128,63&t|128)}else{if(!(t<1114112))throw new Error("Invalid code point");if((i-=4)<0)break;o.push(t>>18|240,t>>12&63|128,t>>6&63|128,63&t|128)}}return o}function D(e){return i.toByteArray(function(e){if((e=(e=e.split("=")[0]).trim().replace(U,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function z(e,i,t,n){for(var a=0;a=i.length||a>=e.length);++a)i[a+t]=e[a];return a}function W(e,i){return e instanceof i||null!=e&&null!=e.constructor&&null!=e.constructor.name&&e.constructor.name===i.name}function B(e){return e!=e}}).call(this)}).call(this,e("buffer").Buffer)},{"base64-js":1,buffer:3,ieee754:4}],4:[function(e,i,t){t.read=function(e,i,t,n,a){var o,r,l=8*a-n-1,s=(1<>1,p=-7,c=t?a-1:0,d=t?-1:1,g=e[i+c];for(c+=d,o=g&(1<<-p)-1,g>>=-p,p+=l;p>0;o=256*o+e[i+c],c+=d,p-=8);for(r=o&(1<<-p)-1,o>>=-p,p+=n;p>0;r=256*r+e[i+c],c+=d,p-=8);if(0===o)o=1-u;else{if(o===s)return r?NaN:1/0*(g?-1:1);r+=Math.pow(2,n),o-=u}return(g?-1:1)*r*Math.pow(2,o-n)},t.write=function(e,i,t,n,a,o){var r,l,s,u=8*o-a-1,p=(1<>1,d=23===a?Math.pow(2,-24)-Math.pow(2,-77):0,g=n?0:o-1,h=n?1:-1,m=i<0||0===i&&1/i<0?1:0;for(i=Math.abs(i),isNaN(i)||i===1/0?(l=isNaN(i)?1:0,r=p):(r=Math.floor(Math.log(i)/Math.LN2),i*(s=Math.pow(2,-r))<1&&(r--,s*=2),(i+=r+c>=1?d/s:d*Math.pow(2,1-c))*s>=2&&(r++,s/=2),r+c>=p?(l=0,r=p):r+c>=1?(l=(i*s-1)*Math.pow(2,a),r+=c):(l=i*Math.pow(2,c-1)*Math.pow(2,a),r=0));a>=8;e[t+g]=255&l,g+=h,l/=256,a-=8);for(r=r<0;e[t+g]=255&r,g+=h,r/=256,u-=8);e[t+g-h]|=128*m}},{}],5:[function(e,i,t){t.endianness=function(){return"LE"},t.hostname=function(){return"undefined"!=typeof location?location.hostname:""},t.loadavg=function(){return[]},t.uptime=function(){return 0},t.freemem=function(){return Number.MAX_VALUE},t.totalmem=function(){return Number.MAX_VALUE},t.cpus=function(){return[]},t.type=function(){return"Browser"},t.release=function(){return"undefined"!=typeof navigator?navigator.appVersion:""},t.networkInterfaces=t.getNetworkInterfaces=function(){return{}},t.arch=function(){return"javascript"},t.platform=function(){return"browser"},t.tmpdir=t.tmpDir=function(){return"/tmp"},t.EOL="\n",t.homedir=function(){return"/"}},{}],6:[function(e,i,t){(function(e){(function(){"use strict";function t(e){if("string"!=typeof e)throw new TypeError("Path must be a string. Received "+JSON.stringify(e))}function n(e,i){for(var t,n="",a=0,o=-1,r=0,l=0;l<=e.length;++l){if(l2){var s=n.lastIndexOf("/");if(s!==n.length-1){-1===s?(n="",a=0):a=(n=n.slice(0,s)).length-1-n.lastIndexOf("/"),o=l,r=0;continue}}else if(2===n.length||1===n.length){n="",a=0,o=l,r=0;continue}i&&(n.length>0?n+="/..":n="..",a=2)}else n.length>0?n+="/"+e.slice(o+1,l):n=e.slice(o+1,l),a=l-o-1;o=l,r=0}else 46===t&&-1!==r?++r:r=-1}return n}var a={resolve:function(){for(var i,a="",o=!1,r=arguments.length-1;r>=-1&&!o;r--){var l;r>=0?l=arguments[r]:(void 0===i&&(i=e.cwd()),l=i),t(l),0!==l.length&&(a=l+"/"+a,o=47===l.charCodeAt(0))}return a=n(a,!o),o?a.length>0?"/"+a:"/":a.length>0?a:"."},normalize:function(e){if(t(e),0===e.length)return".";var i=47===e.charCodeAt(0),a=47===e.charCodeAt(e.length-1);return 0!==(e=n(e,!i)).length||i||(e="."),e.length>0&&a&&(e+="/"),i?"/"+e:e},isAbsolute:function(e){return t(e),e.length>0&&47===e.charCodeAt(0)},join:function(){if(0===arguments.length)return".";for(var e,i=0;i0&&(void 0===e?e=n:e+="/"+n)}return void 0===e?".":a.normalize(e)},relative:function(e,i){if(t(e),t(i),e===i)return"";if((e=a.resolve(e))===(i=a.resolve(i)))return"";for(var n=1;nu){if(47===i.charCodeAt(l+c))return i.slice(l+c+1);if(0===c)return i.slice(l+c)}else r>u&&(47===e.charCodeAt(n+c)?p=c:0===c&&(p=0));break}var d=e.charCodeAt(n+c);if(d!==i.charCodeAt(l+c))break;47===d&&(p=c)}var g="";for(c=n+p+1;c<=o;++c)c!==o&&47!==e.charCodeAt(c)||(0===g.length?g+="..":g+="/..");return g.length>0?g+i.slice(l+p):(l+=p,47===i.charCodeAt(l)&&++l,i.slice(l))},_makeLong:function(e){return e},dirname:function(e){if(t(e),0===e.length)return".";for(var i=e.charCodeAt(0),n=47===i,a=-1,o=!0,r=e.length-1;r>=1;--r)if(47===(i=e.charCodeAt(r))){if(!o){a=r;break}}else o=!1;return-1===a?n?"/":".":n&&1===a?"//":e.slice(0,a)},basename:function(e,i){if(void 0!==i&&"string"!=typeof i)throw new TypeError('"ext" argument must be a string');t(e);var n,a=0,o=-1,r=!0;if(void 0!==i&&i.length>0&&i.length<=e.length){if(i.length===e.length&&i===e)return"";var l=i.length-1,s=-1;for(n=e.length-1;n>=0;--n){var u=e.charCodeAt(n);if(47===u){if(!r){a=n+1;break}}else-1===s&&(r=!1,s=n+1),l>=0&&(u===i.charCodeAt(l)?-1==--l&&(o=n):(l=-1,o=s))}return a===o?o=s:-1===o&&(o=e.length),e.slice(a,o)}for(n=e.length-1;n>=0;--n)if(47===e.charCodeAt(n)){if(!r){a=n+1;break}}else-1===o&&(r=!1,o=n+1);return-1===o?"":e.slice(a,o)},extname:function(e){t(e);for(var i=-1,n=0,a=-1,o=!0,r=0,l=e.length-1;l>=0;--l){var s=e.charCodeAt(l);if(47!==s)-1===a&&(o=!1,a=l+1),46===s?-1===i?i=l:1!==r&&(r=1):-1!==i&&(r=-1);else if(!o){n=l+1;break}}return-1===i||-1===a||0===r||1===r&&i===a-1&&i===n+1?"":e.slice(i,a)},format:function(e){if(null===e||"object"!=typeof e)throw new TypeError('The "pathObject" argument must be of type Object. Received type '+typeof e);return function(e,i){var t=i.dir||i.root,n=i.base||(i.name||"")+(i.ext||"");return t?t===i.root?t+n:t+e+n:n}("/",e)},parse:function(e){t(e);var i={root:"",dir:"",base:"",ext:"",name:""};if(0===e.length)return i;var n,a=e.charCodeAt(0),o=47===a;o?(i.root="/",n=1):n=0;for(var r=-1,l=0,s=-1,u=!0,p=e.length-1,c=0;p>=n;--p)if(47!==(a=e.charCodeAt(p)))-1===s&&(u=!1,s=p+1),46===a?-1===r?r=p:1!==c&&(c=1):-1!==r&&(c=-1);else if(!u){l=p+1;break}return-1===r||-1===s||0===c||1===c&&r===s-1&&r===l+1?-1!==s&&(i.base=i.name=0===l&&o?e.slice(1,s):e.slice(l,s)):(0===l&&o?(i.name=e.slice(1,r),i.base=e.slice(1,s)):(i.name=e.slice(l,r),i.base=e.slice(l,s)),i.ext=e.slice(r,s)),l>0?i.dir=e.slice(0,l-1):o&&(i.dir="/"),i},sep:"/",delimiter:":",win32:null,posix:null};a.posix=a,i.exports=a}).call(this)}).call(this,e("_process"))},{_process:7}],7:[function(e,i,t){var n,a,o=i.exports={};function r(){throw new Error("setTimeout has not been defined")}function l(){throw new Error("clearTimeout has not been defined")}function s(e){if(n===setTimeout)return setTimeout(e,0);if((n===r||!n)&&setTimeout)return n=setTimeout,setTimeout(e,0);try{return n(e,0)}catch(i){try{return n.call(null,e,0)}catch(i){return n.call(this,e,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:r}catch(e){n=r}try{a="function"==typeof clearTimeout?clearTimeout:l}catch(e){a=l}}();var u,p=[],c=!1,d=-1;function g(){c&&u&&(c=!1,u.length?p=u.concat(p):d=-1,p.length&&h())}function h(){if(!c){var e=s(g);c=!0;for(var i=p.length;i;){for(u=p,p=[];++d1)for(var t=1;t-1?a(t):t}},{"./":9,"get-intrinsic":21}],9:[function(e,i,t){"use strict";var n=e("function-bind"),a=e("get-intrinsic"),o=e("set-function-length"),r=e("es-errors/type"),l=a("%Function.prototype.apply%"),s=a("%Function.prototype.call%"),u=a("%Reflect.apply%",!0)||n.call(s,l),p=e("es-define-property"),c=a("%Math.max%");i.exports=function(e){if("function"!=typeof e)throw new r("a function is required");var i=u(n,s,arguments);return o(i,1+c(0,e.length-(arguments.length-1)),!0)};var d=function(){return u(n,l,arguments)};p?p(i.exports,"apply",{value:d}):i.exports.apply=d},{"es-define-property":11,"es-errors/type":17,"function-bind":20,"get-intrinsic":21,"set-function-length":34}],10:[function(e,i,t){"use strict";var n=e("es-define-property"),a=e("es-errors/syntax"),o=e("es-errors/type"),r=e("gopd");i.exports=function(e,i,t){if(!e||"object"!=typeof e&&"function"!=typeof e)throw new o("`obj` must be an object or a function`");if("string"!=typeof i&&"symbol"!=typeof i)throw new o("`property` must be a string or a symbol`");if(arguments.length>3&&"boolean"!=typeof arguments[3]&&null!==arguments[3])throw new o("`nonEnumerable`, if provided, must be a boolean or null");if(arguments.length>4&&"boolean"!=typeof arguments[4]&&null!==arguments[4])throw new o("`nonWritable`, if provided, must be a boolean or null");if(arguments.length>5&&"boolean"!=typeof arguments[5]&&null!==arguments[5])throw new o("`nonConfigurable`, if provided, must be a boolean or null");if(arguments.length>6&&"boolean"!=typeof arguments[6])throw new o("`loose`, if provided, must be a boolean");var l=arguments.length>3?arguments[3]:null,s=arguments.length>4?arguments[4]:null,u=arguments.length>5?arguments[5]:null,p=arguments.length>6&&arguments[6],c=!!r&&r(e,i);if(n)n(e,i,{configurable:null===u&&c?c.configurable:!u,enumerable:null===l&&c?c.enumerable:!l,value:t,writable:null===s&&c?c.writable:!s});else{if(!p&&(l||s||u))throw new a("This environment does not support defining a property as non-configurable, non-writable, or non-enumerable.");e[i]=t}}},{"es-define-property":11,"es-errors/syntax":16,"es-errors/type":17,gopd:22}],11:[function(e,i,t){"use strict";var n=e("get-intrinsic")("%Object.defineProperty%",!0)||!1;if(n)try{n({},"a",{value:1})}catch(e){n=!1}i.exports=n},{"get-intrinsic":21}],12:[function(e,i,t){"use strict";i.exports=EvalError},{}],13:[function(e,i,t){"use strict";i.exports=Error},{}],14:[function(e,i,t){"use strict";i.exports=RangeError},{}],15:[function(e,i,t){"use strict";i.exports=ReferenceError},{}],16:[function(e,i,t){"use strict";i.exports=SyntaxError},{}],17:[function(e,i,t){"use strict";i.exports=TypeError},{}],18:[function(e,i,t){"use strict";i.exports=URIError},{}],19:[function(e,i,t){"use strict";var n=Object.prototype.toString,a=Math.max,o=function(e,i){for(var t=[],n=0;n1&&"boolean"!=typeof i)throw new s('"allowMissing" argument must be a boolean');if(null===T(/^%?[^%]*%?$/,e))throw new l("`%` may not be present anywhere but at the beginning and end of the intrinsic name");var t=function(e){var i=M(e,0,1),t=M(e,-1);if("%"===i&&"%"!==t)throw new l("invalid intrinsic syntax, expected closing `%`");if("%"===t&&"%"!==i)throw new l("invalid intrinsic syntax, expected opening `%`");var n=[];return O(e,q,function(e,i,t,a){n[n.length]=t?O(a,S,"$1"):i||e}),n}(e),n=t.length>0?t[0]:"",a=E("%"+n+"%",i),o=a.name,r=a.value,u=!1,p=a.alias;p&&(n=p[0],P(t,k([0,1],p)));for(var c=1,g=!0;c=t.length){var f=d(r,h);r=(g=!!f)&&"get"in f&&!("originalValue"in f.get)?f.get:r[h]}else g=j(r,h),r=r[h];g&&!u&&(C[o]=r)}}return r}},{"es-errors":13,"es-errors/eval":12,"es-errors/range":14,"es-errors/ref":15,"es-errors/syntax":16,"es-errors/type":17,"es-errors/uri":18,"function-bind":20,"has-proto":24,"has-symbols":25,hasown:27}],22:[function(e,i,t){"use strict";var n=e("get-intrinsic")("%Object.getOwnPropertyDescriptor%",!0);if(n)try{n([],"length")}catch(e){n=null}i.exports=n},{"get-intrinsic":21}],23:[function(e,i,t){"use strict";var n=e("es-define-property"),a=function(){return!!n};a.hasArrayLengthDefineBug=function(){if(!n)return null;try{return 1!==n([],"length",{value:1}).length}catch(e){return!0}},i.exports=a},{"es-define-property":11}],24:[function(e,i,t){"use strict";var n={__proto__:null,foo:{}},a=Object;i.exports=function(){return{__proto__:n}.foo===n.foo&&!(n instanceof a)}},{}],25:[function(e,i,t){"use strict";var n="undefined"!=typeof Symbol&&Symbol,a=e("./shams");i.exports=function(){return"function"==typeof n&&("function"==typeof Symbol&&("symbol"==typeof n("foo")&&("symbol"==typeof Symbol("bar")&&a())))}},{"./shams":26}],26:[function(e,i,t){"use strict";i.exports=function(){if("function"!=typeof Symbol||"function"!=typeof Object.getOwnPropertySymbols)return!1;if("symbol"==typeof Symbol.iterator)return!0;var e={},i=Symbol("test"),t=Object(i);if("string"==typeof i)return!1;if("[object Symbol]"!==Object.prototype.toString.call(i))return!1;if("[object Symbol]"!==Object.prototype.toString.call(t))return!1;for(i in e[i]=42,e)return!1;if("function"==typeof Object.keys&&0!==Object.keys(e).length)return!1;if("function"==typeof Object.getOwnPropertyNames&&0!==Object.getOwnPropertyNames(e).length)return!1;var n=Object.getOwnPropertySymbols(e);if(1!==n.length||n[0]!==i)return!1;if(!Object.prototype.propertyIsEnumerable.call(e,i))return!1;if("function"==typeof Object.getOwnPropertyDescriptor){var a=Object.getOwnPropertyDescriptor(e,i);if(42!==a.value||!0!==a.enumerable)return!1}return!0}},{}],27:[function(e,i,t){"use strict";var n=Function.prototype.call,a=Object.prototype.hasOwnProperty,o=e("function-bind");i.exports=o.call(n,a)},{"function-bind":20}],28:[function(e,i,t){(function(t){(function(){var n="function"==typeof Map&&Map.prototype,a=Object.getOwnPropertyDescriptor&&n?Object.getOwnPropertyDescriptor(Map.prototype,"size"):null,o=n&&a&&"function"==typeof a.get?a.get:null,r=n&&Map.prototype.forEach,l="function"==typeof Set&&Set.prototype,s=Object.getOwnPropertyDescriptor&&l?Object.getOwnPropertyDescriptor(Set.prototype,"size"):null,u=l&&s&&"function"==typeof s.get?s.get:null,p=l&&Set.prototype.forEach,c="function"==typeof WeakMap&&WeakMap.prototype?WeakMap.prototype.has:null,d="function"==typeof WeakSet&&WeakSet.prototype?WeakSet.prototype.has:null,g="function"==typeof WeakRef&&WeakRef.prototype?WeakRef.prototype.deref:null,h=Boolean.prototype.valueOf,m=Object.prototype.toString,v=Function.prototype.toString,f=String.prototype.match,w=String.prototype.slice,y=String.prototype.replace,C=String.prototype.toUpperCase,I=String.prototype.toLowerCase,A=RegExp.prototype.test,b=Array.prototype.concat,j=Array.prototype.join,k=Array.prototype.slice,P=Math.floor,O="function"==typeof BigInt?BigInt.prototype.valueOf:null,M=Object.getOwnPropertySymbols,T="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?Symbol.prototype.toString:null,q="function"==typeof Symbol&&"object"==typeof Symbol.iterator,S="function"==typeof Symbol&&Symbol.toStringTag&&(typeof Symbol.toStringTag===q||"symbol")?Symbol.toStringTag:null,E=Object.prototype.propertyIsEnumerable,G=("function"==typeof Reflect?Reflect.getPrototypeOf:Object.getPrototypeOf)||([].__proto__===Array.prototype?function(e){return e.__proto__}:null);function U(e,i){if(e===1/0||e===-1/0||e!=e||e&&e>-1e3&&e<1e3||A.call(/e/,i))return i;var t=/[0-9](?=(?:[0-9]{3})+(?![0-9]))/g;if("number"==typeof e){var n=e<0?-P(-e):P(e);if(n!==e){var a=String(n),o=w.call(i,a.length+1);return y.call(a,t,"$&_")+"."+y.call(y.call(o,/([0-9]{3})/g,"$&_"),/_$/,"")}}return y.call(i,t,"$&_")}var R=e("./util.inspect"),x=R.custom,D=N(x)?x:null;function z(e,i,t){var n="double"===(t.quoteStyle||i)?'"':"'";return n+e+n}function W(e){return y.call(String(e),/"/g,""")}function B(e){return!("[object Array]"!==J(e)||S&&"object"==typeof e&&S in e)}function L(e){return!("[object RegExp]"!==J(e)||S&&"object"==typeof e&&S in e)}function N(e){if(q)return e&&"object"==typeof e&&e instanceof Symbol;if("symbol"==typeof e)return!0;if(!e||"object"!=typeof e||!T)return!1;try{return T.call(e),!0}catch(e){}return!1}i.exports=function e(i,n,a,l){var s=n||{};if(F(s,"quoteStyle")&&"single"!==s.quoteStyle&&"double"!==s.quoteStyle)throw new TypeError('option "quoteStyle" must be "single" or "double"');if(F(s,"maxStringLength")&&("number"==typeof s.maxStringLength?s.maxStringLength<0&&s.maxStringLength!==1/0:null!==s.maxStringLength))throw new TypeError('option "maxStringLength", if provided, must be a positive integer, Infinity, or `null`');var m=!F(s,"customInspect")||s.customInspect;if("boolean"!=typeof m&&"symbol"!==m)throw new TypeError("option \"customInspect\", if provided, must be `true`, `false`, or `'symbol'`");if(F(s,"indent")&&null!==s.indent&&"\t"!==s.indent&&!(parseInt(s.indent,10)===s.indent&&s.indent>0))throw new TypeError('option "indent" must be "\\t", an integer > 0, or `null`');if(F(s,"numericSeparator")&&"boolean"!=typeof s.numericSeparator)throw new TypeError('option "numericSeparator", if provided, must be `true` or `false`');var C=s.numericSeparator;if(void 0===i)return"undefined";if(null===i)return"null";if("boolean"==typeof i)return i?"true":"false";if("string"==typeof i)return function e(i,t){if(i.length>t.maxStringLength){var n=i.length-t.maxStringLength,a="... "+n+" more character"+(n>1?"s":"");return e(w.call(i,0,t.maxStringLength),t)+a}var o=y.call(y.call(i,/(['\\])/g,"\\$1"),/[\x00-\x1f]/g,_);return z(o,"single",t)}(i,s);if("number"==typeof i){if(0===i)return 1/0/i>0?"0":"-0";var A=String(i);return C?U(i,A):A}if("bigint"==typeof i){var P=String(i)+"n";return C?U(i,P):P}var M=void 0===s.depth?5:s.depth;if(void 0===a&&(a=0),a>=M&&M>0&&"object"==typeof i)return B(i)?"[Array]":"[Object]";var x=function(e,i){var t;if("\t"===e.indent)t="\t";else{if(!("number"==typeof e.indent&&e.indent>0))return null;t=j.call(Array(e.indent+1)," ")}return{base:t,prev:j.call(Array(i+1),t)}}(s,a);if(void 0===l)l=[];else if(V(l,i)>=0)return"[Circular]";function K(i,t,n){if(t&&(l=k.call(l)).push(t),n){var o={depth:s.depth};return F(s,"quoteStyle")&&(o.quoteStyle=s.quoteStyle),e(i,o,a+1,l)}return e(i,s,a+1,l)}if("function"==typeof i&&!L(i)){var X=function(e){if(e.name)return e.name;var i=f.call(v.call(e),/^function\s*([\w$]+)/);if(i)return i[1];return null}(i),ee=Z(i,K);return"[Function"+(X?": "+X:" (anonymous)")+"]"+(ee.length>0?" { "+j.call(ee,", ")+" }":"")}if(N(i)){var ie=q?y.call(String(i),/^(Symbol\(.*\))_[^)]*$/,"$1"):T.call(i);return"object"!=typeof i||q?ie:Q(ie)}if(function(e){if(!e||"object"!=typeof e)return!1;if("undefined"!=typeof HTMLElement&&e instanceof HTMLElement)return!0;return"string"==typeof e.nodeName&&"function"==typeof e.getAttribute}(i)){for(var te="<"+I.call(String(i.nodeName)),ne=i.attributes||[],ae=0;ae"}if(B(i)){if(0===i.length)return"[]";var oe=Z(i,K);return x&&!function(e){for(var i=0;i=0)return!1;return!0}(oe)?"["+$(oe,x)+"]":"[ "+j.call(oe,", ")+" ]"}if(function(e){return!("[object Error]"!==J(e)||S&&"object"==typeof e&&S in e)}(i)){var re=Z(i,K);return"cause"in Error.prototype||!("cause"in i)||E.call(i,"cause")?0===re.length?"["+String(i)+"]":"{ ["+String(i)+"] "+j.call(re,", ")+" }":"{ ["+String(i)+"] "+j.call(b.call("[cause]: "+K(i.cause),re),", ")+" }"}if("object"==typeof i&&m){if(D&&"function"==typeof i[D]&&R)return R(i,{depth:M-a});if("symbol"!==m&&"function"==typeof i.inspect)return i.inspect()}if(function(e){if(!o||!e||"object"!=typeof e)return!1;try{o.call(e);try{u.call(e)}catch(e){return!0}return e instanceof Map}catch(e){}return!1}(i)){var le=[];return r&&r.call(i,function(e,t){le.push(K(t,i,!0)+" => "+K(e,i))}),Y("Map",o.call(i),le,x)}if(function(e){if(!u||!e||"object"!=typeof e)return!1;try{u.call(e);try{o.call(e)}catch(e){return!0}return e instanceof Set}catch(e){}return!1}(i)){var se=[];return p&&p.call(i,function(e){se.push(K(e,i))}),Y("Set",u.call(i),se,x)}if(function(e){if(!c||!e||"object"!=typeof e)return!1;try{c.call(e,c);try{d.call(e,d)}catch(e){return!0}return e instanceof WeakMap}catch(e){}return!1}(i))return H("WeakMap");if(function(e){if(!d||!e||"object"!=typeof e)return!1;try{d.call(e,d);try{c.call(e,c)}catch(e){return!0}return e instanceof WeakSet}catch(e){}return!1}(i))return H("WeakSet");if(function(e){if(!g||!e||"object"!=typeof e)return!1;try{return g.call(e),!0}catch(e){}return!1}(i))return H("WeakRef");if(function(e){return!("[object Number]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(K(Number(i)));if(function(e){if(!e||"object"!=typeof e||!O)return!1;try{return O.call(e),!0}catch(e){}return!1}(i))return Q(K(O.call(i)));if(function(e){return!("[object Boolean]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(h.call(i));if(function(e){return!("[object String]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(K(String(i)));if("undefined"!=typeof window&&i===window)return"{ [object Window] }";if(i===t)return"{ [object globalThis] }";if(!function(e){return!("[object Date]"!==J(e)||S&&"object"==typeof e&&S in e)}(i)&&!L(i)){var ue=Z(i,K),pe=G?G(i)===Object.prototype:i instanceof Object||i.constructor===Object,ce=i instanceof Object?"":"null prototype",de=!pe&&S&&Object(i)===i&&S in i?w.call(J(i),8,-1):ce?"Object":"",ge=(pe||"function"!=typeof i.constructor?"":i.constructor.name?i.constructor.name+" ":"")+(de||ce?"["+j.call(b.call([],de||[],ce||[]),": ")+"] ":"");return 0===ue.length?ge+"{}":x?ge+"{"+$(ue,x)+"}":ge+"{ "+j.call(ue,", ")+" }"}return String(i)};var K=Object.prototype.hasOwnProperty||function(e){return e in this};function F(e,i){return K.call(e,i)}function J(e){return m.call(e)}function V(e,i){if(e.indexOf)return e.indexOf(i);for(var t=0,n=e.length;t-1?e.split(","):e},u=function(e,i,t,n){if(e){var o=t.allowDots?e.replace(/\.([^.[]+)/g,"[$1]"):e,r=/(\[[^[\]]*])/g,l=t.depth>0&&/(\[[^[\]]*])/.exec(o),u=l?o.slice(0,l.index):o,p=[];if(u){if(!t.plainObjects&&a.call(Object.prototype,u)&&!t.allowPrototypes)return;p.push(u)}for(var c=0;t.depth>0&&null!==(l=r.exec(o))&&c=0;--o){var r,l=e[o];if("[]"===l&&t.parseArrays)r=t.allowEmptyArrays&&""===a?[]:[].concat(a);else{r=t.plainObjects?Object.create(null):{};var u="["===l.charAt(0)&&"]"===l.charAt(l.length-1)?l.slice(1,-1):l,p=t.decodeDotInKeys?u.replace(/%2E/g,"."):u,c=parseInt(p,10);t.parseArrays||""!==p?!isNaN(c)&&l!==p&&String(c)===p&&c>=0&&t.parseArrays&&c<=t.arrayLimit?(r=[])[c]=a:"__proto__"!==p&&(r[p]=a):r={0:a}}a=r}return a}(p,i,t,n)}};i.exports=function(e,i){var t=function(e){if(!e)return r;if(void 0!==e.allowEmptyArrays&&"boolean"!=typeof e.allowEmptyArrays)throw new TypeError("`allowEmptyArrays` option can only be `true` or `false`, when provided");if(void 0!==e.decodeDotInKeys&&"boolean"!=typeof e.decodeDotInKeys)throw new TypeError("`decodeDotInKeys` option can only be `true` or `false`, when provided");if(null!==e.decoder&&void 0!==e.decoder&&"function"!=typeof e.decoder)throw new TypeError("Decoder has to be a function.");if(void 0!==e.charset&&"utf-8"!==e.charset&&"iso-8859-1"!==e.charset)throw new TypeError("The charset option must be either utf-8, iso-8859-1, or undefined");var i=void 0===e.charset?r.charset:e.charset,t=void 0===e.duplicates?r.duplicates:e.duplicates;if("combine"!==t&&"first"!==t&&"last"!==t)throw new TypeError("The duplicates option must be either combine, first, or last");return{allowDots:void 0===e.allowDots?!0===e.decodeDotInKeys||r.allowDots:!!e.allowDots,allowEmptyArrays:"boolean"==typeof e.allowEmptyArrays?!!e.allowEmptyArrays:r.allowEmptyArrays,allowPrototypes:"boolean"==typeof e.allowPrototypes?e.allowPrototypes:r.allowPrototypes,allowSparse:"boolean"==typeof e.allowSparse?e.allowSparse:r.allowSparse,arrayLimit:"number"==typeof e.arrayLimit?e.arrayLimit:r.arrayLimit,charset:i,charsetSentinel:"boolean"==typeof e.charsetSentinel?e.charsetSentinel:r.charsetSentinel,comma:"boolean"==typeof e.comma?e.comma:r.comma,decodeDotInKeys:"boolean"==typeof e.decodeDotInKeys?e.decodeDotInKeys:r.decodeDotInKeys,decoder:"function"==typeof e.decoder?e.decoder:r.decoder,delimiter:"string"==typeof e.delimiter||n.isRegExp(e.delimiter)?e.delimiter:r.delimiter,depth:"number"==typeof e.depth||!1===e.depth?+e.depth:r.depth,duplicates:t,ignoreQueryPrefix:!0===e.ignoreQueryPrefix,interpretNumericEntities:"boolean"==typeof e.interpretNumericEntities?e.interpretNumericEntities:r.interpretNumericEntities,parameterLimit:"number"==typeof e.parameterLimit?e.parameterLimit:r.parameterLimit,parseArrays:!1!==e.parseArrays,plainObjects:"boolean"==typeof e.plainObjects?e.plainObjects:r.plainObjects,strictNullHandling:"boolean"==typeof e.strictNullHandling?e.strictNullHandling:r.strictNullHandling}}(i);if(""===e||null===e||void 0===e)return t.plainObjects?Object.create(null):{};for(var p="string"==typeof e?function(e,i){var t,u={__proto__:null},p=i.ignoreQueryPrefix?e.replace(/^\?/,""):e,c=i.parameterLimit===1/0?void 0:i.parameterLimit,d=p.split(i.delimiter,c),g=-1,h=i.charset;if(i.charsetSentinel)for(t=0;t-1&&(v=o(v)?[v]:v);var C=a.call(u,m);C&&"combine"===i.duplicates?u[m]=n.combine(u[m],v):C&&"last"!==i.duplicates||(u[m]=v)}return u}(e,t):e,c=t.plainObjects?Object.create(null):{},d=Object.keys(p),g=0;g0?P.join(",")||null:void 0}];else if(s(v))S=v;else{var G=Object.keys(P);S=f?G.sort(f):G}var U=d?t.replace(/\./g,"%2E"):t,R=r&&s(P)&&1===P.length?U+"[]":U;if(l&&s(P)&&0===P.length)return R+"[]";for(var x=0;x0?C+y:""}},{"./formats":29,"./utils":33,"side-channel":35}],33:[function(e,i,t){"use strict";var n=e("./formats"),a=Object.prototype.hasOwnProperty,o=Array.isArray,r=function(){for(var e=[],i=0;i<256;++i)e.push("%"+((i<16?"0":"")+i.toString(16)).toUpperCase());return e}(),l=function(e,i){for(var t=i&&i.plainObjects?Object.create(null):{},n=0;n1;){var i=e.pop(),t=i.obj[i.prop];if(o(t)){for(var n=[],a=0;a=1024?l.slice(u,u+1024):l,c=[],d=0;d=48&&g<=57||g>=65&&g<=90||g>=97&&g<=122||o===n.RFC1738&&(40===g||41===g)?c[c.length]=p.charAt(d):g<128?c[c.length]=r[g]:g<2048?c[c.length]=r[192|g>>6]+r[128|63&g]:g<55296||g>=57344?c[c.length]=r[224|g>>12]+r[128|g>>6&63]+r[128|63&g]:(d+=1,g=65536+((1023&g)<<10|1023&p.charCodeAt(d)),c[c.length]=r[240|g>>18]+r[128|g>>12&63]+r[128|g>>6&63]+r[128|63&g])}s+=c.join("")}return s},isBuffer:function(e){return!(!e||"object"!=typeof e||!(e.constructor&&e.constructor.isBuffer&&e.constructor.isBuffer(e)))},isRegExp:function(e){return"[object RegExp]"===Object.prototype.toString.call(e)},maybeMap:function(e,i){if(o(e)){for(var t=[],n=0;n4294967295||s(i)!==i)throw new l("`length` must be a positive 32-bit integer");var t=arguments.length>2&&!!arguments[2],n=!0,u=!0;if("length"in e&&r){var p=r(e,"length");p&&!p.configurable&&(n=!1),p&&!p.writable&&(u=!1)}return(n||u||!t)&&(o?a(e,"length",i,!0,!0):a(e,"length",i)),e}},{"define-data-property":10,"es-errors/type":17,"get-intrinsic":21,gopd:22,"has-property-descriptors":23}],35:[function(e,i,t){"use strict";var n=e("get-intrinsic"),a=e("call-bind/callBound"),o=e("object-inspect"),r=e("es-errors/type"),l=n("%WeakMap%",!0),s=n("%Map%",!0),u=a("WeakMap.prototype.get",!0),p=a("WeakMap.prototype.set",!0),c=a("WeakMap.prototype.has",!0),d=a("Map.prototype.get",!0),g=a("Map.prototype.set",!0),h=a("Map.prototype.has",!0),m=function(e,i){for(var t,n=e;null!==(t=n.next);n=t)if(t.key===i)return n.next=t.next,t.next=e.next,e.next=t,t};i.exports=function(){var e,i,t,n={assert:function(e){if(!n.has(e))throw new r("Side channel does not contain "+o(e))},get:function(n){if(l&&n&&("object"==typeof n||"function"==typeof n)){if(e)return u(e,n)}else if(s){if(i)return d(i,n)}else if(t)return function(e,i){var t=m(e,i);return t&&t.value}(t,n)},has:function(n){if(l&&n&&("object"==typeof n||"function"==typeof n)){if(e)return c(e,n)}else if(s){if(i)return h(i,n)}else if(t)return function(e,i){return!!m(e,i)}(t,n);return!1},set:function(n,a){l&&n&&("object"==typeof n||"function"==typeof n)?(e||(e=new l),p(e,n,a)):s?(i||(i=new s),g(i,n,a)):(t||(t={key:{},next:null}),function(e,i,t){var n=m(e,i);n?n.value=t:e.next={key:i,next:e.next,value:t}}(t,n,a))}};return n}},{"call-bind/callBound":8,"es-errors/type":17,"get-intrinsic":21,"object-inspect":28}],platformClient:[function(e,i,t){(function(t,n){(function(){"use strict";function n(e,i,t,n,a,o,r){try{var l=e[o](r),s=l.value}catch(e){return void t(e)}l.done?i(s):Promise.resolve(s).then(n,a)}function a(e){return function(){var i=this,t=arguments;return new Promise(function(a,o){var r=e.apply(i,t);function l(e){n(r,a,o,l,s,"next",e)}function s(e){n(r,a,o,l,s,"throw",e)}l(void 0)})}}function o(){o=function(){return i};var e,i={},t=Object.prototype,n=t.hasOwnProperty,a=Object.defineProperty||function(e,i,t){e[i]=t.value},r="function"==typeof Symbol?Symbol:{},l=r.iterator||"@@iterator",s=r.asyncIterator||"@@asyncIterator",u=r.toStringTag||"@@toStringTag";function p(e,i,t){return Object.defineProperty(e,i,{value:t,enumerable:!0,configurable:!0,writable:!0}),e[i]}try{p({},"")}catch(e){p=function(e,i,t){return e[i]=t}}function c(e,i,t,n){var o=i&&i.prototype instanceof w?i:w,r=Object.create(o.prototype),l=new E(n||[]);return a(r,"_invoke",{value:M(e,t,l)}),r}function d(e,i,t){try{return{type:"normal",arg:e.call(i,t)}}catch(e){return{type:"throw",arg:e}}}i.wrap=c;var g="suspendedStart",h="suspendedYield",m="executing",v="completed",f={};function w(){}function y(){}function I(){}var A={};p(A,l,function(){return this});var b=Object.getPrototypeOf,j=b&&b(b(G([])));j&&j!==t&&n.call(j,l)&&(A=j);var k=I.prototype=w.prototype=Object.create(A);function P(e){["next","throw","return"].forEach(function(i){p(e,i,function(e){return this._invoke(i,e)})})}function O(e,i){function t(a,o,r,l){var s=d(e[a],e,o);if("throw"!==s.type){var u=s.arg,p=u.value;return p&&"object"==C(p)&&n.call(p,"__await")?i.resolve(p.__await).then(function(e){t("next",e,r,l)},function(e){t("throw",e,r,l)}):i.resolve(p).then(function(e){u.value=e,r(u)},function(e){return t("throw",e,r,l)})}l(s.arg)}var o;a(this,"_invoke",{value:function(e,n){function a(){return new i(function(i,a){t(e,n,i,a)})}return o=o?o.then(a,a):a()}})}function M(i,t,n){var a=g;return function(o,r){if(a===m)throw Error("Generator is already running");if(a===v){if("throw"===o)throw r;return{value:e,done:!0}}for(n.method=o,n.arg=r;;){var l=n.delegate;if(l){var s=T(l,n);if(s){if(s===f)continue;return s}}if("next"===n.method)n.sent=n._sent=n.arg;else if("throw"===n.method){if(a===g)throw a=v,n.arg;n.dispatchException(n.arg)}else"return"===n.method&&n.abrupt("return",n.arg);a=m;var u=d(i,t,n);if("normal"===u.type){if(a=n.done?v:h,u.arg===f)continue;return{value:u.arg,done:n.done}}"throw"===u.type&&(a=v,n.method="throw",n.arg=u.arg)}}}function T(i,t){var n=t.method,a=i.iterator[n];if(a===e)return t.delegate=null,"throw"===n&&i.iterator.return&&(t.method="return",t.arg=e,T(i,t),"throw"===t.method)||"return"!==n&&(t.method="throw",t.arg=new TypeError("The iterator does not provide a '"+n+"' method")),f;var o=d(a,i.iterator,t.arg);if("throw"===o.type)return t.method="throw",t.arg=o.arg,t.delegate=null,f;var r=o.arg;return r?r.done?(t[i.resultName]=r.value,t.next=i.nextLoc,"return"!==t.method&&(t.method="next",t.arg=e),t.delegate=null,f):r:(t.method="throw",t.arg=new TypeError("iterator result is not an object"),t.delegate=null,f)}function q(e){var i={tryLoc:e[0]};1 in e&&(i.catchLoc=e[1]),2 in e&&(i.finallyLoc=e[2],i.afterLoc=e[3]),this.tryEntries.push(i)}function S(e){var i=e.completion||{};i.type="normal",delete i.arg,e.completion=i}function E(e){this.tryEntries=[{tryLoc:"root"}],e.forEach(q,this),this.reset(!0)}function G(i){if(i||""===i){var t=i[l];if(t)return t.call(i);if("function"==typeof i.next)return i;if(!isNaN(i.length)){var a=-1,o=function t(){for(;++a=0;--o){var r=this.tryEntries[o],l=r.completion;if("root"===r.tryLoc)return a("end");if(r.tryLoc<=this.prev){var s=n.call(r,"catchLoc"),u=n.call(r,"finallyLoc");if(s&&u){if(this.prev=0;--t){var a=this.tryEntries[t];if(a.tryLoc<=this.prev&&n.call(a,"finallyLoc")&&this.prev=0;--i){var t=this.tryEntries[i];if(t.finallyLoc===e)return this.complete(t.completion,t.afterLoc),S(t),f}},catch:function(e){for(var i=this.tryEntries.length-1;i>=0;--i){var t=this.tryEntries[i];if(t.tryLoc===e){var n=t.completion;if("throw"===n.type){var a=n.arg;S(t)}return a}}throw Error("illegal catch attempt")},delegateYield:function(i,t,n){return this.delegate={iterator:G(i),resultName:t,nextLoc:n},"next"===this.method&&(this.arg=e),f}},i}function r(e){return function(e){if(Array.isArray(e))return w(e)}(e)||l(e)||f(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function l(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}function s(e,i){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);i&&(n=n.filter(function(i){return Object.getOwnPropertyDescriptor(e,i).enumerable})),t.push.apply(t,n)}return t}function u(e){for(var i=1;ie.length)&&(i=e.length);for(var t=0,n=Array(i);t>18&63]+q[a>>12&63]+q[a>>6&63]+q[63&a]);return o.join("")}function x(e){var i;G||U();for(var t=e.length,n=t%3,a="",o=[],r=0,l=t-n;rl?l:r+16383));return 1===n?(i=e[t-1],a+=q[i>>2],a+=q[i<<4&63],a+="=="):2===n&&(i=(e[t-2]<<8)+e[t-1],a+=q[i>>10],a+=q[i>>4&63],a+=q[i<<2&63],a+="="),o.push(a),o.join("")}function D(e,i,t,n,a){var o,r,l=8*a-n-1,s=(1<>1,p=-7,c=t?a-1:0,d=t?-1:1,g=e[i+c];for(c+=d,o=g&(1<<-p)-1,g>>=-p,p+=l;p>0;o=256*o+e[i+c],c+=d,p-=8);for(r=o&(1<<-p)-1,o>>=-p,p+=n;p>0;r=256*r+e[i+c],c+=d,p-=8);if(0===o)o=1-u;else{if(o===s)return r?NaN:1/0*(g?-1:1);r+=Math.pow(2,n),o-=u}return(g?-1:1)*r*Math.pow(2,o-n)}function z(e,i,t,n,a,o){var r,l,s,u=8*o-a-1,p=(1<>1,d=23===a?Math.pow(2,-24)-Math.pow(2,-77):0,g=n?0:o-1,h=n?1:-1,m=i<0||0===i&&1/i<0?1:0;for(i=Math.abs(i),isNaN(i)||i===1/0?(l=isNaN(i)?1:0,r=p):(r=Math.floor(Math.log(i)/Math.LN2),i*(s=Math.pow(2,-r))<1&&(r--,s*=2),(i+=r+c>=1?d/s:d*Math.pow(2,1-c))*s>=2&&(r++,s/=2),r+c>=p?(l=0,r=p):r+c>=1?(l=(i*s-1)*Math.pow(2,a),r+=c):(l=i*Math.pow(2,c-1)*Math.pow(2,a),r=0));a>=8;e[t+g]=255&l,g+=h,l/=256,a-=8);for(r=r<0;e[t+g]=255&r,g+=h,r/=256,u-=8);e[t+g-h]|=128*m}var W={}.toString,B=Array.isArray||function(e){return"[object Array]"==W.call(e)};function L(){return K.TYPED_ARRAY_SUPPORT?2147483647:1073741823}function N(e,i){if(L()=L())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+L().toString(16)+" bytes");return 0|e}function H(e){return!(null==e||!e._isBuffer)}function Y(e,i){if(H(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var t=e.length;if(0===t)return 0;for(var n=!1;;)switch(i){case"ascii":case"latin1":case"binary":return t;case"utf8":case"utf-8":case void 0:return Ae(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*t;case"hex":return t>>>1;case"base64":return be(e).length;default:if(n)return Ae(e).length;i=(""+i).toLowerCase(),n=!0}}function $(e,i,t){var n=e[i];e[i]=e[t],e[t]=n}function Z(e,i,t,n,a){if(0===e.length)return-1;if("string"==typeof t?(n=t,t=0):t>2147483647?t=2147483647:t<-2147483648&&(t=-2147483648),t=+t,isNaN(t)&&(t=a?0:e.length-1),t<0&&(t=e.length+t),t>=e.length){if(a)return-1;t=e.length-1}else if(t<0){if(!a)return-1;t=0}if("string"==typeof i&&(i=K.from(i,n)),H(i))return 0===i.length?-1:X(e,i,t,n,a);if("number"==typeof i)return i&=255,K.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?a?Uint8Array.prototype.indexOf.call(e,i,t):Uint8Array.prototype.lastIndexOf.call(e,i,t):X(e,[i],t,n,a);throw new TypeError("val must be string, number or Buffer")}function X(e,i,t,n,a){var o,r=1,l=e.length,s=i.length;if(void 0!==n&&("ucs2"===(n=String(n).toLowerCase())||"ucs-2"===n||"utf16le"===n||"utf-16le"===n)){if(e.length<2||i.length<2)return-1;r=2,l/=2,s/=2,t/=2}function u(e,i){return 1===r?e[i]:e.readUInt16BE(i*r)}if(a){var p=-1;for(o=t;ol&&(t=l-s),o=t;o>=0;o--){for(var c=!0,d=0;da&&(n=a):n=a;var o=i.length;if(o%2!=0)throw new TypeError("Invalid hex string");n>o/2&&(n=o/2);for(var r=0;r>8,a=t%256,o.push(a),o.push(n);return o}(i,e.length-t),e,t,n)}function re(e,i,t){return 0===i&&t===e.length?x(e):x(e.slice(i,t))}function le(e,i,t){t=Math.min(e.length,t);for(var n=[],a=i;a239?4:u>223?3:u>191?2:1;if(a+c<=t)switch(c){case 1:u<128&&(p=u);break;case 2:128==(192&(o=e[a+1]))&&(s=(31&u)<<6|63&o)>127&&(p=s);break;case 3:o=e[a+1],r=e[a+2],128==(192&o)&&128==(192&r)&&(s=(15&u)<<12|(63&o)<<6|63&r)>2047&&(s<55296||s>57343)&&(p=s);break;case 4:o=e[a+1],r=e[a+2],l=e[a+3],128==(192&o)&&128==(192&r)&&128==(192&l)&&(s=(15&u)<<18|(63&o)<<12|(63&r)<<6|63&l)>65535&&s<1114112&&(p=s)}null===p?(p=65533,c=1):p>65535&&(p-=65536,n.push(p>>>10&1023|55296),p=56320|1023&p),n.push(p),a+=c}return function(e){var i=e.length;if(i<=se)return String.fromCharCode.apply(String,e);var t="",n=0;for(;nthis.length)return"";if((void 0===t||t>this.length)&&(t=this.length),t<=0)return"";if((t>>>=0)<=(i>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return ce(this,i,t);case"utf8":case"utf-8":return le(this,i,t);case"ascii":return ue(this,i,t);case"latin1":case"binary":return pe(this,i,t);case"base64":return re(this,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return de(this,i,t);default:if(n)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),n=!0}}.apply(this,arguments)},K.prototype.equals=function(e){if(!H(e))throw new TypeError("Argument must be a Buffer");return this===e||0===K.compare(this,e)},K.prototype.inspect=function(){var e="";return this.length>0&&(e=this.toString("hex",0,50).match(/.{2}/g).join(" "),this.length>50&&(e+=" ... ")),""},K.prototype.compare=function(e,i,t,n,a){if(!H(e))throw new TypeError("Argument must be a Buffer");if(void 0===i&&(i=0),void 0===t&&(t=e?e.length:0),void 0===n&&(n=0),void 0===a&&(a=this.length),i<0||t>e.length||n<0||a>this.length)throw new RangeError("out of range index");if(n>=a&&i>=t)return 0;if(n>=a)return-1;if(i>=t)return 1;if(i>>>=0,t>>>=0,n>>>=0,a>>>=0,this===e)return 0;for(var o=a-n,r=t-i,l=Math.min(o,r),s=this.slice(n,a),u=e.slice(i,t),p=0;pa)&&(t=a),e.length>0&&(t<0||i<0)||i>this.length)throw new RangeError("Attempt to write outside buffer bounds");n||(n="utf8");for(var o=!1;;)switch(n){case"hex":return ee(this,e,i,t);case"utf8":case"utf-8":return ie(this,e,i,t);case"ascii":return te(this,e,i,t);case"latin1":case"binary":return ne(this,e,i,t);case"base64":return ae(this,e,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return oe(this,e,i,t);default:if(o)throw new TypeError("Unknown encoding: "+n);n=(""+n).toLowerCase(),o=!0}},K.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var se=4096;function ue(e,i,t){var n="";t=Math.min(e.length,t);for(var a=i;an)&&(t=n);for(var a="",o=i;ot)throw new RangeError("Trying to access beyond buffer length")}function he(e,i,t,n,a,o){if(!H(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(i>a||ie.length)throw new RangeError("Index out of range")}function me(e,i,t,n){i<0&&(i=65535+i+1);for(var a=0,o=Math.min(e.length-t,2);a>>8*(n?a:1-a)}function ve(e,i,t,n){i<0&&(i=4294967295+i+1);for(var a=0,o=Math.min(e.length-t,4);a>>8*(n?a:3-a)&255}function fe(e,i,t,n,a,o){if(t+n>e.length)throw new RangeError("Index out of range");if(t<0)throw new RangeError("Index out of range")}function we(e,i,t,n,a){return a||fe(e,0,t,4),z(e,i,t,n,23,4),t+4}function ye(e,i,t,n,a){return a||fe(e,0,t,8),z(e,i,t,n,52,8),t+8}K.prototype.slice=function(e,i){var t,n=this.length;if(e=~~e,i=void 0===i?n:~~i,e<0?(e+=n)<0&&(e=0):e>n&&(e=n),i<0?(i+=n)<0&&(i=0):i>n&&(i=n),i0&&(a*=256);)n+=this[e+--i]*a;return n},K.prototype.readUInt8=function(e,i){return i||ge(e,1,this.length),this[e]},K.prototype.readUInt16LE=function(e,i){return i||ge(e,2,this.length),this[e]|this[e+1]<<8},K.prototype.readUInt16BE=function(e,i){return i||ge(e,2,this.length),this[e]<<8|this[e+1]},K.prototype.readUInt32LE=function(e,i){return i||ge(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},K.prototype.readUInt32BE=function(e,i){return i||ge(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},K.prototype.readIntLE=function(e,i,t){e|=0,i|=0,t||ge(e,i,this.length);for(var n=this[e],a=1,o=0;++o=(a*=128)&&(n-=Math.pow(2,8*i)),n},K.prototype.readIntBE=function(e,i,t){e|=0,i|=0,t||ge(e,i,this.length);for(var n=i,a=1,o=this[e+--n];n>0&&(a*=256);)o+=this[e+--n]*a;return o>=(a*=128)&&(o-=Math.pow(2,8*i)),o},K.prototype.readInt8=function(e,i){return i||ge(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},K.prototype.readInt16LE=function(e,i){i||ge(e,2,this.length);var t=this[e]|this[e+1]<<8;return 32768&t?4294901760|t:t},K.prototype.readInt16BE=function(e,i){i||ge(e,2,this.length);var t=this[e+1]|this[e]<<8;return 32768&t?4294901760|t:t},K.prototype.readInt32LE=function(e,i){return i||ge(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},K.prototype.readInt32BE=function(e,i){return i||ge(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},K.prototype.readFloatLE=function(e,i){return i||ge(e,4,this.length),D(this,e,!0,23,4)},K.prototype.readFloatBE=function(e,i){return i||ge(e,4,this.length),D(this,e,!1,23,4)},K.prototype.readDoubleLE=function(e,i){return i||ge(e,8,this.length),D(this,e,!0,52,8)},K.prototype.readDoubleBE=function(e,i){return i||ge(e,8,this.length),D(this,e,!1,52,8)},K.prototype.writeUIntLE=function(e,i,t,n){(e=+e,i|=0,t|=0,n)||he(this,e,i,t,Math.pow(2,8*t)-1,0);var a=1,o=0;for(this[i]=255&e;++o=0&&(o*=256);)this[i+a]=e/o&255;return i+t},K.prototype.writeUInt8=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,1,255,0),K.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),this[i]=255&e,i+1},K.prototype.writeUInt16LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,65535,0),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8):me(this,e,i,!0),i+2},K.prototype.writeUInt16BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,65535,0),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>8,this[i+1]=255&e):me(this,e,i,!1),i+2},K.prototype.writeUInt32LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,4294967295,0),K.TYPED_ARRAY_SUPPORT?(this[i+3]=e>>>24,this[i+2]=e>>>16,this[i+1]=e>>>8,this[i]=255&e):ve(this,e,i,!0),i+4},K.prototype.writeUInt32BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,4294967295,0),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e):ve(this,e,i,!1),i+4},K.prototype.writeIntLE=function(e,i,t,n){if(e=+e,i|=0,!n){var a=Math.pow(2,8*t-1);he(this,e,i,t,a-1,-a)}var o=0,r=1,l=0;for(this[i]=255&e;++o>0)-l&255;return i+t},K.prototype.writeIntBE=function(e,i,t,n){if(e=+e,i|=0,!n){var a=Math.pow(2,8*t-1);he(this,e,i,t,a-1,-a)}var o=t-1,r=1,l=0;for(this[i+o]=255&e;--o>=0&&(r*=256);)e<0&&0===l&&0!==this[i+o+1]&&(l=1),this[i+o]=(e/r>>0)-l&255;return i+t},K.prototype.writeInt8=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,1,127,-128),K.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),e<0&&(e=255+e+1),this[i]=255&e,i+1},K.prototype.writeInt16LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,32767,-32768),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8):me(this,e,i,!0),i+2},K.prototype.writeInt16BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,32767,-32768),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>8,this[i+1]=255&e):me(this,e,i,!1),i+2},K.prototype.writeInt32LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,2147483647,-2147483648),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8,this[i+2]=e>>>16,this[i+3]=e>>>24):ve(this,e,i,!0),i+4},K.prototype.writeInt32BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e):ve(this,e,i,!1),i+4},K.prototype.writeFloatLE=function(e,i,t){return we(this,e,i,!0,t)},K.prototype.writeFloatBE=function(e,i,t){return we(this,e,i,!1,t)},K.prototype.writeDoubleLE=function(e,i,t){return ye(this,e,i,!0,t)},K.prototype.writeDoubleBE=function(e,i,t){return ye(this,e,i,!1,t)},K.prototype.copy=function(e,i,t,n){if(t||(t=0),n||0===n||(n=this.length),i>=e.length&&(i=e.length),i||(i=0),n>0&&n=this.length)throw new RangeError("sourceStart out of bounds");if(n<0)throw new RangeError("sourceEnd out of bounds");n>this.length&&(n=this.length),e.length-i=0;--a)e[a+i]=this[a+t];else if(o<1e3||!K.TYPED_ARRAY_SUPPORT)for(a=0;a>>=0,t=void 0===t?this.length:t>>>0,e||(e=0),"number"==typeof e)for(o=i;o55295&&t<57344){if(!a){if(t>56319){(i-=3)>-1&&o.push(239,191,189);continue}if(r+1===n){(i-=3)>-1&&o.push(239,191,189);continue}a=t;continue}if(t<56320){(i-=3)>-1&&o.push(239,191,189),a=t;continue}t=65536+(a-55296<<10|t-56320)}else a&&(i-=3)>-1&&o.push(239,191,189);if(a=null,t<128){if((i-=1)<0)break;o.push(t)}else if(t<2048){if((i-=2)<0)break;o.push(t>>6|192,63&t|128)}else if(t<65536){if((i-=3)<0)break;o.push(t>>12|224,t>>6&63|128,63&t|128)}else{if(!(t<1114112))throw new Error("Invalid code point");if((i-=4)<0)break;o.push(t>>18|240,t>>12&63|128,t>>6&63|128,63&t|128)}}return o}function be(e){return function(e){var i,t,n,a,o,r;G||U();var l=e.length;if(l%4>0)throw new Error("Invalid string. Length must be a multiple of 4");o="="===e[l-2]?2:"="===e[l-1]?1:0,r=new E(3*l/4-o),n=o>0?l-4:l;var s=0;for(i=0,t=0;i>16&255,r[s++]=a>>8&255,r[s++]=255&a;return 2===o?(a=S[e.charCodeAt(i)]<<2|S[e.charCodeAt(i+1)]>>4,r[s++]=255&a):1===o&&(a=S[e.charCodeAt(i)]<<10|S[e.charCodeAt(i+1)]<<4|S[e.charCodeAt(i+2)]>>2,r[s++]=a>>8&255,r[s++]=255&a),r}(function(e){if((e=function(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}(e).replace(Ce,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function je(e,i,t,n){for(var a=0;a=i.length||a>=e.length);++a)i[a+t]=e[a];return a}function ke(e){return!!e.constructor&&"function"==typeof e.constructor.isBuffer&&e.constructor.isBuffer(e)}function Pe(e,i){return function(){return e.apply(i,arguments)}}var Oe,Me=Object.prototype.toString,Te=Object.getPrototypeOf,qe=(Oe=Object.create(null),function(e){var i=Me.call(e);return Oe[i]||(Oe[i]=i.slice(8,-1).toLowerCase())}),Se=function(e){return e=e.toLowerCase(),function(i){return qe(i)===e}},Ee=function(e){return function(i){return C(i)===e}},Ge=Array.isArray,Ue=Ee("undefined");var Re=Se("ArrayBuffer");var xe=Ee("string"),De=Ee("function"),ze=Ee("number"),We=function(e){return null!==e&&"object"===C(e)},Be=function(e){if("object"!==qe(e))return!1;var i=Te(e);return!(null!==i&&i!==Object.prototype&&null!==Object.getPrototypeOf(i)||Symbol.toStringTag in e||Symbol.iterator in e)},Le=Se("Date"),Ne=Se("File"),Ke=Se("Blob"),Fe=Se("FileList"),Je=Se("URLSearchParams"),Ve=m(["ReadableStream","Request","Response","Headers"].map(Se),4),_e=Ve[0],Qe=Ve[1],He=Ve[2],Ye=Ve[3];function $e(e,i){var t,n,a=(arguments.length>2&&void 0!==arguments[2]?arguments[2]:{}).allOwnKeys,o=void 0!==a&&a;if(null!==e&&void 0!==e)if("object"!==C(e)&&(e=[e]),Ge(e))for(t=0,n=e.length;t0;)if(i===(t=n[a]).toLowerCase())return t;return null}var Xe="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:"undefined"!=typeof window?window:T,ei=function(e){return!Ue(e)&&e!==Xe};var ii,ti=(ii="undefined"!=typeof Uint8Array&&Te(Uint8Array),function(e){return ii&&e instanceof ii}),ni=Se("HTMLFormElement"),ai=function(e){var i=Object.prototype.hasOwnProperty;return function(e,t){return i.call(e,t)}}(),oi=Se("RegExp"),ri=function(e,i){var t={};$e(Object.getOwnPropertyDescriptors(e),function(n,a){var o;!1!==(o=i(n,a,e))&&(t[a]=o||n)}),Object.defineProperties(e,t)},li="abcdefghijklmnopqrstuvwxyz",si={DIGIT:"0123456789",ALPHA:li,ALPHA_DIGIT:li+li.toUpperCase()+"0123456789"};var ui=Se("AsyncFunction"),pi={isArray:Ge,isArrayBuffer:Re,isBuffer:function(e){return null!==e&&!Ue(e)&&null!==e.constructor&&!Ue(e.constructor)&&De(e.constructor.isBuffer)&&e.constructor.isBuffer(e)},isFormData:function(e){var i;return e&&("function"==typeof FormData&&e instanceof FormData||De(e.append)&&("formdata"===(i=qe(e))||"object"===i&&De(e.toString)&&"[object FormData]"===e.toString()))},isArrayBufferView:function(e){return"undefined"!=typeof ArrayBuffer&&ArrayBuffer.isView?ArrayBuffer.isView(e):e&&e.buffer&&Re(e.buffer)},isString:xe,isNumber:ze,isBoolean:function(e){return!0===e||!1===e},isObject:We,isPlainObject:Be,isReadableStream:_e,isRequest:Qe,isResponse:He,isHeaders:Ye,isUndefined:Ue,isDate:Le,isFile:Ne,isBlob:Ke,isRegExp:oi,isFunction:De,isStream:function(e){return We(e)&&De(e.pipe)},isURLSearchParams:Je,isTypedArray:ti,isFileList:Fe,forEach:$e,merge:function e(){for(var i=(ei(this)&&this||{}).caseless,t={},n=function(n,a){var o=i&&Ze(t,a)||a;Be(t[o])&&Be(n)?t[o]=e(t[o],n):Be(n)?t[o]=e({},n):Ge(n)?t[o]=n.slice():t[o]=n},a=0,o=arguments.length;a3&&void 0!==arguments[3]?arguments[3]:{}).allOwnKeys}),e},trim:function(e){return e.trim?e.trim():e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")},stripBOM:function(e){return 65279===e.charCodeAt(0)&&(e=e.slice(1)),e},inherits:function(e,i,t,n){e.prototype=Object.create(i.prototype,n),e.prototype.constructor=e,Object.defineProperty(e,"super",{value:i.prototype}),t&&Object.assign(e.prototype,t)},toFlatObject:function(e,i,t,n){var a,o,r,l={};if(i=i||{},null==e)return i;do{for(o=(a=Object.getOwnPropertyNames(e)).length;o-- >0;)r=a[o],n&&!n(r,e,i)||l[r]||(i[r]=e[r],l[r]=!0);e=!1!==t&&Te(e)}while(e&&(!t||t(e,i))&&e!==Object.prototype);return i},kindOf:qe,kindOfTest:Se,endsWith:function(e,i,t){e=String(e),(void 0===t||t>e.length)&&(t=e.length),t-=i.length;var n=e.indexOf(i,t);return-1!==n&&n===t},toArray:function(e){if(!e)return null;if(Ge(e))return e;var i=e.length;if(!ze(i))return null;for(var t=new Array(i);i-- >0;)t[i]=e[i];return t},forEachEntry:function(e,i){for(var t,n=(e&&e[Symbol.iterator]).call(e);(t=n.next())&&!t.done;){var a=t.value;i.call(e,a[0],a[1])}},matchAll:function(e,i){for(var t,n=[];null!==(t=e.exec(i));)n.push(t);return n},isHTMLForm:ni,hasOwnProperty:ai,hasOwnProp:ai,reduceDescriptors:ri,freezeMethods:function(e){ri(e,function(i,t){if(De(e)&&-1!==["arguments","caller","callee"].indexOf(t))return!1;var n=e[t];De(n)&&(i.enumerable=!1,"writable"in i?i.writable=!1:i.set||(i.set=function(){throw Error("Can not rewrite read-only method '"+t+"'")}))})},toObjectSet:function(e,i){var t={},n=function(e){e.forEach(function(e){t[e]=!0})};return Ge(e)?n(e):n(String(e).split(i)),t},toCamelCase:function(e){return e.toLowerCase().replace(/[-_\s]([a-z\d])(\w*)/g,function(e,i,t){return i.toUpperCase()+t})},noop:function(){},toFiniteNumber:function(e,i){return null!=e&&Number.isFinite(e=+e)?e:i},findKey:Ze,global:Xe,isContextDefined:ei,ALPHABET:si,generateString:function(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:16,i=arguments.length>1&&void 0!==arguments[1]?arguments[1]:si.ALPHA_DIGIT,t="",n=i.length;e--;)t+=i[Math.random()*n|0];return t},isSpecCompliantForm:function(e){return!!(e&&De(e.append)&&"FormData"===e[Symbol.toStringTag]&&e[Symbol.iterator])},toJSONObject:function(e){var i=new Array(10);return function e(t,n){if(We(t)){if(i.indexOf(t)>=0)return;if(!("toJSON"in t)){i[n]=t;var a=Ge(t)?[]:{};return $e(t,function(i,t){var o=e(i,n+1);!Ue(o)&&(a[t]=o)}),i[n]=void 0,a}}return t}(e,0)},isAsyncFn:ui,isThenable:function(e){return e&&(We(e)||De(e))&&De(e.then)&&De(e.catch)}};function ci(e,i,t,n,a){Error.call(this),Error.captureStackTrace?Error.captureStackTrace(this,this.constructor):this.stack=(new Error).stack,this.message=e,this.name="AxiosError",i&&(this.code=i),t&&(this.config=t),n&&(this.request=n),a&&(this.response=a)}pi.inherits(ci,Error,{toJSON:function(){return{message:this.message,name:this.name,description:this.description,number:this.number,fileName:this.fileName,lineNumber:this.lineNumber,columnNumber:this.columnNumber,stack:this.stack,config:pi.toJSONObject(this.config),code:this.code,status:this.response&&this.response.status?this.response.status:null}}});var di=ci.prototype,gi={};["ERR_BAD_OPTION_VALUE","ERR_BAD_OPTION","ECONNABORTED","ETIMEDOUT","ERR_NETWORK","ERR_FR_TOO_MANY_REDIRECTS","ERR_DEPRECATED","ERR_BAD_RESPONSE","ERR_BAD_REQUEST","ERR_CANCELED","ERR_NOT_SUPPORT","ERR_INVALID_URL"].forEach(function(e){gi[e]={value:e}}),Object.defineProperties(ci,gi),Object.defineProperty(di,"isAxiosError",{value:!0}),ci.from=function(e,i,t,n,a,o){var r=Object.create(di);return pi.toFlatObject(e,r,function(e){return e!==Error.prototype},function(e){return"isAxiosError"!==e}),ci.call(r,e.message,i,t,n,a),r.cause=e,r.name=e.name,o&&Object.assign(r,o),r};function hi(e){return pi.isPlainObject(e)||pi.isArray(e)}function mi(e){return pi.endsWith(e,"[]")?e.slice(0,-2):e}function vi(e,i,t){return e?e.concat(i).map(function(e,i){return e=mi(e),!t&&i?"["+e+"]":e}).join(t?".":""):i}var fi=pi.toFlatObject(pi,{},null,function(e){return/^is[A-Z]/.test(e)});function wi(e,i,t){if(!pi.isObject(e))throw new TypeError("target must be an object");i=i||new FormData;var n=(t=pi.toFlatObject(t,{metaTokens:!0,dots:!1,indexes:!1},!1,function(e,i){return!pi.isUndefined(i[e])})).metaTokens,a=t.visitor||u,o=t.dots,r=t.indexes,l=(t.Blob||"undefined"!=typeof Blob&&Blob)&&pi.isSpecCompliantForm(i);if(!pi.isFunction(a))throw new TypeError("visitor must be a function");function s(e){if(null===e)return"";if(pi.isDate(e))return e.toISOString();if(!l&&pi.isBlob(e))throw new ci("Blob is not supported. Use a Buffer instead.");return pi.isArrayBuffer(e)||pi.isTypedArray(e)?l&&"function"==typeof Blob?new Blob([e]):K.from(e):e}function u(e,t,a){var l=e;if(e&&!a&&"object"===C(e))if(pi.endsWith(t,"{}"))t=n?t:t.slice(0,-2),e=JSON.stringify(e);else if(pi.isArray(e)&&function(e){return pi.isArray(e)&&!e.some(hi)}(e)||(pi.isFileList(e)||pi.endsWith(t,"[]"))&&(l=pi.toArray(e)))return t=mi(t),l.forEach(function(e,n){!pi.isUndefined(e)&&null!==e&&i.append(!0===r?vi([t],n,o):null===r?t:t+"[]",s(e))}),!1;return!!hi(e)||(i.append(vi(a,t,o),s(e)),!1)}var p=[],c=Object.assign(fi,{defaultVisitor:u,convertValue:s,isVisitable:hi});if(!pi.isObject(e))throw new TypeError("data must be an object");return function e(t,n){if(!pi.isUndefined(t)){if(-1!==p.indexOf(t))throw Error("Circular reference detected in "+n.join("."));p.push(t),pi.forEach(t,function(t,o){!0===(!(pi.isUndefined(t)||null===t)&&a.call(i,t,pi.isString(o)?o.trim():o,n,c))&&e(t,n?n.concat(o):[o])}),p.pop()}}(e),i}function yi(e){var i={"!":"%21","'":"%27","(":"%28",")":"%29","~":"%7E","%20":"+","%00":"\0"};return encodeURIComponent(e).replace(/[!'()~]|%20|%00/g,function(e){return i[e]})}function Ci(e,i){this._pairs=[],e&&wi(e,this,i)}var Ii=Ci.prototype;function Ai(e){return encodeURIComponent(e).replace(/%3A/gi,":").replace(/%24/g,"$").replace(/%2C/gi,",").replace(/%20/g,"+").replace(/%5B/gi,"[").replace(/%5D/gi,"]")}function bi(e,i,t){if(!i)return e;var n,a=t&&t.encode||Ai,o=t&&t.serialize;if(n=o?o(i,t):pi.isURLSearchParams(i)?i.toString():new Ci(i,t).toString(a)){var r=e.indexOf("#");-1!==r&&(e=e.slice(0,r)),e+=(-1===e.indexOf("?")?"?":"&")+n}return e}Ii.append=function(e,i){this._pairs.push([e,i])},Ii.toString=function(e){var i=e?function(i){return e.call(this,i,yi)}:yi;return this._pairs.map(function(e){return i(e[0])+"="+i(e[1])},"").join("&")};var ji,ki=function(){return g(function e(){c(this,e),this.handlers=[]},[{key:"use",value:function(e,i,t){return this.handlers.push({fulfilled:e,rejected:i,synchronous:!!t&&t.synchronous,runWhen:t?t.runWhen:null}),this.handlers.length-1}},{key:"eject",value:function(e){this.handlers[e]&&(this.handlers[e]=null)}},{key:"clear",value:function(){this.handlers&&(this.handlers=[])}},{key:"forEach",value:function(e){pi.forEach(this.handlers,function(i){null!==i&&e(i)})}}])}(),Pi={silentJSONParsing:!0,forcedJSONParsing:!0,clarifyTimeoutError:!1},Oi={isBrowser:!0,classes:{URLSearchParams:"undefined"!=typeof URLSearchParams?URLSearchParams:Ci,FormData:"undefined"!=typeof FormData?FormData:null,Blob:"undefined"!=typeof Blob?Blob:null},protocols:["http","https","file","blob","url","data"]},Mi="undefined"!=typeof window&&"undefined"!=typeof document,Ti=(ji="undefined"!=typeof navigator&&navigator.product,Mi&&["ReactNative","NativeScript","NS"].indexOf(ji)<0),qi="undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope&&"function"==typeof self.importScripts,Si=Mi&&window.location.href||"http://localhost",Ei=u(u({},Object.freeze({__proto__:null,hasBrowserEnv:Mi,hasStandardBrowserWebWorkerEnv:qi,hasStandardBrowserEnv:Ti,origin:Si})),Oi);function Gi(e){function i(e,t,n,a){var o=e[a++];if("__proto__"===o)return!0;var r=Number.isFinite(+o),l=a>=e.length;return o=!o&&pi.isArray(n)?n.length:o,l?(pi.hasOwnProp(n,o)?n[o]=[n[o],t]:n[o]=t,!r):(n[o]&&pi.isObject(n[o])||(n[o]=[]),i(e,t,n[o],a)&&pi.isArray(n[o])&&(n[o]=function(e){var i,t,n={},a=Object.keys(e),o=a.length;for(i=0;i-1,o=pi.isObject(e);if(o&&pi.isHTMLForm(e)&&(e=new FormData(e)),pi.isFormData(e))return a?JSON.stringify(Gi(e)):e;if(pi.isArrayBuffer(e)||pi.isBuffer(e)||pi.isStream(e)||pi.isFile(e)||pi.isBlob(e)||pi.isReadableStream(e))return e;if(pi.isArrayBufferView(e))return e.buffer;if(pi.isURLSearchParams(e))return i.setContentType("application/x-www-form-urlencoded;charset=utf-8",!1),e.toString();if(o){if(n.indexOf("application/x-www-form-urlencoded")>-1)return function(e,i){return wi(e,new Ei.classes.URLSearchParams,Object.assign({visitor:function(e,i,t,n){return Ei.isNode&&pi.isBuffer(e)?(this.append(i,e.toString("base64")),!1):n.defaultVisitor.apply(this,arguments)}},i))}(e,this.formSerializer).toString();if((t=pi.isFileList(e))||n.indexOf("multipart/form-data")>-1){var r=this.env&&this.env.FormData;return wi(t?{"files[]":e}:e,r&&new r,this.formSerializer)}}return o||a?(i.setContentType("application/json",!1),function(e,i,t){if(pi.isString(e))try{return(i||JSON.parse)(e),pi.trim(e)}catch(e){if("SyntaxError"!==e.name)throw e}return(t||JSON.stringify)(e)}(e)):e}],transformResponse:[function(e){var i=this.transitional||Ui.transitional,t=i&&i.forcedJSONParsing,n="json"===this.responseType;if(pi.isResponse(e)||pi.isReadableStream(e))return e;if(e&&pi.isString(e)&&(t&&!this.responseType||n)){var a=!(i&&i.silentJSONParsing)&&n;try{return JSON.parse(e)}catch(e){if(a){if("SyntaxError"===e.name)throw ci.from(e,ci.ERR_BAD_RESPONSE,this,null,this.response);throw e}}}return e}],timeout:0,xsrfCookieName:"XSRF-TOKEN",xsrfHeaderName:"X-XSRF-TOKEN",maxContentLength:-1,maxBodyLength:-1,env:{FormData:Ei.classes.FormData,Blob:Ei.classes.Blob},validateStatus:function(e){return e>=200&&e<300},headers:{common:{Accept:"application/json, text/plain, */*","Content-Type":void 0}}};pi.forEach(["delete","get","head","post","put","patch"],function(e){Ui.headers[e]={}});var Ri=Ui,xi=pi.toObjectSet(["age","authorization","content-length","content-type","etag","expires","from","host","if-modified-since","if-unmodified-since","last-modified","location","max-forwards","proxy-authorization","referer","retry-after","user-agent"]),Di=Symbol("internals");function zi(e){return e&&String(e).trim().toLowerCase()}function Wi(e){return!1===e||null==e?e:pi.isArray(e)?e.map(Wi):String(e)}function Bi(e,i,t,n,a){return pi.isFunction(n)?n.call(this,i,t):(a&&(i=t),pi.isString(i)?pi.isString(n)?-1!==i.indexOf(n):pi.isRegExp(n)?n.test(i):void 0:void 0)}var Li=function(){return g(function e(i){c(this,e),i&&this.set(i)},[{key:"set",value:function(e,i,t){var n=this;function a(e,i,t){var a=zi(i);if(!a)throw new Error("header name must be a non-empty string");var o=pi.findKey(n,a);(!o||void 0===n[o]||!0===t||void 0===t&&!1!==n[o])&&(n[o||i]=Wi(e))}var o=function(e,i){return pi.forEach(e,function(e,t){return a(e,t,i)})};if(pi.isPlainObject(e)||e instanceof this.constructor)o(e,i);else if(pi.isString(e)&&(e=e.trim())&&!/^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(e.trim()))o(function(e){var i,t,n,a={};return e&&e.split("\n").forEach(function(e){n=e.indexOf(":"),i=e.substring(0,n).trim().toLowerCase(),t=e.substring(n+1).trim(),!i||a[i]&&xi[i]||("set-cookie"===i?a[i]?a[i].push(t):a[i]=[t]:a[i]=a[i]?a[i]+", "+t:t)}),a}(e),i);else if(pi.isHeaders(e)){var r,l=function(e,i){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(!t){if(Array.isArray(e)||(t=f(e))||i&&e&&"number"==typeof e.length){t&&(e=t);var n=0,a=function(){};return{s:a,n:function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}},e:function(e){throw e},f:a}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var o,r=!0,l=!1;return{s:function(){t=t.call(e)},n:function(){var e=t.next();return r=e.done,e},e:function(e){l=!0,o=e},f:function(){try{r||null==t.return||t.return()}finally{if(l)throw o}}}}(e.entries());try{for(l.s();!(r=l.n()).done;){var s=m(r.value,2),u=s[0];a(s[1],u,t)}}catch(e){l.e(e)}finally{l.f()}}else null!=e&&a(i,e,t);return this}},{key:"get",value:function(e,i){if(e=zi(e)){var t=pi.findKey(this,e);if(t){var n=this[t];if(!i)return n;if(!0===i)return function(e){for(var i,t=Object.create(null),n=/([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;i=n.exec(e);)t[i[1]]=i[2];return t}(n);if(pi.isFunction(i))return i.call(this,n,t);if(pi.isRegExp(i))return i.exec(n);throw new TypeError("parser must be boolean|regexp|function")}}}},{key:"has",value:function(e,i){if(e=zi(e)){var t=pi.findKey(this,e);return!(!t||void 0===this[t]||i&&!Bi(0,this[t],t,i))}return!1}},{key:"delete",value:function(e,i){var t=this,n=!1;function a(e){if(e=zi(e)){var a=pi.findKey(t,e);!a||i&&!Bi(0,t[a],a,i)||(delete t[a],n=!0)}}return pi.isArray(e)?e.forEach(a):a(e),n}},{key:"clear",value:function(e){for(var i=Object.keys(this),t=i.length,n=!1;t--;){var a=i[t];e&&!Bi(0,this[a],a,e,!0)||(delete this[a],n=!0)}return n}},{key:"normalize",value:function(e){var i=this,t={};return pi.forEach(this,function(n,a){var o=pi.findKey(t,a);if(o)return i[o]=Wi(n),void delete i[a];var r=e?function(e){return e.trim().toLowerCase().replace(/([a-z\d])(\w*)/g,function(e,i,t){return i.toUpperCase()+t})}(a):String(a).trim();r!==a&&delete i[a],i[r]=Wi(n),t[r]=!0}),this}},{key:"concat",value:function(){for(var e,i=arguments.length,t=new Array(i),n=0;n1?t-1:0),a=1;a2&&void 0!==arguments[2]?arguments[2]:3,n=0,a=function(e,i){e=e||10;var t,n=new Array(e),a=new Array(e),o=0,r=0;return i=void 0!==i?i:1e3,function(l){var s=Date.now(),u=a[r];t||(t=s),n[o]=l,a[o]=s;for(var p=r,c=0;p!==o;)c+=n[p++],p%=e;if((o=(o+1)%e)===r&&(r=(r+1)%e),!(s-tn)return a&&(clearTimeout(a),a=null),t=r,e.apply(null,arguments);a||(a=setTimeout(function(){return a=null,t=Date.now(),e.apply(null,i)},n-(r-t)))}}(function(t){var o=t.loaded,r=t.lengthComputable?t.total:void 0,l=o-n,s=a(l);n=o;var u={loaded:o,total:r,progress:r?o/r:void 0,bytes:l,rate:s||void 0,estimated:s&&r&&o<=r?(r-o)/s:void 0,event:t,lengthComputable:null!=r};u[i?"download":"upload"]=!0,e(u)},t)},Qi=Ei.hasStandardBrowserEnv?function(){var e,i=/(msie|trident)/i.test(navigator.userAgent),t=document.createElement("a");function n(e){var n=e;return i&&(t.setAttribute("href",n),n=t.href),t.setAttribute("href",n),{href:t.href,protocol:t.protocol?t.protocol.replace(/:$/,""):"",host:t.host,search:t.search?t.search.replace(/^\?/,""):"",hash:t.hash?t.hash.replace(/^#/,""):"",hostname:t.hostname,port:t.port,pathname:"/"===t.pathname.charAt(0)?t.pathname:"/"+t.pathname}}return e=n(window.location.href),function(i){var t=pi.isString(i)?n(i):i;return t.protocol===e.protocol&&t.host===e.host}}():function(){return!0},Hi=Ei.hasStandardBrowserEnv?{write:function(e,i,t,n,a,o){var r=[e+"="+encodeURIComponent(i)];pi.isNumber(t)&&r.push("expires="+new Date(t).toGMTString()),pi.isString(n)&&r.push("path="+n),pi.isString(a)&&r.push("domain="+a),!0===o&&r.push("secure"),document.cookie=r.join("; ")},read:function(e){var i=document.cookie.match(new RegExp("(^|;\\s*)("+e+")=([^;]*)"));return i?decodeURIComponent(i[3]):null},remove:function(e){this.write(e,"",Date.now()-864e5)}}:{write:function(){},read:function(){return null},remove:function(){}};function Yi(e,i){return e&&!/^([a-z][a-z\d+\-.]*:)?\/\//i.test(i)?function(e,i){return i?e.replace(/\/?\/$/,"")+"/"+i.replace(/^\/+/,""):e}(e,i):i}var $i=function(e){return e instanceof Ni?u({},e):e};function Zi(e,i){i=i||{};var t={};function n(e,i,t){return pi.isPlainObject(e)&&pi.isPlainObject(i)?pi.merge.call({caseless:t},e,i):pi.isPlainObject(i)?pi.merge({},i):pi.isArray(i)?i.slice():i}function a(e,i,t){return pi.isUndefined(i)?pi.isUndefined(e)?void 0:n(void 0,e,t):n(e,i,t)}function o(e,i){if(!pi.isUndefined(i))return n(void 0,i)}function r(e,i){return pi.isUndefined(i)?pi.isUndefined(e)?void 0:n(void 0,e):n(void 0,i)}function l(t,a,o){return o in i?n(t,a):o in e?n(void 0,t):void 0}var s={url:o,method:o,data:o,baseURL:r,transformRequest:r,transformResponse:r,paramsSerializer:r,timeout:r,timeoutMessage:r,withCredentials:r,withXSRFToken:r,adapter:r,responseType:r,xsrfCookieName:r,xsrfHeaderName:r,onUploadProgress:r,onDownloadProgress:r,decompress:r,maxContentLength:r,maxBodyLength:r,beforeRedirect:r,transport:r,httpAgent:r,httpsAgent:r,cancelToken:r,socketPath:r,responseEncoding:r,validateStatus:l,headers:function(e,i){return a($i(e),$i(i),!0)}};return pi.forEach(Object.keys(Object.assign({},e,i)),function(n){var o=s[n]||a,r=o(e[n],i[n],n);pi.isUndefined(r)&&o!==l||(t[n]=r)}),t}var Xi,et,it,tt,nt=function(e){var i,t,n=Zi({},e),a=n.data,o=n.withXSRFToken,s=n.xsrfHeaderName,u=n.xsrfCookieName,p=n.headers,c=n.auth;if(n.headers=p=Ni.from(p),n.url=bi(Yi(n.baseURL,n.url),e.params,e.paramsSerializer),c&&p.set("Authorization","Basic "+btoa((c.username||"")+":"+(c.password?unescape(encodeURIComponent(c.password)):""))),pi.isFormData(a))if(Ei.hasStandardBrowserEnv||Ei.hasStandardBrowserWebWorkerEnv)p.setContentType(void 0);else if(!1!==(i=p.getContentType())){var d=i?i.split(";").map(function(e){return e.trim()}).filter(Boolean):[],g=y(t=d)||l(t)||f(t)||v(),h=g[0],m=g.slice(1);p.setContentType([h||"multipart/form-data"].concat(r(m)).join("; "))}if(Ei.hasStandardBrowserEnv&&(o&&pi.isFunction(o)&&(o=o(n)),o||!1!==o&&Qi(n.url))){var w=s&&u&&Hi.read(u);w&&p.set(s,w)}return n},at="undefined"!=typeof XMLHttpRequest&&function(e){return new Promise(function(i,t){var n,a=nt(e),o=a.data,r=Ni.from(a.headers).normalize(),l=a.responseType;function s(){a.cancelToken&&a.cancelToken.unsubscribe(n),a.signal&&a.signal.removeEventListener("abort",n)}var u=new XMLHttpRequest;function p(){if(u){var n=Ni.from("getAllResponseHeaders"in u&&u.getAllResponseHeaders());Vi(function(e){i(e),s()},function(e){t(e),s()},{data:l&&"text"!==l&&"json"!==l?u.response:u.responseText,status:u.status,statusText:u.statusText,headers:n,config:e,request:u}),u=null}}u.open(a.method.toUpperCase(),a.url,!0),u.timeout=a.timeout,"onloadend"in u?u.onloadend=p:u.onreadystatechange=function(){u&&4===u.readyState&&(0!==u.status||u.responseURL&&0===u.responseURL.indexOf("file:"))&&setTimeout(p)},u.onabort=function(){u&&(t(new ci("Request aborted",ci.ECONNABORTED,a,u)),u=null)},u.onerror=function(){t(new ci("Network Error",ci.ERR_NETWORK,a,u)),u=null},u.ontimeout=function(){var e=a.timeout?"timeout of "+a.timeout+"ms exceeded":"timeout exceeded",i=a.transitional||Pi;a.timeoutErrorMessage&&(e=a.timeoutErrorMessage),t(new ci(e,i.clarifyTimeoutError?ci.ETIMEDOUT:ci.ECONNABORTED,a,u)),u=null},void 0===o&&r.setContentType(null),"setRequestHeader"in u&&pi.forEach(r.toJSON(),function(e,i){u.setRequestHeader(i,e)}),pi.isUndefined(a.withCredentials)||(u.withCredentials=!!a.withCredentials),l&&"json"!==l&&(u.responseType=a.responseType),"function"==typeof a.onDownloadProgress&&u.addEventListener("progress",_i(a.onDownloadProgress,!0)),"function"==typeof a.onUploadProgress&&u.upload&&u.upload.addEventListener("progress",_i(a.onUploadProgress)),(a.cancelToken||a.signal)&&(n=function(i){u&&(t(!i||i.type?new Ji(null,e,u):i),u.abort(),u=null)},a.cancelToken&&a.cancelToken.subscribe(n),a.signal&&(a.signal.aborted?n():a.signal.addEventListener("abort",n)));var c,d,g=(c=a.url,(d=/^([-+\w]{1,25})(:?\/\/|:)/.exec(c))&&d[1]||"");g&&-1===Ei.protocols.indexOf(g)?t(new ci("Unsupported protocol "+g+":",ci.ERR_BAD_REQUEST,e)):u.send(o||null)})},ot=function(e,i){var t,n=new AbortController,a=function(e){if(!t){t=!0,r();var i=e instanceof Error?e:this.reason;n.abort(i instanceof ci?i:new Ji(i instanceof Error?i.message:i))}},o=i&&setTimeout(function(){a(new ci("timeout ".concat(i," of ms exceeded"),ci.ETIMEDOUT))},i),r=function(){e&&(o&&clearTimeout(o),o=null,e.forEach(function(e){e&&(e.removeEventListener?e.removeEventListener("abort",a):e.unsubscribe(a))}),e=null)};e.forEach(function(e){return e&&e.addEventListener&&e.addEventListener("abort",a)});var l=n.signal;return l.unsubscribe=r,[l,function(){o&&clearTimeout(o),o=null}]},rt=o().mark(function e(i,t){var n,a,r;return o().wrap(function(e){for(;;)switch(e.prev=e.next){case 0:if(n=i.byteLength,t&&!(n1?"since :\n"+l.map(yt).join("\n"):" "+yt(l[0]):"as no adapter specified"),"ERR_NOT_SUPPORT")}return t},adapters:wt};function At(e){if(e.cancelToken&&e.cancelToken.throwIfRequested(),e.signal&&e.signal.aborted)throw new Ji(null,e)}function bt(e){return At(e),e.headers=Ni.from(e.headers),e.data=Ki.call(e,e.transformRequest),-1!==["post","put","patch"].indexOf(e.method)&&e.headers.setContentType("application/x-www-form-urlencoded",!1),It.getAdapter(e.adapter||Ri.adapter)(e).then(function(i){return At(e),i.data=Ki.call(e,e.transformResponse,i),i.headers=Ni.from(i.headers),i},function(i){return Fi(i)||(At(e),i&&i.response&&(i.response.data=Ki.call(e,e.transformResponse,i.response),i.response.headers=Ni.from(i.response.headers))),Promise.reject(i)})}var jt="1.7.2",kt={};["object","boolean","number","function","string","symbol"].forEach(function(e,i){kt[e]=function(t){return C(t)===e||"a"+(i<1?"n ":" ")+e}});var Pt={};kt.transitional=function(e,i,t){function n(e,i){return"[Axios v"+jt+"] Transitional option '"+e+"'"+i+(t?". "+t:"")}return function(t,a,o){if(!1===e)throw new ci(n(a," has been removed"+(i?" in "+i:"")),ci.ERR_DEPRECATED);return i&&!Pt[a]&&(Pt[a]=!0,console.warn(n(a," has been deprecated since v"+i+" and will be removed in the near future"))),!e||e(t,a,o)}};var Ot={assertOptions:function(e,i,t){if("object"!==C(e))throw new ci("options must be an object",ci.ERR_BAD_OPTION_VALUE);for(var n=Object.keys(e),a=n.length;a-- >0;){var o=n[a],r=i[o];if(r){var l=e[o],s=void 0===l||r(l,o,e);if(!0!==s)throw new ci("option "+o+" must be "+s,ci.ERR_BAD_OPTION_VALUE)}else if(!0!==t)throw new ci("Unknown option "+o,ci.ERR_BAD_OPTION)}},validators:kt},Mt=Ot.validators,Tt=function(){return g(function e(i){c(this,e),this.defaults=i,this.interceptors={request:new ki,response:new ki}},[{key:"request",value:function(){var e=a(o().mark(function e(i,t){var n,a;return o().wrap(function(e){for(;;)switch(e.prev=e.next){case 0:return e.prev=0,e.next=3,this._request(i,t);case 3:return e.abrupt("return",e.sent);case 6:if(e.prev=6,e.t0=e.catch(0),e.t0 instanceof Error){Error.captureStackTrace?Error.captureStackTrace(n={}):n=new Error,a=n.stack?n.stack.replace(/^.+\n/,""):"";try{e.t0.stack?a&&!String(e.t0.stack).endsWith(a.replace(/^.+\n.+\n/,""))&&(e.t0.stack+="\n"+a):e.t0.stack=a}catch(e){}}throw e.t0;case 10:case"end":return e.stop()}},e,this,[[0,6]])}));return function(i,t){return e.apply(this,arguments)}}()},{key:"_request",value:function(e,i){"string"==typeof e?(i=i||{}).url=e:i=e||{};var t=i=Zi(this.defaults,i),n=t.transitional,a=t.paramsSerializer,o=t.headers;void 0!==n&&Ot.assertOptions(n,{silentJSONParsing:Mt.transitional(Mt.boolean),forcedJSONParsing:Mt.transitional(Mt.boolean),clarifyTimeoutError:Mt.transitional(Mt.boolean)},!1),null!=a&&(pi.isFunction(a)?i.paramsSerializer={serialize:a}:Ot.assertOptions(a,{encode:Mt.function,serialize:Mt.function},!0)),i.method=(i.method||this.defaults.method||"get").toLowerCase();var r=o&&pi.merge(o.common,o[i.method]);o&&pi.forEach(["delete","get","head","post","put","patch","common"],function(e){delete o[e]}),i.headers=Ni.concat(r,o);var l=[],s=!0;this.interceptors.request.forEach(function(e){"function"==typeof e.runWhen&&!1===e.runWhen(i)||(s=s&&e.synchronous,l.unshift(e.fulfilled,e.rejected))});var u,p=[];this.interceptors.response.forEach(function(e){p.push(e.fulfilled,e.rejected)});var c,d=0;if(!s){var g=[bt.bind(this),void 0];for(g.unshift.apply(g,l),g.push.apply(g,p),c=g.length,u=Promise.resolve(i);d0;)n._listeners[i](e);n._listeners=null}}),this.promise.then=function(e){var i,t=new Promise(function(e){n.subscribe(e),i=e}).then(e);return t.cancel=function(){n.unsubscribe(i)},t},i(function(e,i,a){n.reason||(n.reason=new Ji(e,i,a),t(n.reason))})}return g(e,[{key:"throwIfRequested",value:function(){if(this.reason)throw this.reason}},{key:"subscribe",value:function(e){this.reason?e(this.reason):this._listeners?this._listeners.push(e):this._listeners=[e]}},{key:"unsubscribe",value:function(e){if(this._listeners){var i=this._listeners.indexOf(e);-1!==i&&this._listeners.splice(i,1)}}}],[{key:"source",value:function(){var i;return{token:new e(function(e){i=e}),cancel:i}}}])}();var Et={Continue:100,SwitchingProtocols:101,Processing:102,EarlyHints:103,Ok:200,Created:201,Accepted:202,NonAuthoritativeInformation:203,NoContent:204,ResetContent:205,PartialContent:206,MultiStatus:207,AlreadyReported:208,ImUsed:226,MultipleChoices:300,MovedPermanently:301,Found:302,SeeOther:303,NotModified:304,UseProxy:305,Unused:306,TemporaryRedirect:307,PermanentRedirect:308,BadRequest:400,Unauthorized:401,PaymentRequired:402,Forbidden:403,NotFound:404,MethodNotAllowed:405,NotAcceptable:406,ProxyAuthenticationRequired:407,RequestTimeout:408,Conflict:409,Gone:410,LengthRequired:411,PreconditionFailed:412,PayloadTooLarge:413,UriTooLong:414,UnsupportedMediaType:415,RangeNotSatisfiable:416,ExpectationFailed:417,ImATeapot:418,MisdirectedRequest:421,UnprocessableEntity:422,Locked:423,FailedDependency:424,TooEarly:425,UpgradeRequired:426,PreconditionRequired:428,TooManyRequests:429,RequestHeaderFieldsTooLarge:431,UnavailableForLegalReasons:451,InternalServerError:500,NotImplemented:501,BadGateway:502,ServiceUnavailable:503,GatewayTimeout:504,HttpVersionNotSupported:505,VariantAlsoNegotiates:506,InsufficientStorage:507,LoopDetected:508,NotExtended:510,NetworkAuthenticationRequired:511};Object.entries(Et).forEach(function(e){var i=m(e,2),t=i[0],n=i[1];Et[n]=t});var Gt=Et;var Ut=function e(i){var t=new qt(i),n=Pe(qt.prototype.request,t);return pi.extend(n,qt.prototype,t,{allOwnKeys:!0}),pi.extend(n,t,null,{allOwnKeys:!0}),n.create=function(t){return e(Zi(i,t))},n}(Ri);Ut.Axios=qt,Ut.CanceledError=Ji,Ut.CancelToken=St,Ut.isCancel=Fi,Ut.VERSION=jt,Ut.toFormData=wi,Ut.AxiosError=ci,Ut.Cancel=Ut.CanceledError,Ut.all=function(e){return Promise.all(e)},Ut.spread=function(e){return function(i){return e.apply(null,i)}},Ut.isAxiosError=function(e){return pi.isObject(e)&&!0===e.isAxiosError},Ut.mergeConfig=Zi,Ut.AxiosHeaders=Ni,Ut.formToJSON=function(e){return Gi(pi.isHTMLForm(e)?new FormData(e):e)},Ut.getAdapter=It.getAdapter,Ut.HttpStatusCode=Gt,Ut.default=Ut;var Rt=Ut,xt={level:{LNone:"none",LError:"error",LDebug:"debug",LTrace:"trace"}},Dt={formats:{JSON:"json",TEXT:"text"}},zt=function(){return g(function e(){c(this,e),this.log_level=xt.level.LNone,this.log_format=Dt.formats.TEXT,this.log_to_console=!0,this.log_file_path,this.log_response_body=!1,this.log_request_body=!1,this.setLogger()},[{key:"logLevelEnum",get:function(){return xt}},{key:"logFormatEnum",get:function(){return Dt}},{key:"setLogger",value:function(){}},{key:"log",value:function(e,i,t,n,a,o,r,l){var s=this.formatLog(e,i,t,n,a,o,r,l);"undefined"!=typeof window?this.calculateLogLevel(e)>0&&!0===this.log_to_console&&(this.log_format===this.logFormatEnum.formats.JSON?console.log(s):console.log("".concat(e.toUpperCase(),": ").concat(s))):this.logger.transports.length>0&&this.logger.log(e,s)}},{key:"calculateLogLevel",value:function(e){switch(this.log_level){case this.logLevelEnum.level.LError:return e!==this.logLevelEnum.level.LError?-1:1;case this.logLevelEnum.level.LDebug:return e===this.logLevelEnum.level.LTrace?-1:1;case this.logLevelEnum.level.LTrace:return 1;default:return-1}}},{key:"formatLog",value:function(e,i,t,n,a,o,r,l){var s,u=a?JSON.parse(JSON.stringify(a)):null,p=o?JSON.parse(JSON.stringify(o)):null,c=r?JSON.parse(JSON.stringify(r)):null,d=l?JSON.parse(JSON.stringify(l)):null;return a&&(u.Authorization="[REDACTED]"),this.log_request_body||(c=void 0),this.log_response_body||(d=void 0),this.log_format&&this.log_format===Dt.formats.JSON?(s={level:e,date:(new Date).toISOString(),method:t,url:decodeURIComponent(n),correlationId:p&&p["inin-correlation-id"]?p["inin-correlation-id"]:"",statusCode:i},u&&(s.requestHeaders=u),p&&(s.responseHeaders=p),c&&(s.requestBody=c),d&&(s.responseBody=d)):s="".concat((new Date).toISOString(),"\n=== REQUEST === \n").concat(this.formatValue("URL",decodeURIComponent(n))).concat(this.formatValue("Method",t)).concat(this.formatValue("Headers",this.formatHeaderString(u))).concat(this.formatValue("Body",c?JSON.stringify(c,null,2):""),"\n=== RESPONSE ===\n").concat(this.formatValue("Status",i)).concat(this.formatValue("Headers",this.formatHeaderString(p))).concat(this.formatValue("CorrelationId",p&&p["inin-correlation-id"]?p["inin-correlation-id"]:"")).concat(this.formatValue("Body",d?JSON.stringify(d,null,2):"")),s}},{key:"formatHeaderString",value:function(e){var i="";if(!e)return i;for(var t=0,n=Object.entries(e);t128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");var i="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(crypto.getRandomValues(new Uint32Array(e))).map(function(e){return i[e%i.length]}).join("")}},{key:"computePKCECodeChallenge",value:function(e){if(e.length<43||e.length>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");var i=(new TextEncoder).encode(e);return new Promise(function(e,t){window.crypto.subtle.digest("SHA-256",i).then(function(i){var t=K.from(i).toString("base64").replaceAll("+","-").replaceAll("/","_");t=t.split("=")[0],e(t)}).catch(function(e){return t(new Error("Code Challenge Error ".concat(e)))})})}},{key:"loginPKCEGrant",value:function(e,i,t,n){var a=this;if(!this.hasLocalStorage&&!n)throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");var o=this._setValuesFromUrlQuery();return this.clientId=e,this.redirectUri=i,this.codeVerifier=n,t||(t={}),new Promise(function(e,i){if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),o&&o.error)return a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),a._saveSettings({accessToken:void 0}),i(new Error("[".concat(o.error,"] ").concat(o.error_description)));o&&o.code?(a.codeVerifier||a.hasLocalStorage&&(a.codeVerifier=sessionStorage.getItem("genesys_cloud_sdk_pkce_code_verifier")),a.authorizePKCEGrant(a.clientId,a.codeVerifier,o.code,a.redirectUri).then(function(){a._testTokenAccess().then(function(){!a.authData.state&&o.state&&(a.authData.state=o.state),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),e(a.authData)}).catch(function(e){return a._saveSettings({accessToken:void 0}),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error("[".concat(e.name,"] ").concat(e.msg)))})}).catch(function(e){return a._saveSettings({accessToken:void 0}),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error("[".concat(e.name,"] ").concat(e.msg)))})):a._testTokenAccess().then(function(){!a.authData.state&&t.state&&(a.authData.state=t.state),e(a.authData)}).catch(function(e){a.codeVerifier||(a.codeVerifier=a.generatePKCECodeVerifier(128),a.hasLocalStorage&&sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",a.codeVerifier)),a.computePKCECodeChallenge(a.codeVerifier).then(function(e){var i={client_id:encodeURIComponent(a.clientId),redirect_uri:encodeURIComponent(a.redirectUri),code_challenge:encodeURIComponent(e),response_type:"code",code_challenge_method:"S256"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=a._buildAuthUrl("oauth/authorize",i);window.location.replace(n)}).catch(function(e){return i(new Error("[".concat(e.name,"]")))})})})}},{key:"_setValuesFromUrlQuery",value:function(){if("undefined"!=typeof window&&window.location.search){var e={},i=new URLSearchParams(window.location.search),t=i.get("code"),n=i.get("error"),a=i.get("error_description"),o=i.get("state");if(n)return e.error=n,a&&(e.error_description=a),e;t&&(e.code=t,o&&(e.state=o));var r,l,s=window.location;return"replaceState"in history?history.replaceState("",document.title,s.pathname):(r=document.body.scrollTop,l=document.body.scrollLeft,history.pushState("",document.title,s.pathname),document.body.scrollTop=r,document.body.scrollLeft=l),e}}},{key:"loginCodeAuthorizationGrant",value:function(e,i,t,n){var a=this;return this.clientId=e,this.clientSecret=i,new Promise(function(o,r){if("undefined"==typeof window){var l=K.from(e+":"+i).toString("base64"),s=a._formAuthRequest(l,{grant_type:"authorization_code",code:t,redirect_uri:n});s.proxy=a.proxy;var u={grant_type:"authorization_code",code:t,redirect_uri:n};a._handleCodeAuthorizationResponse(s,u,o,r)}else r(new Error("The Code Authorization grant is not supported in a browser."))})}},{key:"refreshCodeAuthorizationGrant",value:function(e,i,t){var n=this;return new Promise(function(a,o){if("undefined"==typeof window){var r=K.from(e+":"+i).toString("base64"),l=n._formAuthRequest(r,{grant_type:"refresh_token",refresh_token:t});l.proxy=n.proxy;var s={grant_type:"refresh_token",refresh_token:t};n._handleCodeAuthorizationResponse(l,s,a,o)}else o(new Error("The Code Authorization grant is not supported in a browser."))})}},{key:"_handleCodeAuthorizationResponse",value:function(e,i,t,n){var a=this;e.then(function(n){a.config.logger.log("trace",n.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,n.headers,i,void 0),a.config.logger.log("debug",n.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,void 0,i,void 0);var o=n.data.access_token,r=n.data.refresh_token;a.setAccessToken(o),a.authData.refreshToken=r,a.authData.tokenExpiryTime=(new Date).getTime()+1e3*n.data.expires_in,a.authData.tokenExpiryTimeString=new Date(a.authData.tokenExpiryTime).toUTCString(),t(a.authData)}).catch(function(t){t.response&&a.config.logger.log("error",t.response.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,t.response.headers,i,t.response.data),n(t)})}},{key:"_formAuthRequest",value:function(e,i){return Rt({method:"POST",url:"https://login.".concat(this.config.environment,"/oauth/token"),headers:{Authorization:"Basic "+e,"Content-Type":"application/x-www-form-urlencoded"},data:O.default.stringify(i)})}},{key:"_handleExpiredAccessToken",value:function(){var e=this;return new Promise(function(i,t){"undefined"==typeof window?e.refreshInProgress?e._sleep(e.config.refresh_token_wait_max).then(function(){e.refreshInProgress?t(new Error("Token refresh took longer than ".concat(e.config.refresh_token_wait_max," seconds"))):i()}):(e.refreshInProgress=!0,e.refreshCodeAuthorizationGrant(e.clientId,e.clientSecret,e.authData.refreshToken).then(function(){e.refreshInProgress=!1,i()}).catch(function(i){e.refreshInProgress=!1,t(i)})):t(new Error("This method is not supported in a browser."))})}},{key:"_sleep",value:function(e){return new Promise(function(i){return setTimeout(i,e)})}},{key:"_testTokenAccess",value:function(){var e=this;return new Promise(function(i,t){e._loadSettings(),e.authentications["PureCloud OAuth"].accessToken?e.callApi("/api/v2/tokens/me","GET",null,null,null,null,null,["PureCloud OAuth"],["application/json"],["application/json"]).then(function(){i()}).catch(function(i){e._saveSettings({accessToken:void 0}),t(i)}):t(new Error("Token is not set"))})}},{key:"_setValuesFromUrlHash",value:function(){if("undefined"!=typeof window&&window.location.hash){var e=new RegExp("^#*(.+?)=(.+?)$","i"),i={};if(window.location.hash.split("&").forEach(function(t){var n=e.exec(t);n&&(i[n[1]]=decodeURIComponent(decodeURIComponent(n[2].replace(/\+/g,"%20"))))}),i.error)return i;if(i.access_token){var t={};i.state&&(t.state=i.state),i.expires_in&&(t.tokenExpiryTime=(new Date).getTime()+1e3*parseInt(i.expires_in.replace(/\+/g,"%20")),t.tokenExpiryTimeString=new Date(t.tokenExpiryTime).toUTCString()),t.accessToken=i.access_token.replace(/\+/g,"%20");var n,a,o=window.location;"replaceState"in history?history.replaceState("",document.title,o.pathname+o.search):(n=document.body.scrollTop,a=document.body.scrollLeft,o.hash="",document.body.scrollTop=n,document.body.scrollLeft=a),this._saveSettings(t)}}}},{key:"setAccessToken",value:function(e){this._saveSettings({accessToken:e})}},{key:"setStorageKey",value:function(e){this.storageKey=e,this.setAccessToken(this.authentications["PureCloud OAuth"].accessToken)}},{key:"logout",value:function(e){this.hasLocalStorage&&this._saveSettings({accessToken:void 0,state:void 0,tokenExpiryTime:void 0,tokenExpiryTimeString:void 0});var i={client_id:encodeURIComponent(this.clientId)};e&&(i.redirect_uri=encodeURI(e));var t=this._buildAuthUrl("logout",i);window.location.replace(t)}},{key:"_buildAuthUrl",value:function(e,i){return i||(i={}),Object.keys(i).reduce(function(e,t){return i[t]?"".concat(e,"&").concat(t,"=").concat(i[t]):e},"".concat(this.config.authUrl,"/").concat(e,"?"))}},{key:"paramToString",value:function(e){return e?e instanceof Date?e.toJSON():e.toString():""}},{key:"serialize",value:function(e){var i={};for(var t in e)e.hasOwnProperty(t)&&void 0!==e[t]&&(i[encodeURIComponent(t)]=Array.isArray(e[t])?e[t].join(","):this.paramToString(e[t]));return i}},{key:"addHeaders",value:function(e){for(var i=arguments.length,t=new Array(i>1?i-1:0),n=1;n0?r-4:r;for(t=0;t>16&255,s[p++]=i>>8&255,s[p++]=255&i;2===l&&(i=a[e.charCodeAt(t)]<<2|a[e.charCodeAt(t+1)]>>4,s[p++]=255&i);1===l&&(i=a[e.charCodeAt(t)]<<10|a[e.charCodeAt(t+1)]<<4|a[e.charCodeAt(t+2)]>>2,s[p++]=i>>8&255,s[p++]=255&i);return s},t.fromByteArray=function(e){for(var i,t=e.length,a=t%3,o=[],r=0,l=t-a;rl?l:r+16383));1===a?(i=e[t-1],o.push(n[i>>2]+n[i<<4&63]+"==")):2===a&&(i=(e[t-2]<<8)+e[t-1],o.push(n[i>>10]+n[i>>4&63]+n[i<<2&63]+"="));return o.join("")};for(var n=[],a=[],o="undefined"!=typeof Uint8Array?Uint8Array:Array,r="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",l=0,s=r.length;l0)throw new Error("Invalid string. Length must be a multiple of 4");var t=e.indexOf("=");return-1===t&&(t=i),[t,t===i?0:4-t%4]}function p(e,i,t){for(var a,o,r=[],l=i;l>18&63]+n[o>>12&63]+n[o>>6&63]+n[63&o]);return r.join("")}a["-".charCodeAt(0)]=62,a["_".charCodeAt(0)]=63},{}],2:[function(e,i,t){},{}],3:[function(e,i,t){(function(i){(function(){"use strict";var i=e("base64-js"),n=e("ieee754");t.Buffer=r,t.SlowBuffer=function(e){+e!=e&&(e=0);return r.alloc(+e)},t.INSPECT_MAX_BYTES=50;var a=2147483647;function o(e){if(e>a)throw new RangeError('The value "'+e+'" is invalid for option "size"');var i=new Uint8Array(e);return i.__proto__=r.prototype,i}function r(e,i,t){if("number"==typeof e){if("string"==typeof i)throw new TypeError('The "string" argument must be of type string. Received type number');return u(e)}return l(e,i,t)}function l(e,i,t){if("string"==typeof e)return function(e,i){"string"==typeof i&&""!==i||(i="utf8");if(!r.isEncoding(i))throw new TypeError("Unknown encoding: "+i);var t=0|d(e,i),n=o(t),a=n.write(e,i);a!==t&&(n=n.slice(0,a));return n}(e,i);if(ArrayBuffer.isView(e))return p(e);if(null==e)throw TypeError("The first argument must be one of type string, Buffer, ArrayBuffer, Array, or Array-like Object. Received type "+typeof e);if(B(e,ArrayBuffer)||e&&B(e.buffer,ArrayBuffer))return function(e,i,t){if(i<0||e.byteLength=a)throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+a.toString(16)+" bytes");return 0|e}function d(e,i){if(r.isBuffer(e))return e.length;if(ArrayBuffer.isView(e)||B(e,ArrayBuffer))return e.byteLength;if("string"!=typeof e)throw new TypeError('The "string" argument must be one of type string, Buffer, or ArrayBuffer. Received type '+typeof e);var t=e.length,n=arguments.length>2&&!0===arguments[2];if(!n&&0===t)return 0;for(var a=!1;;)switch(i){case"ascii":case"latin1":case"binary":return t;case"utf8":case"utf-8":return R(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*t;case"hex":return t>>>1;case"base64":return D(e).length;default:if(a)return n?-1:R(e).length;i=(""+i).toLowerCase(),a=!0}}function g(e,i,t){var n=e[i];e[i]=e[t],e[t]=n}function h(e,i,t,n,a){if(0===e.length)return-1;if("string"==typeof t?(n=t,t=0):t>2147483647?t=2147483647:t<-2147483648&&(t=-2147483648),W(t=+t)&&(t=a?0:e.length-1),t<0&&(t=e.length+t),t>=e.length){if(a)return-1;t=e.length-1}else if(t<0){if(!a)return-1;t=0}if("string"==typeof i&&(i=r.from(i,n)),r.isBuffer(i))return 0===i.length?-1:m(e,i,t,n,a);if("number"==typeof i)return i&=255,"function"==typeof Uint8Array.prototype.indexOf?a?Uint8Array.prototype.indexOf.call(e,i,t):Uint8Array.prototype.lastIndexOf.call(e,i,t):m(e,[i],t,n,a);throw new TypeError("val must be string, number or Buffer")}function m(e,i,t,n,a){var o,r=1,l=e.length,s=i.length;if(void 0!==n&&("ucs2"===(n=String(n).toLowerCase())||"ucs-2"===n||"utf16le"===n||"utf-16le"===n)){if(e.length<2||i.length<2)return-1;r=2,l/=2,s/=2,t/=2}function u(e,i){return 1===r?e[i]:e.readUInt16BE(i*r)}if(a){var p=-1;for(o=t;ol&&(t=l-s),o=t;o>=0;o--){for(var c=!0,d=0;da&&(n=a):n=a;var o=i.length;n>o/2&&(n=o/2);for(var r=0;r>8,a=t%256,o.push(a),o.push(n);return o}(i,e.length-t),e,t,n)}function A(e,t,n){return 0===t&&n===e.length?i.fromByteArray(e):i.fromByteArray(e.slice(t,n))}function b(e,i,t){t=Math.min(e.length,t);for(var n=[],a=i;a239?4:u>223?3:u>191?2:1;if(a+c<=t)switch(c){case 1:u<128&&(p=u);break;case 2:128==(192&(o=e[a+1]))&&(s=(31&u)<<6|63&o)>127&&(p=s);break;case 3:o=e[a+1],r=e[a+2],128==(192&o)&&128==(192&r)&&(s=(15&u)<<12|(63&o)<<6|63&r)>2047&&(s<55296||s>57343)&&(p=s);break;case 4:o=e[a+1],r=e[a+2],l=e[a+3],128==(192&o)&&128==(192&r)&&128==(192&l)&&(s=(15&u)<<18|(63&o)<<12|(63&r)<<6|63&l)>65535&&s<1114112&&(p=s)}null===p?(p=65533,c=1):p>65535&&(p-=65536,n.push(p>>>10&1023|55296),p=56320|1023&p),n.push(p),a+=c}return function(e){var i=e.length;if(i<=j)return String.fromCharCode.apply(String,e);var t="",n=0;for(;nthis.length)return"";if((void 0===t||t>this.length)&&(t=this.length),t<=0)return"";if((t>>>=0)<=(i>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return O(this,i,t);case"utf8":case"utf-8":return b(this,i,t);case"ascii":return k(this,i,t);case"latin1":case"binary":return P(this,i,t);case"base64":return A(this,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return M(this,i,t);default:if(n)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),n=!0}}.apply(this,arguments)},r.prototype.toLocaleString=r.prototype.toString,r.prototype.equals=function(e){if(!r.isBuffer(e))throw new TypeError("Argument must be a Buffer");return this===e||0===r.compare(this,e)},r.prototype.inspect=function(){var e="",i=t.INSPECT_MAX_BYTES;return e=this.toString("hex",0,i).replace(/(.{2})/g,"$1 ").trim(),this.length>i&&(e+=" ... "),""},r.prototype.compare=function(e,i,t,n,a){if(B(e,Uint8Array)&&(e=r.from(e,e.offset,e.byteLength)),!r.isBuffer(e))throw new TypeError('The "target" argument must be one of type Buffer or Uint8Array. Received type '+typeof e);if(void 0===i&&(i=0),void 0===t&&(t=e?e.length:0),void 0===n&&(n=0),void 0===a&&(a=this.length),i<0||t>e.length||n<0||a>this.length)throw new RangeError("out of range index");if(n>=a&&i>=t)return 0;if(n>=a)return-1;if(i>=t)return 1;if(i>>>=0,t>>>=0,n>>>=0,a>>>=0,this===e)return 0;for(var o=a-n,l=t-i,s=Math.min(o,l),u=this.slice(n,a),p=e.slice(i,t),c=0;c>>=0,isFinite(t)?(t>>>=0,void 0===n&&(n="utf8")):(n=t,t=void 0)}var a=this.length-i;if((void 0===t||t>a)&&(t=a),e.length>0&&(t<0||i<0)||i>this.length)throw new RangeError("Attempt to write outside buffer bounds");n||(n="utf8");for(var o=!1;;)switch(n){case"hex":return v(this,e,i,t);case"utf8":case"utf-8":return f(this,e,i,t);case"ascii":return w(this,e,i,t);case"latin1":case"binary":return y(this,e,i,t);case"base64":return C(this,e,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return I(this,e,i,t);default:if(o)throw new TypeError("Unknown encoding: "+n);n=(""+n).toLowerCase(),o=!0}},r.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var j=4096;function k(e,i,t){var n="";t=Math.min(e.length,t);for(var a=i;an)&&(t=n);for(var a="",o=i;ot)throw new RangeError("Trying to access beyond buffer length")}function q(e,i,t,n,a,o){if(!r.isBuffer(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(i>a||ie.length)throw new RangeError("Index out of range")}function S(e,i,t,n,a,o){if(t+n>e.length)throw new RangeError("Index out of range");if(t<0)throw new RangeError("Index out of range")}function E(e,i,t,a,o){return i=+i,t>>>=0,o||S(e,0,t,4),n.write(e,i,t,a,23,4),t+4}function G(e,i,t,a,o){return i=+i,t>>>=0,o||S(e,0,t,8),n.write(e,i,t,a,52,8),t+8}r.prototype.slice=function(e,i){var t=this.length;e=~~e,i=void 0===i?t:~~i,e<0?(e+=t)<0&&(e=0):e>t&&(e=t),i<0?(i+=t)<0&&(i=0):i>t&&(i=t),i>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e],a=1,o=0;++o>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e+--i],a=1;i>0&&(a*=256);)n+=this[e+--i]*a;return n},r.prototype.readUInt8=function(e,i){return e>>>=0,i||T(e,1,this.length),this[e]},r.prototype.readUInt16LE=function(e,i){return e>>>=0,i||T(e,2,this.length),this[e]|this[e+1]<<8},r.prototype.readUInt16BE=function(e,i){return e>>>=0,i||T(e,2,this.length),this[e]<<8|this[e+1]},r.prototype.readUInt32LE=function(e,i){return e>>>=0,i||T(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},r.prototype.readUInt32BE=function(e,i){return e>>>=0,i||T(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},r.prototype.readIntLE=function(e,i,t){e>>>=0,i>>>=0,t||T(e,i,this.length);for(var n=this[e],a=1,o=0;++o=(a*=128)&&(n-=Math.pow(2,8*i)),n},r.prototype.readIntBE=function(e,i,t){e>>>=0,i>>>=0,t||T(e,i,this.length);for(var n=i,a=1,o=this[e+--n];n>0&&(a*=256);)o+=this[e+--n]*a;return o>=(a*=128)&&(o-=Math.pow(2,8*i)),o},r.prototype.readInt8=function(e,i){return e>>>=0,i||T(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},r.prototype.readInt16LE=function(e,i){e>>>=0,i||T(e,2,this.length);var t=this[e]|this[e+1]<<8;return 32768&t?4294901760|t:t},r.prototype.readInt16BE=function(e,i){e>>>=0,i||T(e,2,this.length);var t=this[e+1]|this[e]<<8;return 32768&t?4294901760|t:t},r.prototype.readInt32LE=function(e,i){return e>>>=0,i||T(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},r.prototype.readInt32BE=function(e,i){return e>>>=0,i||T(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},r.prototype.readFloatLE=function(e,i){return e>>>=0,i||T(e,4,this.length),n.read(this,e,!0,23,4)},r.prototype.readFloatBE=function(e,i){return e>>>=0,i||T(e,4,this.length),n.read(this,e,!1,23,4)},r.prototype.readDoubleLE=function(e,i){return e>>>=0,i||T(e,8,this.length),n.read(this,e,!0,52,8)},r.prototype.readDoubleBE=function(e,i){return e>>>=0,i||T(e,8,this.length),n.read(this,e,!1,52,8)},r.prototype.writeUIntLE=function(e,i,t,n){(e=+e,i>>>=0,t>>>=0,n)||q(this,e,i,t,Math.pow(2,8*t)-1,0);var a=1,o=0;for(this[i]=255&e;++o>>=0,t>>>=0,n)||q(this,e,i,t,Math.pow(2,8*t)-1,0);var a=t-1,o=1;for(this[i+a]=255&e;--a>=0&&(o*=256);)this[i+a]=e/o&255;return i+t},r.prototype.writeUInt8=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,1,255,0),this[i]=255&e,i+1},r.prototype.writeUInt16LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,65535,0),this[i]=255&e,this[i+1]=e>>>8,i+2},r.prototype.writeUInt16BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,65535,0),this[i]=e>>>8,this[i+1]=255&e,i+2},r.prototype.writeUInt32LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,4294967295,0),this[i+3]=e>>>24,this[i+2]=e>>>16,this[i+1]=e>>>8,this[i]=255&e,i+4},r.prototype.writeUInt32BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,4294967295,0),this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e,i+4},r.prototype.writeIntLE=function(e,i,t,n){if(e=+e,i>>>=0,!n){var a=Math.pow(2,8*t-1);q(this,e,i,t,a-1,-a)}var o=0,r=1,l=0;for(this[i]=255&e;++o>0)-l&255;return i+t},r.prototype.writeIntBE=function(e,i,t,n){if(e=+e,i>>>=0,!n){var a=Math.pow(2,8*t-1);q(this,e,i,t,a-1,-a)}var o=t-1,r=1,l=0;for(this[i+o]=255&e;--o>=0&&(r*=256);)e<0&&0===l&&0!==this[i+o+1]&&(l=1),this[i+o]=(e/r>>0)-l&255;return i+t},r.prototype.writeInt8=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,1,127,-128),e<0&&(e=255+e+1),this[i]=255&e,i+1},r.prototype.writeInt16LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,32767,-32768),this[i]=255&e,this[i+1]=e>>>8,i+2},r.prototype.writeInt16BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,2,32767,-32768),this[i]=e>>>8,this[i+1]=255&e,i+2},r.prototype.writeInt32LE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,2147483647,-2147483648),this[i]=255&e,this[i+1]=e>>>8,this[i+2]=e>>>16,this[i+3]=e>>>24,i+4},r.prototype.writeInt32BE=function(e,i,t){return e=+e,i>>>=0,t||q(this,e,i,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e,i+4},r.prototype.writeFloatLE=function(e,i,t){return E(this,e,i,!0,t)},r.prototype.writeFloatBE=function(e,i,t){return E(this,e,i,!1,t)},r.prototype.writeDoubleLE=function(e,i,t){return G(this,e,i,!0,t)},r.prototype.writeDoubleBE=function(e,i,t){return G(this,e,i,!1,t)},r.prototype.copy=function(e,i,t,n){if(!r.isBuffer(e))throw new TypeError("argument should be a Buffer");if(t||(t=0),n||0===n||(n=this.length),i>=e.length&&(i=e.length),i||(i=0),n>0&&n=this.length)throw new RangeError("Index out of range");if(n<0)throw new RangeError("sourceEnd out of bounds");n>this.length&&(n=this.length),e.length-i=0;--o)e[o+i]=this[o+t];else Uint8Array.prototype.set.call(e,this.subarray(t,n),i);return a},r.prototype.fill=function(e,i,t,n){if("string"==typeof e){if("string"==typeof i?(n=i,i=0,t=this.length):"string"==typeof t&&(n=t,t=this.length),void 0!==n&&"string"!=typeof n)throw new TypeError("encoding must be a string");if("string"==typeof n&&!r.isEncoding(n))throw new TypeError("Unknown encoding: "+n);if(1===e.length){var a=e.charCodeAt(0);("utf8"===n&&a<128||"latin1"===n)&&(e=a)}}else"number"==typeof e&&(e&=255);if(i<0||this.length>>=0,t=void 0===t?this.length:t>>>0,e||(e=0),"number"==typeof e)for(o=i;o55295&&t<57344){if(!a){if(t>56319){(i-=3)>-1&&o.push(239,191,189);continue}if(r+1===n){(i-=3)>-1&&o.push(239,191,189);continue}a=t;continue}if(t<56320){(i-=3)>-1&&o.push(239,191,189),a=t;continue}t=65536+(a-55296<<10|t-56320)}else a&&(i-=3)>-1&&o.push(239,191,189);if(a=null,t<128){if((i-=1)<0)break;o.push(t)}else if(t<2048){if((i-=2)<0)break;o.push(t>>6|192,63&t|128)}else if(t<65536){if((i-=3)<0)break;o.push(t>>12|224,t>>6&63|128,63&t|128)}else{if(!(t<1114112))throw new Error("Invalid code point");if((i-=4)<0)break;o.push(t>>18|240,t>>12&63|128,t>>6&63|128,63&t|128)}}return o}function D(e){return i.toByteArray(function(e){if((e=(e=e.split("=")[0]).trim().replace(U,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function z(e,i,t,n){for(var a=0;a=i.length||a>=e.length);++a)i[a+t]=e[a];return a}function B(e,i){return e instanceof i||null!=e&&null!=e.constructor&&null!=e.constructor.name&&e.constructor.name===i.name}function W(e){return e!=e}}).call(this)}).call(this,e("buffer").Buffer)},{"base64-js":1,buffer:3,ieee754:4}],4:[function(e,i,t){t.read=function(e,i,t,n,a){var o,r,l=8*a-n-1,s=(1<>1,p=-7,c=t?a-1:0,d=t?-1:1,g=e[i+c];for(c+=d,o=g&(1<<-p)-1,g>>=-p,p+=l;p>0;o=256*o+e[i+c],c+=d,p-=8);for(r=o&(1<<-p)-1,o>>=-p,p+=n;p>0;r=256*r+e[i+c],c+=d,p-=8);if(0===o)o=1-u;else{if(o===s)return r?NaN:1/0*(g?-1:1);r+=Math.pow(2,n),o-=u}return(g?-1:1)*r*Math.pow(2,o-n)},t.write=function(e,i,t,n,a,o){var r,l,s,u=8*o-a-1,p=(1<>1,d=23===a?Math.pow(2,-24)-Math.pow(2,-77):0,g=n?0:o-1,h=n?1:-1,m=i<0||0===i&&1/i<0?1:0;for(i=Math.abs(i),isNaN(i)||i===1/0?(l=isNaN(i)?1:0,r=p):(r=Math.floor(Math.log(i)/Math.LN2),i*(s=Math.pow(2,-r))<1&&(r--,s*=2),(i+=r+c>=1?d/s:d*Math.pow(2,1-c))*s>=2&&(r++,s/=2),r+c>=p?(l=0,r=p):r+c>=1?(l=(i*s-1)*Math.pow(2,a),r+=c):(l=i*Math.pow(2,c-1)*Math.pow(2,a),r=0));a>=8;e[t+g]=255&l,g+=h,l/=256,a-=8);for(r=r<0;e[t+g]=255&r,g+=h,r/=256,u-=8);e[t+g-h]|=128*m}},{}],5:[function(e,i,t){t.endianness=function(){return"LE"},t.hostname=function(){return"undefined"!=typeof location?location.hostname:""},t.loadavg=function(){return[]},t.uptime=function(){return 0},t.freemem=function(){return Number.MAX_VALUE},t.totalmem=function(){return Number.MAX_VALUE},t.cpus=function(){return[]},t.type=function(){return"Browser"},t.release=function(){return"undefined"!=typeof navigator?navigator.appVersion:""},t.networkInterfaces=t.getNetworkInterfaces=function(){return{}},t.arch=function(){return"javascript"},t.platform=function(){return"browser"},t.tmpdir=t.tmpDir=function(){return"/tmp"},t.EOL="\n",t.homedir=function(){return"/"}},{}],6:[function(e,i,t){(function(e){(function(){"use strict";function t(e){if("string"!=typeof e)throw new TypeError("Path must be a string. Received "+JSON.stringify(e))}function n(e,i){for(var t,n="",a=0,o=-1,r=0,l=0;l<=e.length;++l){if(l2){var s=n.lastIndexOf("/");if(s!==n.length-1){-1===s?(n="",a=0):a=(n=n.slice(0,s)).length-1-n.lastIndexOf("/"),o=l,r=0;continue}}else if(2===n.length||1===n.length){n="",a=0,o=l,r=0;continue}i&&(n.length>0?n+="/..":n="..",a=2)}else n.length>0?n+="/"+e.slice(o+1,l):n=e.slice(o+1,l),a=l-o-1;o=l,r=0}else 46===t&&-1!==r?++r:r=-1}return n}var a={resolve:function(){for(var i,a="",o=!1,r=arguments.length-1;r>=-1&&!o;r--){var l;r>=0?l=arguments[r]:(void 0===i&&(i=e.cwd()),l=i),t(l),0!==l.length&&(a=l+"/"+a,o=47===l.charCodeAt(0))}return a=n(a,!o),o?a.length>0?"/"+a:"/":a.length>0?a:"."},normalize:function(e){if(t(e),0===e.length)return".";var i=47===e.charCodeAt(0),a=47===e.charCodeAt(e.length-1);return 0!==(e=n(e,!i)).length||i||(e="."),e.length>0&&a&&(e+="/"),i?"/"+e:e},isAbsolute:function(e){return t(e),e.length>0&&47===e.charCodeAt(0)},join:function(){if(0===arguments.length)return".";for(var e,i=0;i0&&(void 0===e?e=n:e+="/"+n)}return void 0===e?".":a.normalize(e)},relative:function(e,i){if(t(e),t(i),e===i)return"";if((e=a.resolve(e))===(i=a.resolve(i)))return"";for(var n=1;nu){if(47===i.charCodeAt(l+c))return i.slice(l+c+1);if(0===c)return i.slice(l+c)}else r>u&&(47===e.charCodeAt(n+c)?p=c:0===c&&(p=0));break}var d=e.charCodeAt(n+c);if(d!==i.charCodeAt(l+c))break;47===d&&(p=c)}var g="";for(c=n+p+1;c<=o;++c)c!==o&&47!==e.charCodeAt(c)||(0===g.length?g+="..":g+="/..");return g.length>0?g+i.slice(l+p):(l+=p,47===i.charCodeAt(l)&&++l,i.slice(l))},_makeLong:function(e){return e},dirname:function(e){if(t(e),0===e.length)return".";for(var i=e.charCodeAt(0),n=47===i,a=-1,o=!0,r=e.length-1;r>=1;--r)if(47===(i=e.charCodeAt(r))){if(!o){a=r;break}}else o=!1;return-1===a?n?"/":".":n&&1===a?"//":e.slice(0,a)},basename:function(e,i){if(void 0!==i&&"string"!=typeof i)throw new TypeError('"ext" argument must be a string');t(e);var n,a=0,o=-1,r=!0;if(void 0!==i&&i.length>0&&i.length<=e.length){if(i.length===e.length&&i===e)return"";var l=i.length-1,s=-1;for(n=e.length-1;n>=0;--n){var u=e.charCodeAt(n);if(47===u){if(!r){a=n+1;break}}else-1===s&&(r=!1,s=n+1),l>=0&&(u===i.charCodeAt(l)?-1==--l&&(o=n):(l=-1,o=s))}return a===o?o=s:-1===o&&(o=e.length),e.slice(a,o)}for(n=e.length-1;n>=0;--n)if(47===e.charCodeAt(n)){if(!r){a=n+1;break}}else-1===o&&(r=!1,o=n+1);return-1===o?"":e.slice(a,o)},extname:function(e){t(e);for(var i=-1,n=0,a=-1,o=!0,r=0,l=e.length-1;l>=0;--l){var s=e.charCodeAt(l);if(47!==s)-1===a&&(o=!1,a=l+1),46===s?-1===i?i=l:1!==r&&(r=1):-1!==i&&(r=-1);else if(!o){n=l+1;break}}return-1===i||-1===a||0===r||1===r&&i===a-1&&i===n+1?"":e.slice(i,a)},format:function(e){if(null===e||"object"!=typeof e)throw new TypeError('The "pathObject" argument must be of type Object. Received type '+typeof e);return function(e,i){var t=i.dir||i.root,n=i.base||(i.name||"")+(i.ext||"");return t?t===i.root?t+n:t+e+n:n}("/",e)},parse:function(e){t(e);var i={root:"",dir:"",base:"",ext:"",name:""};if(0===e.length)return i;var n,a=e.charCodeAt(0),o=47===a;o?(i.root="/",n=1):n=0;for(var r=-1,l=0,s=-1,u=!0,p=e.length-1,c=0;p>=n;--p)if(47!==(a=e.charCodeAt(p)))-1===s&&(u=!1,s=p+1),46===a?-1===r?r=p:1!==c&&(c=1):-1!==r&&(c=-1);else if(!u){l=p+1;break}return-1===r||-1===s||0===c||1===c&&r===s-1&&r===l+1?-1!==s&&(i.base=i.name=0===l&&o?e.slice(1,s):e.slice(l,s)):(0===l&&o?(i.name=e.slice(1,r),i.base=e.slice(1,s)):(i.name=e.slice(l,r),i.base=e.slice(l,s)),i.ext=e.slice(r,s)),l>0?i.dir=e.slice(0,l-1):o&&(i.dir="/"),i},sep:"/",delimiter:":",win32:null,posix:null};a.posix=a,i.exports=a}).call(this)}).call(this,e("_process"))},{_process:7}],7:[function(e,i,t){var n,a,o=i.exports={};function r(){throw new Error("setTimeout has not been defined")}function l(){throw new Error("clearTimeout has not been defined")}function s(e){if(n===setTimeout)return setTimeout(e,0);if((n===r||!n)&&setTimeout)return n=setTimeout,setTimeout(e,0);try{return n(e,0)}catch(i){try{return n.call(null,e,0)}catch(i){return n.call(this,e,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:r}catch(e){n=r}try{a="function"==typeof clearTimeout?clearTimeout:l}catch(e){a=l}}();var u,p=[],c=!1,d=-1;function g(){c&&u&&(c=!1,u.length?p=u.concat(p):d=-1,p.length&&h())}function h(){if(!c){var e=s(g);c=!0;for(var i=p.length;i;){for(u=p,p=[];++d1)for(var t=1;t-1?a(t):t}},{"./":9,"get-intrinsic":21}],9:[function(e,i,t){"use strict";var n=e("function-bind"),a=e("get-intrinsic"),o=e("set-function-length"),r=e("es-errors/type"),l=a("%Function.prototype.apply%"),s=a("%Function.prototype.call%"),u=a("%Reflect.apply%",!0)||n.call(s,l),p=e("es-define-property"),c=a("%Math.max%");i.exports=function(e){if("function"!=typeof e)throw new r("a function is required");var i=u(n,s,arguments);return o(i,1+c(0,e.length-(arguments.length-1)),!0)};var d=function(){return u(n,l,arguments)};p?p(i.exports,"apply",{value:d}):i.exports.apply=d},{"es-define-property":11,"es-errors/type":17,"function-bind":20,"get-intrinsic":21,"set-function-length":34}],10:[function(e,i,t){"use strict";var n=e("es-define-property"),a=e("es-errors/syntax"),o=e("es-errors/type"),r=e("gopd");i.exports=function(e,i,t){if(!e||"object"!=typeof e&&"function"!=typeof e)throw new o("`obj` must be an object or a function`");if("string"!=typeof i&&"symbol"!=typeof i)throw new o("`property` must be a string or a symbol`");if(arguments.length>3&&"boolean"!=typeof arguments[3]&&null!==arguments[3])throw new o("`nonEnumerable`, if provided, must be a boolean or null");if(arguments.length>4&&"boolean"!=typeof arguments[4]&&null!==arguments[4])throw new o("`nonWritable`, if provided, must be a boolean or null");if(arguments.length>5&&"boolean"!=typeof arguments[5]&&null!==arguments[5])throw new o("`nonConfigurable`, if provided, must be a boolean or null");if(arguments.length>6&&"boolean"!=typeof arguments[6])throw new o("`loose`, if provided, must be a boolean");var l=arguments.length>3?arguments[3]:null,s=arguments.length>4?arguments[4]:null,u=arguments.length>5?arguments[5]:null,p=arguments.length>6&&arguments[6],c=!!r&&r(e,i);if(n)n(e,i,{configurable:null===u&&c?c.configurable:!u,enumerable:null===l&&c?c.enumerable:!l,value:t,writable:null===s&&c?c.writable:!s});else{if(!p&&(l||s||u))throw new a("This environment does not support defining a property as non-configurable, non-writable, or non-enumerable.");e[i]=t}}},{"es-define-property":11,"es-errors/syntax":16,"es-errors/type":17,gopd:22}],11:[function(e,i,t){"use strict";var n=e("get-intrinsic")("%Object.defineProperty%",!0)||!1;if(n)try{n({},"a",{value:1})}catch(e){n=!1}i.exports=n},{"get-intrinsic":21}],12:[function(e,i,t){"use strict";i.exports=EvalError},{}],13:[function(e,i,t){"use strict";i.exports=Error},{}],14:[function(e,i,t){"use strict";i.exports=RangeError},{}],15:[function(e,i,t){"use strict";i.exports=ReferenceError},{}],16:[function(e,i,t){"use strict";i.exports=SyntaxError},{}],17:[function(e,i,t){"use strict";i.exports=TypeError},{}],18:[function(e,i,t){"use strict";i.exports=URIError},{}],19:[function(e,i,t){"use strict";var n=Object.prototype.toString,a=Math.max,o=function(e,i){for(var t=[],n=0;n1&&"boolean"!=typeof i)throw new s('"allowMissing" argument must be a boolean');if(null===T(/^%?[^%]*%?$/,e))throw new l("`%` may not be present anywhere but at the beginning and end of the intrinsic name");var t=function(e){var i=M(e,0,1),t=M(e,-1);if("%"===i&&"%"!==t)throw new l("invalid intrinsic syntax, expected closing `%`");if("%"===t&&"%"!==i)throw new l("invalid intrinsic syntax, expected opening `%`");var n=[];return O(e,q,function(e,i,t,a){n[n.length]=t?O(a,S,"$1"):i||e}),n}(e),n=t.length>0?t[0]:"",a=E("%"+n+"%",i),o=a.name,r=a.value,u=!1,p=a.alias;p&&(n=p[0],P(t,k([0,1],p)));for(var c=1,g=!0;c=t.length){var f=d(r,h);r=(g=!!f)&&"get"in f&&!("originalValue"in f.get)?f.get:r[h]}else g=j(r,h),r=r[h];g&&!u&&(C[o]=r)}}return r}},{"es-errors":13,"es-errors/eval":12,"es-errors/range":14,"es-errors/ref":15,"es-errors/syntax":16,"es-errors/type":17,"es-errors/uri":18,"function-bind":20,"has-proto":24,"has-symbols":25,hasown:27}],22:[function(e,i,t){"use strict";var n=e("get-intrinsic")("%Object.getOwnPropertyDescriptor%",!0);if(n)try{n([],"length")}catch(e){n=null}i.exports=n},{"get-intrinsic":21}],23:[function(e,i,t){"use strict";var n=e("es-define-property"),a=function(){return!!n};a.hasArrayLengthDefineBug=function(){if(!n)return null;try{return 1!==n([],"length",{value:1}).length}catch(e){return!0}},i.exports=a},{"es-define-property":11}],24:[function(e,i,t){"use strict";var n={__proto__:null,foo:{}},a=Object;i.exports=function(){return{__proto__:n}.foo===n.foo&&!(n instanceof a)}},{}],25:[function(e,i,t){"use strict";var n="undefined"!=typeof Symbol&&Symbol,a=e("./shams");i.exports=function(){return"function"==typeof n&&("function"==typeof Symbol&&("symbol"==typeof n("foo")&&("symbol"==typeof Symbol("bar")&&a())))}},{"./shams":26}],26:[function(e,i,t){"use strict";i.exports=function(){if("function"!=typeof Symbol||"function"!=typeof Object.getOwnPropertySymbols)return!1;if("symbol"==typeof Symbol.iterator)return!0;var e={},i=Symbol("test"),t=Object(i);if("string"==typeof i)return!1;if("[object Symbol]"!==Object.prototype.toString.call(i))return!1;if("[object Symbol]"!==Object.prototype.toString.call(t))return!1;for(i in e[i]=42,e)return!1;if("function"==typeof Object.keys&&0!==Object.keys(e).length)return!1;if("function"==typeof Object.getOwnPropertyNames&&0!==Object.getOwnPropertyNames(e).length)return!1;var n=Object.getOwnPropertySymbols(e);if(1!==n.length||n[0]!==i)return!1;if(!Object.prototype.propertyIsEnumerable.call(e,i))return!1;if("function"==typeof Object.getOwnPropertyDescriptor){var a=Object.getOwnPropertyDescriptor(e,i);if(42!==a.value||!0!==a.enumerable)return!1}return!0}},{}],27:[function(e,i,t){"use strict";var n=Function.prototype.call,a=Object.prototype.hasOwnProperty,o=e("function-bind");i.exports=o.call(n,a)},{"function-bind":20}],28:[function(e,i,t){(function(t){(function(){var n="function"==typeof Map&&Map.prototype,a=Object.getOwnPropertyDescriptor&&n?Object.getOwnPropertyDescriptor(Map.prototype,"size"):null,o=n&&a&&"function"==typeof a.get?a.get:null,r=n&&Map.prototype.forEach,l="function"==typeof Set&&Set.prototype,s=Object.getOwnPropertyDescriptor&&l?Object.getOwnPropertyDescriptor(Set.prototype,"size"):null,u=l&&s&&"function"==typeof s.get?s.get:null,p=l&&Set.prototype.forEach,c="function"==typeof WeakMap&&WeakMap.prototype?WeakMap.prototype.has:null,d="function"==typeof WeakSet&&WeakSet.prototype?WeakSet.prototype.has:null,g="function"==typeof WeakRef&&WeakRef.prototype?WeakRef.prototype.deref:null,h=Boolean.prototype.valueOf,m=Object.prototype.toString,v=Function.prototype.toString,f=String.prototype.match,w=String.prototype.slice,y=String.prototype.replace,C=String.prototype.toUpperCase,I=String.prototype.toLowerCase,A=RegExp.prototype.test,b=Array.prototype.concat,j=Array.prototype.join,k=Array.prototype.slice,P=Math.floor,O="function"==typeof BigInt?BigInt.prototype.valueOf:null,M=Object.getOwnPropertySymbols,T="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?Symbol.prototype.toString:null,q="function"==typeof Symbol&&"object"==typeof Symbol.iterator,S="function"==typeof Symbol&&Symbol.toStringTag&&(typeof Symbol.toStringTag===q||"symbol")?Symbol.toStringTag:null,E=Object.prototype.propertyIsEnumerable,G=("function"==typeof Reflect?Reflect.getPrototypeOf:Object.getPrototypeOf)||([].__proto__===Array.prototype?function(e){return e.__proto__}:null);function U(e,i){if(e===1/0||e===-1/0||e!=e||e&&e>-1e3&&e<1e3||A.call(/e/,i))return i;var t=/[0-9](?=(?:[0-9]{3})+(?![0-9]))/g;if("number"==typeof e){var n=e<0?-P(-e):P(e);if(n!==e){var a=String(n),o=w.call(i,a.length+1);return y.call(a,t,"$&_")+"."+y.call(y.call(o,/([0-9]{3})/g,"$&_"),/_$/,"")}}return y.call(i,t,"$&_")}var x=e("./util.inspect"),R=x.custom,D=N(R)?R:null;function z(e,i,t){var n="double"===(t.quoteStyle||i)?'"':"'";return n+e+n}function B(e){return y.call(String(e),/"/g,""")}function W(e){return!("[object Array]"!==J(e)||S&&"object"==typeof e&&S in e)}function L(e){return!("[object RegExp]"!==J(e)||S&&"object"==typeof e&&S in e)}function N(e){if(q)return e&&"object"==typeof e&&e instanceof Symbol;if("symbol"==typeof e)return!0;if(!e||"object"!=typeof e||!T)return!1;try{return T.call(e),!0}catch(e){}return!1}i.exports=function e(i,n,a,l){var s=n||{};if(F(s,"quoteStyle")&&"single"!==s.quoteStyle&&"double"!==s.quoteStyle)throw new TypeError('option "quoteStyle" must be "single" or "double"');if(F(s,"maxStringLength")&&("number"==typeof s.maxStringLength?s.maxStringLength<0&&s.maxStringLength!==1/0:null!==s.maxStringLength))throw new TypeError('option "maxStringLength", if provided, must be a positive integer, Infinity, or `null`');var m=!F(s,"customInspect")||s.customInspect;if("boolean"!=typeof m&&"symbol"!==m)throw new TypeError("option \"customInspect\", if provided, must be `true`, `false`, or `'symbol'`");if(F(s,"indent")&&null!==s.indent&&"\t"!==s.indent&&!(parseInt(s.indent,10)===s.indent&&s.indent>0))throw new TypeError('option "indent" must be "\\t", an integer > 0, or `null`');if(F(s,"numericSeparator")&&"boolean"!=typeof s.numericSeparator)throw new TypeError('option "numericSeparator", if provided, must be `true` or `false`');var C=s.numericSeparator;if(void 0===i)return"undefined";if(null===i)return"null";if("boolean"==typeof i)return i?"true":"false";if("string"==typeof i)return function e(i,t){if(i.length>t.maxStringLength){var n=i.length-t.maxStringLength,a="... "+n+" more character"+(n>1?"s":"");return e(w.call(i,0,t.maxStringLength),t)+a}var o=y.call(y.call(i,/(['\\])/g,"\\$1"),/[\x00-\x1f]/g,_);return z(o,"single",t)}(i,s);if("number"==typeof i){if(0===i)return 1/0/i>0?"0":"-0";var A=String(i);return C?U(i,A):A}if("bigint"==typeof i){var P=String(i)+"n";return C?U(i,P):P}var M=void 0===s.depth?5:s.depth;if(void 0===a&&(a=0),a>=M&&M>0&&"object"==typeof i)return W(i)?"[Array]":"[Object]";var R=function(e,i){var t;if("\t"===e.indent)t="\t";else{if(!("number"==typeof e.indent&&e.indent>0))return null;t=j.call(Array(e.indent+1)," ")}return{base:t,prev:j.call(Array(i+1),t)}}(s,a);if(void 0===l)l=[];else if(V(l,i)>=0)return"[Circular]";function K(i,t,n){if(t&&(l=k.call(l)).push(t),n){var o={depth:s.depth};return F(s,"quoteStyle")&&(o.quoteStyle=s.quoteStyle),e(i,o,a+1,l)}return e(i,s,a+1,l)}if("function"==typeof i&&!L(i)){var X=function(e){if(e.name)return e.name;var i=f.call(v.call(e),/^function\s*([\w$]+)/);if(i)return i[1];return null}(i),ee=Z(i,K);return"[Function"+(X?": "+X:" (anonymous)")+"]"+(ee.length>0?" { "+j.call(ee,", ")+" }":"")}if(N(i)){var ie=q?y.call(String(i),/^(Symbol\(.*\))_[^)]*$/,"$1"):T.call(i);return"object"!=typeof i||q?ie:Q(ie)}if(function(e){if(!e||"object"!=typeof e)return!1;if("undefined"!=typeof HTMLElement&&e instanceof HTMLElement)return!0;return"string"==typeof e.nodeName&&"function"==typeof e.getAttribute}(i)){for(var te="<"+I.call(String(i.nodeName)),ne=i.attributes||[],ae=0;ae"}if(W(i)){if(0===i.length)return"[]";var oe=Z(i,K);return R&&!function(e){for(var i=0;i=0)return!1;return!0}(oe)?"["+$(oe,R)+"]":"[ "+j.call(oe,", ")+" ]"}if(function(e){return!("[object Error]"!==J(e)||S&&"object"==typeof e&&S in e)}(i)){var re=Z(i,K);return"cause"in Error.prototype||!("cause"in i)||E.call(i,"cause")?0===re.length?"["+String(i)+"]":"{ ["+String(i)+"] "+j.call(re,", ")+" }":"{ ["+String(i)+"] "+j.call(b.call("[cause]: "+K(i.cause),re),", ")+" }"}if("object"==typeof i&&m){if(D&&"function"==typeof i[D]&&x)return x(i,{depth:M-a});if("symbol"!==m&&"function"==typeof i.inspect)return i.inspect()}if(function(e){if(!o||!e||"object"!=typeof e)return!1;try{o.call(e);try{u.call(e)}catch(e){return!0}return e instanceof Map}catch(e){}return!1}(i)){var le=[];return r&&r.call(i,function(e,t){le.push(K(t,i,!0)+" => "+K(e,i))}),Y("Map",o.call(i),le,R)}if(function(e){if(!u||!e||"object"!=typeof e)return!1;try{u.call(e);try{o.call(e)}catch(e){return!0}return e instanceof Set}catch(e){}return!1}(i)){var se=[];return p&&p.call(i,function(e){se.push(K(e,i))}),Y("Set",u.call(i),se,R)}if(function(e){if(!c||!e||"object"!=typeof e)return!1;try{c.call(e,c);try{d.call(e,d)}catch(e){return!0}return e instanceof WeakMap}catch(e){}return!1}(i))return H("WeakMap");if(function(e){if(!d||!e||"object"!=typeof e)return!1;try{d.call(e,d);try{c.call(e,c)}catch(e){return!0}return e instanceof WeakSet}catch(e){}return!1}(i))return H("WeakSet");if(function(e){if(!g||!e||"object"!=typeof e)return!1;try{return g.call(e),!0}catch(e){}return!1}(i))return H("WeakRef");if(function(e){return!("[object Number]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(K(Number(i)));if(function(e){if(!e||"object"!=typeof e||!O)return!1;try{return O.call(e),!0}catch(e){}return!1}(i))return Q(K(O.call(i)));if(function(e){return!("[object Boolean]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(h.call(i));if(function(e){return!("[object String]"!==J(e)||S&&"object"==typeof e&&S in e)}(i))return Q(K(String(i)));if("undefined"!=typeof window&&i===window)return"{ [object Window] }";if(i===t)return"{ [object globalThis] }";if(!function(e){return!("[object Date]"!==J(e)||S&&"object"==typeof e&&S in e)}(i)&&!L(i)){var ue=Z(i,K),pe=G?G(i)===Object.prototype:i instanceof Object||i.constructor===Object,ce=i instanceof Object?"":"null prototype",de=!pe&&S&&Object(i)===i&&S in i?w.call(J(i),8,-1):ce?"Object":"",ge=(pe||"function"!=typeof i.constructor?"":i.constructor.name?i.constructor.name+" ":"")+(de||ce?"["+j.call(b.call([],de||[],ce||[]),": ")+"] ":"");return 0===ue.length?ge+"{}":R?ge+"{"+$(ue,R)+"}":ge+"{ "+j.call(ue,", ")+" }"}return String(i)};var K=Object.prototype.hasOwnProperty||function(e){return e in this};function F(e,i){return K.call(e,i)}function J(e){return m.call(e)}function V(e,i){if(e.indexOf)return e.indexOf(i);for(var t=0,n=e.length;t-1?e.split(","):e},u=function(e,i,t,n){if(e){var o=t.allowDots?e.replace(/\.([^.[]+)/g,"[$1]"):e,r=/(\[[^[\]]*])/g,l=t.depth>0&&/(\[[^[\]]*])/.exec(o),u=l?o.slice(0,l.index):o,p=[];if(u){if(!t.plainObjects&&a.call(Object.prototype,u)&&!t.allowPrototypes)return;p.push(u)}for(var c=0;t.depth>0&&null!==(l=r.exec(o))&&c=0;--o){var r,l=e[o];if("[]"===l&&t.parseArrays)r=t.allowEmptyArrays&&""===a?[]:[].concat(a);else{r=t.plainObjects?Object.create(null):{};var u="["===l.charAt(0)&&"]"===l.charAt(l.length-1)?l.slice(1,-1):l,p=t.decodeDotInKeys?u.replace(/%2E/g,"."):u,c=parseInt(p,10);t.parseArrays||""!==p?!isNaN(c)&&l!==p&&String(c)===p&&c>=0&&t.parseArrays&&c<=t.arrayLimit?(r=[])[c]=a:"__proto__"!==p&&(r[p]=a):r={0:a}}a=r}return a}(p,i,t,n)}};i.exports=function(e,i){var t=function(e){if(!e)return r;if(void 0!==e.allowEmptyArrays&&"boolean"!=typeof e.allowEmptyArrays)throw new TypeError("`allowEmptyArrays` option can only be `true` or `false`, when provided");if(void 0!==e.decodeDotInKeys&&"boolean"!=typeof e.decodeDotInKeys)throw new TypeError("`decodeDotInKeys` option can only be `true` or `false`, when provided");if(null!==e.decoder&&void 0!==e.decoder&&"function"!=typeof e.decoder)throw new TypeError("Decoder has to be a function.");if(void 0!==e.charset&&"utf-8"!==e.charset&&"iso-8859-1"!==e.charset)throw new TypeError("The charset option must be either utf-8, iso-8859-1, or undefined");var i=void 0===e.charset?r.charset:e.charset,t=void 0===e.duplicates?r.duplicates:e.duplicates;if("combine"!==t&&"first"!==t&&"last"!==t)throw new TypeError("The duplicates option must be either combine, first, or last");return{allowDots:void 0===e.allowDots?!0===e.decodeDotInKeys||r.allowDots:!!e.allowDots,allowEmptyArrays:"boolean"==typeof e.allowEmptyArrays?!!e.allowEmptyArrays:r.allowEmptyArrays,allowPrototypes:"boolean"==typeof e.allowPrototypes?e.allowPrototypes:r.allowPrototypes,allowSparse:"boolean"==typeof e.allowSparse?e.allowSparse:r.allowSparse,arrayLimit:"number"==typeof e.arrayLimit?e.arrayLimit:r.arrayLimit,charset:i,charsetSentinel:"boolean"==typeof e.charsetSentinel?e.charsetSentinel:r.charsetSentinel,comma:"boolean"==typeof e.comma?e.comma:r.comma,decodeDotInKeys:"boolean"==typeof e.decodeDotInKeys?e.decodeDotInKeys:r.decodeDotInKeys,decoder:"function"==typeof e.decoder?e.decoder:r.decoder,delimiter:"string"==typeof e.delimiter||n.isRegExp(e.delimiter)?e.delimiter:r.delimiter,depth:"number"==typeof e.depth||!1===e.depth?+e.depth:r.depth,duplicates:t,ignoreQueryPrefix:!0===e.ignoreQueryPrefix,interpretNumericEntities:"boolean"==typeof e.interpretNumericEntities?e.interpretNumericEntities:r.interpretNumericEntities,parameterLimit:"number"==typeof e.parameterLimit?e.parameterLimit:r.parameterLimit,parseArrays:!1!==e.parseArrays,plainObjects:"boolean"==typeof e.plainObjects?e.plainObjects:r.plainObjects,strictNullHandling:"boolean"==typeof e.strictNullHandling?e.strictNullHandling:r.strictNullHandling}}(i);if(""===e||null===e||void 0===e)return t.plainObjects?Object.create(null):{};for(var p="string"==typeof e?function(e,i){var t,u={__proto__:null},p=i.ignoreQueryPrefix?e.replace(/^\?/,""):e,c=i.parameterLimit===1/0?void 0:i.parameterLimit,d=p.split(i.delimiter,c),g=-1,h=i.charset;if(i.charsetSentinel)for(t=0;t-1&&(v=o(v)?[v]:v);var C=a.call(u,m);C&&"combine"===i.duplicates?u[m]=n.combine(u[m],v):C&&"last"!==i.duplicates||(u[m]=v)}return u}(e,t):e,c=t.plainObjects?Object.create(null):{},d=Object.keys(p),g=0;g0?P.join(",")||null:void 0}];else if(s(v))S=v;else{var G=Object.keys(P);S=f?G.sort(f):G}var U=d?t.replace(/\./g,"%2E"):t,x=r&&s(P)&&1===P.length?U+"[]":U;if(l&&s(P)&&0===P.length)return x+"[]";for(var R=0;R0?C+y:""}},{"./formats":29,"./utils":33,"side-channel":35}],33:[function(e,i,t){"use strict";var n=e("./formats"),a=Object.prototype.hasOwnProperty,o=Array.isArray,r=function(){for(var e=[],i=0;i<256;++i)e.push("%"+((i<16?"0":"")+i.toString(16)).toUpperCase());return e}(),l=function(e,i){for(var t=i&&i.plainObjects?Object.create(null):{},n=0;n1;){var i=e.pop(),t=i.obj[i.prop];if(o(t)){for(var n=[],a=0;a=1024?l.slice(u,u+1024):l,c=[],d=0;d=48&&g<=57||g>=65&&g<=90||g>=97&&g<=122||o===n.RFC1738&&(40===g||41===g)?c[c.length]=p.charAt(d):g<128?c[c.length]=r[g]:g<2048?c[c.length]=r[192|g>>6]+r[128|63&g]:g<55296||g>=57344?c[c.length]=r[224|g>>12]+r[128|g>>6&63]+r[128|63&g]:(d+=1,g=65536+((1023&g)<<10|1023&p.charCodeAt(d)),c[c.length]=r[240|g>>18]+r[128|g>>12&63]+r[128|g>>6&63]+r[128|63&g])}s+=c.join("")}return s},isBuffer:function(e){return!(!e||"object"!=typeof e||!(e.constructor&&e.constructor.isBuffer&&e.constructor.isBuffer(e)))},isRegExp:function(e){return"[object RegExp]"===Object.prototype.toString.call(e)},maybeMap:function(e,i){if(o(e)){for(var t=[],n=0;n4294967295||s(i)!==i)throw new l("`length` must be a positive 32-bit integer");var t=arguments.length>2&&!!arguments[2],n=!0,u=!0;if("length"in e&&r){var p=r(e,"length");p&&!p.configurable&&(n=!1),p&&!p.writable&&(u=!1)}return(n||u||!t)&&(o?a(e,"length",i,!0,!0):a(e,"length",i)),e}},{"define-data-property":10,"es-errors/type":17,"get-intrinsic":21,gopd:22,"has-property-descriptors":23}],35:[function(e,i,t){"use strict";var n=e("get-intrinsic"),a=e("call-bind/callBound"),o=e("object-inspect"),r=e("es-errors/type"),l=n("%WeakMap%",!0),s=n("%Map%",!0),u=a("WeakMap.prototype.get",!0),p=a("WeakMap.prototype.set",!0),c=a("WeakMap.prototype.has",!0),d=a("Map.prototype.get",!0),g=a("Map.prototype.set",!0),h=a("Map.prototype.has",!0),m=function(e,i){for(var t,n=e;null!==(t=n.next);n=t)if(t.key===i)return n.next=t.next,t.next=e.next,e.next=t,t};i.exports=function(){var e,i,t,n={assert:function(e){if(!n.has(e))throw new r("Side channel does not contain "+o(e))},get:function(n){if(l&&n&&("object"==typeof n||"function"==typeof n)){if(e)return u(e,n)}else if(s){if(i)return d(i,n)}else if(t)return function(e,i){var t=m(e,i);return t&&t.value}(t,n)},has:function(n){if(l&&n&&("object"==typeof n||"function"==typeof n)){if(e)return c(e,n)}else if(s){if(i)return h(i,n)}else if(t)return function(e,i){return!!m(e,i)}(t,n);return!1},set:function(n,a){l&&n&&("object"==typeof n||"function"==typeof n)?(e||(e=new l),p(e,n,a)):s?(i||(i=new s),g(i,n,a)):(t||(t={key:{},next:null}),function(e,i,t){var n=m(e,i);n?n.value=t:e.next={key:i,next:e.next,value:t}}(t,n,a))}};return n}},{"call-bind/callBound":8,"es-errors/type":17,"get-intrinsic":21,"object-inspect":28}],platformClient:[function(e,i,t){(function(t,n){(function(){"use strict";function n(e,i,t,n,a,o,r){try{var l=e[o](r),s=l.value}catch(e){return void t(e)}l.done?i(s):Promise.resolve(s).then(n,a)}function a(e){return function(){var i=this,t=arguments;return new Promise(function(a,o){var r=e.apply(i,t);function l(e){n(r,a,o,l,s,"next",e)}function s(e){n(r,a,o,l,s,"throw",e)}l(void 0)})}}function o(){o=function(){return i};var e,i={},t=Object.prototype,n=t.hasOwnProperty,a=Object.defineProperty||function(e,i,t){e[i]=t.value},r="function"==typeof Symbol?Symbol:{},l=r.iterator||"@@iterator",s=r.asyncIterator||"@@asyncIterator",u=r.toStringTag||"@@toStringTag";function p(e,i,t){return Object.defineProperty(e,i,{value:t,enumerable:!0,configurable:!0,writable:!0}),e[i]}try{p({},"")}catch(e){p=function(e,i,t){return e[i]=t}}function c(e,i,t,n){var o=i&&i.prototype instanceof w?i:w,r=Object.create(o.prototype),l=new E(n||[]);return a(r,"_invoke",{value:M(e,t,l)}),r}function d(e,i,t){try{return{type:"normal",arg:e.call(i,t)}}catch(e){return{type:"throw",arg:e}}}i.wrap=c;var g="suspendedStart",h="suspendedYield",m="executing",v="completed",f={};function w(){}function y(){}function I(){}var A={};p(A,l,function(){return this});var b=Object.getPrototypeOf,j=b&&b(b(G([])));j&&j!==t&&n.call(j,l)&&(A=j);var k=I.prototype=w.prototype=Object.create(A);function P(e){["next","throw","return"].forEach(function(i){p(e,i,function(e){return this._invoke(i,e)})})}function O(e,i){function t(a,o,r,l){var s=d(e[a],e,o);if("throw"!==s.type){var u=s.arg,p=u.value;return p&&"object"==C(p)&&n.call(p,"__await")?i.resolve(p.__await).then(function(e){t("next",e,r,l)},function(e){t("throw",e,r,l)}):i.resolve(p).then(function(e){u.value=e,r(u)},function(e){return t("throw",e,r,l)})}l(s.arg)}var o;a(this,"_invoke",{value:function(e,n){function a(){return new i(function(i,a){t(e,n,i,a)})}return o=o?o.then(a,a):a()}})}function M(i,t,n){var a=g;return function(o,r){if(a===m)throw Error("Generator is already running");if(a===v){if("throw"===o)throw r;return{value:e,done:!0}}for(n.method=o,n.arg=r;;){var l=n.delegate;if(l){var s=T(l,n);if(s){if(s===f)continue;return s}}if("next"===n.method)n.sent=n._sent=n.arg;else if("throw"===n.method){if(a===g)throw a=v,n.arg;n.dispatchException(n.arg)}else"return"===n.method&&n.abrupt("return",n.arg);a=m;var u=d(i,t,n);if("normal"===u.type){if(a=n.done?v:h,u.arg===f)continue;return{value:u.arg,done:n.done}}"throw"===u.type&&(a=v,n.method="throw",n.arg=u.arg)}}}function T(i,t){var n=t.method,a=i.iterator[n];if(a===e)return t.delegate=null,"throw"===n&&i.iterator.return&&(t.method="return",t.arg=e,T(i,t),"throw"===t.method)||"return"!==n&&(t.method="throw",t.arg=new TypeError("The iterator does not provide a '"+n+"' method")),f;var o=d(a,i.iterator,t.arg);if("throw"===o.type)return t.method="throw",t.arg=o.arg,t.delegate=null,f;var r=o.arg;return r?r.done?(t[i.resultName]=r.value,t.next=i.nextLoc,"return"!==t.method&&(t.method="next",t.arg=e),t.delegate=null,f):r:(t.method="throw",t.arg=new TypeError("iterator result is not an object"),t.delegate=null,f)}function q(e){var i={tryLoc:e[0]};1 in e&&(i.catchLoc=e[1]),2 in e&&(i.finallyLoc=e[2],i.afterLoc=e[3]),this.tryEntries.push(i)}function S(e){var i=e.completion||{};i.type="normal",delete i.arg,e.completion=i}function E(e){this.tryEntries=[{tryLoc:"root"}],e.forEach(q,this),this.reset(!0)}function G(i){if(i||""===i){var t=i[l];if(t)return t.call(i);if("function"==typeof i.next)return i;if(!isNaN(i.length)){var a=-1,o=function t(){for(;++a=0;--o){var r=this.tryEntries[o],l=r.completion;if("root"===r.tryLoc)return a("end");if(r.tryLoc<=this.prev){var s=n.call(r,"catchLoc"),u=n.call(r,"finallyLoc");if(s&&u){if(this.prev=0;--t){var a=this.tryEntries[t];if(a.tryLoc<=this.prev&&n.call(a,"finallyLoc")&&this.prev=0;--i){var t=this.tryEntries[i];if(t.finallyLoc===e)return this.complete(t.completion,t.afterLoc),S(t),f}},catch:function(e){for(var i=this.tryEntries.length-1;i>=0;--i){var t=this.tryEntries[i];if(t.tryLoc===e){var n=t.completion;if("throw"===n.type){var a=n.arg;S(t)}return a}}throw Error("illegal catch attempt")},delegateYield:function(i,t,n){return this.delegate={iterator:G(i),resultName:t,nextLoc:n},"next"===this.method&&(this.arg=e),f}},i}function r(e){return function(e){if(Array.isArray(e))return w(e)}(e)||l(e)||f(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function l(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}function s(e,i){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);i&&(n=n.filter(function(i){return Object.getOwnPropertyDescriptor(e,i).enumerable})),t.push.apply(t,n)}return t}function u(e){for(var i=1;ie.length)&&(i=e.length);for(var t=0,n=Array(i);t>18&63]+q[a>>12&63]+q[a>>6&63]+q[63&a]);return o.join("")}function R(e){var i;G||U();for(var t=e.length,n=t%3,a="",o=[],r=0,l=t-n;rl?l:r+16383));return 1===n?(i=e[t-1],a+=q[i>>2],a+=q[i<<4&63],a+="=="):2===n&&(i=(e[t-2]<<8)+e[t-1],a+=q[i>>10],a+=q[i>>4&63],a+=q[i<<2&63],a+="="),o.push(a),o.join("")}function D(e,i,t,n,a){var o,r,l=8*a-n-1,s=(1<>1,p=-7,c=t?a-1:0,d=t?-1:1,g=e[i+c];for(c+=d,o=g&(1<<-p)-1,g>>=-p,p+=l;p>0;o=256*o+e[i+c],c+=d,p-=8);for(r=o&(1<<-p)-1,o>>=-p,p+=n;p>0;r=256*r+e[i+c],c+=d,p-=8);if(0===o)o=1-u;else{if(o===s)return r?NaN:1/0*(g?-1:1);r+=Math.pow(2,n),o-=u}return(g?-1:1)*r*Math.pow(2,o-n)}function z(e,i,t,n,a,o){var r,l,s,u=8*o-a-1,p=(1<>1,d=23===a?Math.pow(2,-24)-Math.pow(2,-77):0,g=n?0:o-1,h=n?1:-1,m=i<0||0===i&&1/i<0?1:0;for(i=Math.abs(i),isNaN(i)||i===1/0?(l=isNaN(i)?1:0,r=p):(r=Math.floor(Math.log(i)/Math.LN2),i*(s=Math.pow(2,-r))<1&&(r--,s*=2),(i+=r+c>=1?d/s:d*Math.pow(2,1-c))*s>=2&&(r++,s/=2),r+c>=p?(l=0,r=p):r+c>=1?(l=(i*s-1)*Math.pow(2,a),r+=c):(l=i*Math.pow(2,c-1)*Math.pow(2,a),r=0));a>=8;e[t+g]=255&l,g+=h,l/=256,a-=8);for(r=r<0;e[t+g]=255&r,g+=h,r/=256,u-=8);e[t+g-h]|=128*m}var B={}.toString,W=Array.isArray||function(e){return"[object Array]"==B.call(e)};function L(){return K.TYPED_ARRAY_SUPPORT?2147483647:1073741823}function N(e,i){if(L()=L())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+L().toString(16)+" bytes");return 0|e}function H(e){return!(null==e||!e._isBuffer)}function Y(e,i){if(H(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var t=e.length;if(0===t)return 0;for(var n=!1;;)switch(i){case"ascii":case"latin1":case"binary":return t;case"utf8":case"utf-8":case void 0:return Ae(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*t;case"hex":return t>>>1;case"base64":return be(e).length;default:if(n)return Ae(e).length;i=(""+i).toLowerCase(),n=!0}}function $(e,i,t){var n=e[i];e[i]=e[t],e[t]=n}function Z(e,i,t,n,a){if(0===e.length)return-1;if("string"==typeof t?(n=t,t=0):t>2147483647?t=2147483647:t<-2147483648&&(t=-2147483648),t=+t,isNaN(t)&&(t=a?0:e.length-1),t<0&&(t=e.length+t),t>=e.length){if(a)return-1;t=e.length-1}else if(t<0){if(!a)return-1;t=0}if("string"==typeof i&&(i=K.from(i,n)),H(i))return 0===i.length?-1:X(e,i,t,n,a);if("number"==typeof i)return i&=255,K.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?a?Uint8Array.prototype.indexOf.call(e,i,t):Uint8Array.prototype.lastIndexOf.call(e,i,t):X(e,[i],t,n,a);throw new TypeError("val must be string, number or Buffer")}function X(e,i,t,n,a){var o,r=1,l=e.length,s=i.length;if(void 0!==n&&("ucs2"===(n=String(n).toLowerCase())||"ucs-2"===n||"utf16le"===n||"utf-16le"===n)){if(e.length<2||i.length<2)return-1;r=2,l/=2,s/=2,t/=2}function u(e,i){return 1===r?e[i]:e.readUInt16BE(i*r)}if(a){var p=-1;for(o=t;ol&&(t=l-s),o=t;o>=0;o--){for(var c=!0,d=0;da&&(n=a):n=a;var o=i.length;if(o%2!=0)throw new TypeError("Invalid hex string");n>o/2&&(n=o/2);for(var r=0;r>8,a=t%256,o.push(a),o.push(n);return o}(i,e.length-t),e,t,n)}function re(e,i,t){return 0===i&&t===e.length?R(e):R(e.slice(i,t))}function le(e,i,t){t=Math.min(e.length,t);for(var n=[],a=i;a239?4:u>223?3:u>191?2:1;if(a+c<=t)switch(c){case 1:u<128&&(p=u);break;case 2:128==(192&(o=e[a+1]))&&(s=(31&u)<<6|63&o)>127&&(p=s);break;case 3:o=e[a+1],r=e[a+2],128==(192&o)&&128==(192&r)&&(s=(15&u)<<12|(63&o)<<6|63&r)>2047&&(s<55296||s>57343)&&(p=s);break;case 4:o=e[a+1],r=e[a+2],l=e[a+3],128==(192&o)&&128==(192&r)&&128==(192&l)&&(s=(15&u)<<18|(63&o)<<12|(63&r)<<6|63&l)>65535&&s<1114112&&(p=s)}null===p?(p=65533,c=1):p>65535&&(p-=65536,n.push(p>>>10&1023|55296),p=56320|1023&p),n.push(p),a+=c}return function(e){var i=e.length;if(i<=se)return String.fromCharCode.apply(String,e);var t="",n=0;for(;nthis.length)return"";if((void 0===t||t>this.length)&&(t=this.length),t<=0)return"";if((t>>>=0)<=(i>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return ce(this,i,t);case"utf8":case"utf-8":return le(this,i,t);case"ascii":return ue(this,i,t);case"latin1":case"binary":return pe(this,i,t);case"base64":return re(this,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return de(this,i,t);default:if(n)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),n=!0}}.apply(this,arguments)},K.prototype.equals=function(e){if(!H(e))throw new TypeError("Argument must be a Buffer");return this===e||0===K.compare(this,e)},K.prototype.inspect=function(){var e="";return this.length>0&&(e=this.toString("hex",0,50).match(/.{2}/g).join(" "),this.length>50&&(e+=" ... ")),""},K.prototype.compare=function(e,i,t,n,a){if(!H(e))throw new TypeError("Argument must be a Buffer");if(void 0===i&&(i=0),void 0===t&&(t=e?e.length:0),void 0===n&&(n=0),void 0===a&&(a=this.length),i<0||t>e.length||n<0||a>this.length)throw new RangeError("out of range index");if(n>=a&&i>=t)return 0;if(n>=a)return-1;if(i>=t)return 1;if(i>>>=0,t>>>=0,n>>>=0,a>>>=0,this===e)return 0;for(var o=a-n,r=t-i,l=Math.min(o,r),s=this.slice(n,a),u=e.slice(i,t),p=0;pa)&&(t=a),e.length>0&&(t<0||i<0)||i>this.length)throw new RangeError("Attempt to write outside buffer bounds");n||(n="utf8");for(var o=!1;;)switch(n){case"hex":return ee(this,e,i,t);case"utf8":case"utf-8":return ie(this,e,i,t);case"ascii":return te(this,e,i,t);case"latin1":case"binary":return ne(this,e,i,t);case"base64":return ae(this,e,i,t);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return oe(this,e,i,t);default:if(o)throw new TypeError("Unknown encoding: "+n);n=(""+n).toLowerCase(),o=!0}},K.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var se=4096;function ue(e,i,t){var n="";t=Math.min(e.length,t);for(var a=i;an)&&(t=n);for(var a="",o=i;ot)throw new RangeError("Trying to access beyond buffer length")}function he(e,i,t,n,a,o){if(!H(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(i>a||ie.length)throw new RangeError("Index out of range")}function me(e,i,t,n){i<0&&(i=65535+i+1);for(var a=0,o=Math.min(e.length-t,2);a>>8*(n?a:1-a)}function ve(e,i,t,n){i<0&&(i=4294967295+i+1);for(var a=0,o=Math.min(e.length-t,4);a>>8*(n?a:3-a)&255}function fe(e,i,t,n,a,o){if(t+n>e.length)throw new RangeError("Index out of range");if(t<0)throw new RangeError("Index out of range")}function we(e,i,t,n,a){return a||fe(e,0,t,4),z(e,i,t,n,23,4),t+4}function ye(e,i,t,n,a){return a||fe(e,0,t,8),z(e,i,t,n,52,8),t+8}K.prototype.slice=function(e,i){var t,n=this.length;if(e=~~e,i=void 0===i?n:~~i,e<0?(e+=n)<0&&(e=0):e>n&&(e=n),i<0?(i+=n)<0&&(i=0):i>n&&(i=n),i0&&(a*=256);)n+=this[e+--i]*a;return n},K.prototype.readUInt8=function(e,i){return i||ge(e,1,this.length),this[e]},K.prototype.readUInt16LE=function(e,i){return i||ge(e,2,this.length),this[e]|this[e+1]<<8},K.prototype.readUInt16BE=function(e,i){return i||ge(e,2,this.length),this[e]<<8|this[e+1]},K.prototype.readUInt32LE=function(e,i){return i||ge(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},K.prototype.readUInt32BE=function(e,i){return i||ge(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},K.prototype.readIntLE=function(e,i,t){e|=0,i|=0,t||ge(e,i,this.length);for(var n=this[e],a=1,o=0;++o=(a*=128)&&(n-=Math.pow(2,8*i)),n},K.prototype.readIntBE=function(e,i,t){e|=0,i|=0,t||ge(e,i,this.length);for(var n=i,a=1,o=this[e+--n];n>0&&(a*=256);)o+=this[e+--n]*a;return o>=(a*=128)&&(o-=Math.pow(2,8*i)),o},K.prototype.readInt8=function(e,i){return i||ge(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},K.prototype.readInt16LE=function(e,i){i||ge(e,2,this.length);var t=this[e]|this[e+1]<<8;return 32768&t?4294901760|t:t},K.prototype.readInt16BE=function(e,i){i||ge(e,2,this.length);var t=this[e+1]|this[e]<<8;return 32768&t?4294901760|t:t},K.prototype.readInt32LE=function(e,i){return i||ge(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},K.prototype.readInt32BE=function(e,i){return i||ge(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},K.prototype.readFloatLE=function(e,i){return i||ge(e,4,this.length),D(this,e,!0,23,4)},K.prototype.readFloatBE=function(e,i){return i||ge(e,4,this.length),D(this,e,!1,23,4)},K.prototype.readDoubleLE=function(e,i){return i||ge(e,8,this.length),D(this,e,!0,52,8)},K.prototype.readDoubleBE=function(e,i){return i||ge(e,8,this.length),D(this,e,!1,52,8)},K.prototype.writeUIntLE=function(e,i,t,n){(e=+e,i|=0,t|=0,n)||he(this,e,i,t,Math.pow(2,8*t)-1,0);var a=1,o=0;for(this[i]=255&e;++o=0&&(o*=256);)this[i+a]=e/o&255;return i+t},K.prototype.writeUInt8=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,1,255,0),K.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),this[i]=255&e,i+1},K.prototype.writeUInt16LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,65535,0),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8):me(this,e,i,!0),i+2},K.prototype.writeUInt16BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,65535,0),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>8,this[i+1]=255&e):me(this,e,i,!1),i+2},K.prototype.writeUInt32LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,4294967295,0),K.TYPED_ARRAY_SUPPORT?(this[i+3]=e>>>24,this[i+2]=e>>>16,this[i+1]=e>>>8,this[i]=255&e):ve(this,e,i,!0),i+4},K.prototype.writeUInt32BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,4294967295,0),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e):ve(this,e,i,!1),i+4},K.prototype.writeIntLE=function(e,i,t,n){if(e=+e,i|=0,!n){var a=Math.pow(2,8*t-1);he(this,e,i,t,a-1,-a)}var o=0,r=1,l=0;for(this[i]=255&e;++o>0)-l&255;return i+t},K.prototype.writeIntBE=function(e,i,t,n){if(e=+e,i|=0,!n){var a=Math.pow(2,8*t-1);he(this,e,i,t,a-1,-a)}var o=t-1,r=1,l=0;for(this[i+o]=255&e;--o>=0&&(r*=256);)e<0&&0===l&&0!==this[i+o+1]&&(l=1),this[i+o]=(e/r>>0)-l&255;return i+t},K.prototype.writeInt8=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,1,127,-128),K.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),e<0&&(e=255+e+1),this[i]=255&e,i+1},K.prototype.writeInt16LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,32767,-32768),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8):me(this,e,i,!0),i+2},K.prototype.writeInt16BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,2,32767,-32768),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>8,this[i+1]=255&e):me(this,e,i,!1),i+2},K.prototype.writeInt32LE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,2147483647,-2147483648),K.TYPED_ARRAY_SUPPORT?(this[i]=255&e,this[i+1]=e>>>8,this[i+2]=e>>>16,this[i+3]=e>>>24):ve(this,e,i,!0),i+4},K.prototype.writeInt32BE=function(e,i,t){return e=+e,i|=0,t||he(this,e,i,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),K.TYPED_ARRAY_SUPPORT?(this[i]=e>>>24,this[i+1]=e>>>16,this[i+2]=e>>>8,this[i+3]=255&e):ve(this,e,i,!1),i+4},K.prototype.writeFloatLE=function(e,i,t){return we(this,e,i,!0,t)},K.prototype.writeFloatBE=function(e,i,t){return we(this,e,i,!1,t)},K.prototype.writeDoubleLE=function(e,i,t){return ye(this,e,i,!0,t)},K.prototype.writeDoubleBE=function(e,i,t){return ye(this,e,i,!1,t)},K.prototype.copy=function(e,i,t,n){if(t||(t=0),n||0===n||(n=this.length),i>=e.length&&(i=e.length),i||(i=0),n>0&&n=this.length)throw new RangeError("sourceStart out of bounds");if(n<0)throw new RangeError("sourceEnd out of bounds");n>this.length&&(n=this.length),e.length-i=0;--a)e[a+i]=this[a+t];else if(o<1e3||!K.TYPED_ARRAY_SUPPORT)for(a=0;a>>=0,t=void 0===t?this.length:t>>>0,e||(e=0),"number"==typeof e)for(o=i;o55295&&t<57344){if(!a){if(t>56319){(i-=3)>-1&&o.push(239,191,189);continue}if(r+1===n){(i-=3)>-1&&o.push(239,191,189);continue}a=t;continue}if(t<56320){(i-=3)>-1&&o.push(239,191,189),a=t;continue}t=65536+(a-55296<<10|t-56320)}else a&&(i-=3)>-1&&o.push(239,191,189);if(a=null,t<128){if((i-=1)<0)break;o.push(t)}else if(t<2048){if((i-=2)<0)break;o.push(t>>6|192,63&t|128)}else if(t<65536){if((i-=3)<0)break;o.push(t>>12|224,t>>6&63|128,63&t|128)}else{if(!(t<1114112))throw new Error("Invalid code point");if((i-=4)<0)break;o.push(t>>18|240,t>>12&63|128,t>>6&63|128,63&t|128)}}return o}function be(e){return function(e){var i,t,n,a,o,r;G||U();var l=e.length;if(l%4>0)throw new Error("Invalid string. Length must be a multiple of 4");o="="===e[l-2]?2:"="===e[l-1]?1:0,r=new E(3*l/4-o),n=o>0?l-4:l;var s=0;for(i=0,t=0;i>16&255,r[s++]=a>>8&255,r[s++]=255&a;return 2===o?(a=S[e.charCodeAt(i)]<<2|S[e.charCodeAt(i+1)]>>4,r[s++]=255&a):1===o&&(a=S[e.charCodeAt(i)]<<10|S[e.charCodeAt(i+1)]<<4|S[e.charCodeAt(i+2)]>>2,r[s++]=a>>8&255,r[s++]=255&a),r}(function(e){if((e=function(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}(e).replace(Ce,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function je(e,i,t,n){for(var a=0;a=i.length||a>=e.length);++a)i[a+t]=e[a];return a}function ke(e){return!!e.constructor&&"function"==typeof e.constructor.isBuffer&&e.constructor.isBuffer(e)}function Pe(e,i){return function(){return e.apply(i,arguments)}}var Oe,Me=Object.prototype.toString,Te=Object.getPrototypeOf,qe=(Oe=Object.create(null),function(e){var i=Me.call(e);return Oe[i]||(Oe[i]=i.slice(8,-1).toLowerCase())}),Se=function(e){return e=e.toLowerCase(),function(i){return qe(i)===e}},Ee=function(e){return function(i){return C(i)===e}},Ge=Array.isArray,Ue=Ee("undefined");var xe=Se("ArrayBuffer");var Re=Ee("string"),De=Ee("function"),ze=Ee("number"),Be=function(e){return null!==e&&"object"===C(e)},We=function(e){if("object"!==qe(e))return!1;var i=Te(e);return!(null!==i&&i!==Object.prototype&&null!==Object.getPrototypeOf(i)||Symbol.toStringTag in e||Symbol.iterator in e)},Le=Se("Date"),Ne=Se("File"),Ke=Se("Blob"),Fe=Se("FileList"),Je=Se("URLSearchParams"),Ve=m(["ReadableStream","Request","Response","Headers"].map(Se),4),_e=Ve[0],Qe=Ve[1],He=Ve[2],Ye=Ve[3];function $e(e,i){var t,n,a=(arguments.length>2&&void 0!==arguments[2]?arguments[2]:{}).allOwnKeys,o=void 0!==a&&a;if(null!==e&&void 0!==e)if("object"!==C(e)&&(e=[e]),Ge(e))for(t=0,n=e.length;t0;)if(i===(t=n[a]).toLowerCase())return t;return null}var Xe="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:"undefined"!=typeof window?window:T,ei=function(e){return!Ue(e)&&e!==Xe};var ii,ti=(ii="undefined"!=typeof Uint8Array&&Te(Uint8Array),function(e){return ii&&e instanceof ii}),ni=Se("HTMLFormElement"),ai=function(e){var i=Object.prototype.hasOwnProperty;return function(e,t){return i.call(e,t)}}(),oi=Se("RegExp"),ri=function(e,i){var t={};$e(Object.getOwnPropertyDescriptors(e),function(n,a){var o;!1!==(o=i(n,a,e))&&(t[a]=o||n)}),Object.defineProperties(e,t)},li="abcdefghijklmnopqrstuvwxyz",si={DIGIT:"0123456789",ALPHA:li,ALPHA_DIGIT:li+li.toUpperCase()+"0123456789"};var ui=Se("AsyncFunction"),pi={isArray:Ge,isArrayBuffer:xe,isBuffer:function(e){return null!==e&&!Ue(e)&&null!==e.constructor&&!Ue(e.constructor)&&De(e.constructor.isBuffer)&&e.constructor.isBuffer(e)},isFormData:function(e){var i;return e&&("function"==typeof FormData&&e instanceof FormData||De(e.append)&&("formdata"===(i=qe(e))||"object"===i&&De(e.toString)&&"[object FormData]"===e.toString()))},isArrayBufferView:function(e){return"undefined"!=typeof ArrayBuffer&&ArrayBuffer.isView?ArrayBuffer.isView(e):e&&e.buffer&&xe(e.buffer)},isString:Re,isNumber:ze,isBoolean:function(e){return!0===e||!1===e},isObject:Be,isPlainObject:We,isReadableStream:_e,isRequest:Qe,isResponse:He,isHeaders:Ye,isUndefined:Ue,isDate:Le,isFile:Ne,isBlob:Ke,isRegExp:oi,isFunction:De,isStream:function(e){return Be(e)&&De(e.pipe)},isURLSearchParams:Je,isTypedArray:ti,isFileList:Fe,forEach:$e,merge:function e(){for(var i=(ei(this)&&this||{}).caseless,t={},n=function(n,a){var o=i&&Ze(t,a)||a;We(t[o])&&We(n)?t[o]=e(t[o],n):We(n)?t[o]=e({},n):Ge(n)?t[o]=n.slice():t[o]=n},a=0,o=arguments.length;a3&&void 0!==arguments[3]?arguments[3]:{}).allOwnKeys}),e},trim:function(e){return e.trim?e.trim():e.replace(/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,"")},stripBOM:function(e){return 65279===e.charCodeAt(0)&&(e=e.slice(1)),e},inherits:function(e,i,t,n){e.prototype=Object.create(i.prototype,n),e.prototype.constructor=e,Object.defineProperty(e,"super",{value:i.prototype}),t&&Object.assign(e.prototype,t)},toFlatObject:function(e,i,t,n){var a,o,r,l={};if(i=i||{},null==e)return i;do{for(o=(a=Object.getOwnPropertyNames(e)).length;o-- >0;)r=a[o],n&&!n(r,e,i)||l[r]||(i[r]=e[r],l[r]=!0);e=!1!==t&&Te(e)}while(e&&(!t||t(e,i))&&e!==Object.prototype);return i},kindOf:qe,kindOfTest:Se,endsWith:function(e,i,t){e=String(e),(void 0===t||t>e.length)&&(t=e.length),t-=i.length;var n=e.indexOf(i,t);return-1!==n&&n===t},toArray:function(e){if(!e)return null;if(Ge(e))return e;var i=e.length;if(!ze(i))return null;for(var t=new Array(i);i-- >0;)t[i]=e[i];return t},forEachEntry:function(e,i){for(var t,n=(e&&e[Symbol.iterator]).call(e);(t=n.next())&&!t.done;){var a=t.value;i.call(e,a[0],a[1])}},matchAll:function(e,i){for(var t,n=[];null!==(t=e.exec(i));)n.push(t);return n},isHTMLForm:ni,hasOwnProperty:ai,hasOwnProp:ai,reduceDescriptors:ri,freezeMethods:function(e){ri(e,function(i,t){if(De(e)&&-1!==["arguments","caller","callee"].indexOf(t))return!1;var n=e[t];De(n)&&(i.enumerable=!1,"writable"in i?i.writable=!1:i.set||(i.set=function(){throw Error("Can not rewrite read-only method '"+t+"'")}))})},toObjectSet:function(e,i){var t={},n=function(e){e.forEach(function(e){t[e]=!0})};return Ge(e)?n(e):n(String(e).split(i)),t},toCamelCase:function(e){return e.toLowerCase().replace(/[-_\s]([a-z\d])(\w*)/g,function(e,i,t){return i.toUpperCase()+t})},noop:function(){},toFiniteNumber:function(e,i){return null!=e&&Number.isFinite(e=+e)?e:i},findKey:Ze,global:Xe,isContextDefined:ei,ALPHABET:si,generateString:function(){for(var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:16,i=arguments.length>1&&void 0!==arguments[1]?arguments[1]:si.ALPHA_DIGIT,t="",n=i.length;e--;)t+=i[Math.random()*n|0];return t},isSpecCompliantForm:function(e){return!!(e&&De(e.append)&&"FormData"===e[Symbol.toStringTag]&&e[Symbol.iterator])},toJSONObject:function(e){var i=new Array(10);return function e(t,n){if(Be(t)){if(i.indexOf(t)>=0)return;if(!("toJSON"in t)){i[n]=t;var a=Ge(t)?[]:{};return $e(t,function(i,t){var o=e(i,n+1);!Ue(o)&&(a[t]=o)}),i[n]=void 0,a}}return t}(e,0)},isAsyncFn:ui,isThenable:function(e){return e&&(Be(e)||De(e))&&De(e.then)&&De(e.catch)}};function ci(e,i,t,n,a){Error.call(this),Error.captureStackTrace?Error.captureStackTrace(this,this.constructor):this.stack=(new Error).stack,this.message=e,this.name="AxiosError",i&&(this.code=i),t&&(this.config=t),n&&(this.request=n),a&&(this.response=a)}pi.inherits(ci,Error,{toJSON:function(){return{message:this.message,name:this.name,description:this.description,number:this.number,fileName:this.fileName,lineNumber:this.lineNumber,columnNumber:this.columnNumber,stack:this.stack,config:pi.toJSONObject(this.config),code:this.code,status:this.response&&this.response.status?this.response.status:null}}});var di=ci.prototype,gi={};["ERR_BAD_OPTION_VALUE","ERR_BAD_OPTION","ECONNABORTED","ETIMEDOUT","ERR_NETWORK","ERR_FR_TOO_MANY_REDIRECTS","ERR_DEPRECATED","ERR_BAD_RESPONSE","ERR_BAD_REQUEST","ERR_CANCELED","ERR_NOT_SUPPORT","ERR_INVALID_URL"].forEach(function(e){gi[e]={value:e}}),Object.defineProperties(ci,gi),Object.defineProperty(di,"isAxiosError",{value:!0}),ci.from=function(e,i,t,n,a,o){var r=Object.create(di);return pi.toFlatObject(e,r,function(e){return e!==Error.prototype},function(e){return"isAxiosError"!==e}),ci.call(r,e.message,i,t,n,a),r.cause=e,r.name=e.name,o&&Object.assign(r,o),r};function hi(e){return pi.isPlainObject(e)||pi.isArray(e)}function mi(e){return pi.endsWith(e,"[]")?e.slice(0,-2):e}function vi(e,i,t){return e?e.concat(i).map(function(e,i){return e=mi(e),!t&&i?"["+e+"]":e}).join(t?".":""):i}var fi=pi.toFlatObject(pi,{},null,function(e){return/^is[A-Z]/.test(e)});function wi(e,i,t){if(!pi.isObject(e))throw new TypeError("target must be an object");i=i||new FormData;var n=(t=pi.toFlatObject(t,{metaTokens:!0,dots:!1,indexes:!1},!1,function(e,i){return!pi.isUndefined(i[e])})).metaTokens,a=t.visitor||u,o=t.dots,r=t.indexes,l=(t.Blob||"undefined"!=typeof Blob&&Blob)&&pi.isSpecCompliantForm(i);if(!pi.isFunction(a))throw new TypeError("visitor must be a function");function s(e){if(null===e)return"";if(pi.isDate(e))return e.toISOString();if(!l&&pi.isBlob(e))throw new ci("Blob is not supported. Use a Buffer instead.");return pi.isArrayBuffer(e)||pi.isTypedArray(e)?l&&"function"==typeof Blob?new Blob([e]):K.from(e):e}function u(e,t,a){var l=e;if(e&&!a&&"object"===C(e))if(pi.endsWith(t,"{}"))t=n?t:t.slice(0,-2),e=JSON.stringify(e);else if(pi.isArray(e)&&function(e){return pi.isArray(e)&&!e.some(hi)}(e)||(pi.isFileList(e)||pi.endsWith(t,"[]"))&&(l=pi.toArray(e)))return t=mi(t),l.forEach(function(e,n){!pi.isUndefined(e)&&null!==e&&i.append(!0===r?vi([t],n,o):null===r?t:t+"[]",s(e))}),!1;return!!hi(e)||(i.append(vi(a,t,o),s(e)),!1)}var p=[],c=Object.assign(fi,{defaultVisitor:u,convertValue:s,isVisitable:hi});if(!pi.isObject(e))throw new TypeError("data must be an object");return function e(t,n){if(!pi.isUndefined(t)){if(-1!==p.indexOf(t))throw Error("Circular reference detected in "+n.join("."));p.push(t),pi.forEach(t,function(t,o){!0===(!(pi.isUndefined(t)||null===t)&&a.call(i,t,pi.isString(o)?o.trim():o,n,c))&&e(t,n?n.concat(o):[o])}),p.pop()}}(e),i}function yi(e){var i={"!":"%21","'":"%27","(":"%28",")":"%29","~":"%7E","%20":"+","%00":"\0"};return encodeURIComponent(e).replace(/[!'()~]|%20|%00/g,function(e){return i[e]})}function Ci(e,i){this._pairs=[],e&&wi(e,this,i)}var Ii=Ci.prototype;function Ai(e){return encodeURIComponent(e).replace(/%3A/gi,":").replace(/%24/g,"$").replace(/%2C/gi,",").replace(/%20/g,"+").replace(/%5B/gi,"[").replace(/%5D/gi,"]")}function bi(e,i,t){if(!i)return e;var n,a=t&&t.encode||Ai,o=t&&t.serialize;if(n=o?o(i,t):pi.isURLSearchParams(i)?i.toString():new Ci(i,t).toString(a)){var r=e.indexOf("#");-1!==r&&(e=e.slice(0,r)),e+=(-1===e.indexOf("?")?"?":"&")+n}return e}Ii.append=function(e,i){this._pairs.push([e,i])},Ii.toString=function(e){var i=e?function(i){return e.call(this,i,yi)}:yi;return this._pairs.map(function(e){return i(e[0])+"="+i(e[1])},"").join("&")};var ji,ki=function(){return g(function e(){c(this,e),this.handlers=[]},[{key:"use",value:function(e,i,t){return this.handlers.push({fulfilled:e,rejected:i,synchronous:!!t&&t.synchronous,runWhen:t?t.runWhen:null}),this.handlers.length-1}},{key:"eject",value:function(e){this.handlers[e]&&(this.handlers[e]=null)}},{key:"clear",value:function(){this.handlers&&(this.handlers=[])}},{key:"forEach",value:function(e){pi.forEach(this.handlers,function(i){null!==i&&e(i)})}}])}(),Pi={silentJSONParsing:!0,forcedJSONParsing:!0,clarifyTimeoutError:!1},Oi={isBrowser:!0,classes:{URLSearchParams:"undefined"!=typeof URLSearchParams?URLSearchParams:Ci,FormData:"undefined"!=typeof FormData?FormData:null,Blob:"undefined"!=typeof Blob?Blob:null},protocols:["http","https","file","blob","url","data"]},Mi="undefined"!=typeof window&&"undefined"!=typeof document,Ti=(ji="undefined"!=typeof navigator&&navigator.product,Mi&&["ReactNative","NativeScript","NS"].indexOf(ji)<0),qi="undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope&&"function"==typeof self.importScripts,Si=Mi&&window.location.href||"http://localhost",Ei=u(u({},Object.freeze({__proto__:null,hasBrowserEnv:Mi,hasStandardBrowserWebWorkerEnv:qi,hasStandardBrowserEnv:Ti,origin:Si})),Oi);function Gi(e){function i(e,t,n,a){var o=e[a++];if("__proto__"===o)return!0;var r=Number.isFinite(+o),l=a>=e.length;return o=!o&&pi.isArray(n)?n.length:o,l?(pi.hasOwnProp(n,o)?n[o]=[n[o],t]:n[o]=t,!r):(n[o]&&pi.isObject(n[o])||(n[o]=[]),i(e,t,n[o],a)&&pi.isArray(n[o])&&(n[o]=function(e){var i,t,n={},a=Object.keys(e),o=a.length;for(i=0;i-1,o=pi.isObject(e);if(o&&pi.isHTMLForm(e)&&(e=new FormData(e)),pi.isFormData(e))return a?JSON.stringify(Gi(e)):e;if(pi.isArrayBuffer(e)||pi.isBuffer(e)||pi.isStream(e)||pi.isFile(e)||pi.isBlob(e)||pi.isReadableStream(e))return e;if(pi.isArrayBufferView(e))return e.buffer;if(pi.isURLSearchParams(e))return i.setContentType("application/x-www-form-urlencoded;charset=utf-8",!1),e.toString();if(o){if(n.indexOf("application/x-www-form-urlencoded")>-1)return function(e,i){return wi(e,new Ei.classes.URLSearchParams,Object.assign({visitor:function(e,i,t,n){return Ei.isNode&&pi.isBuffer(e)?(this.append(i,e.toString("base64")),!1):n.defaultVisitor.apply(this,arguments)}},i))}(e,this.formSerializer).toString();if((t=pi.isFileList(e))||n.indexOf("multipart/form-data")>-1){var r=this.env&&this.env.FormData;return wi(t?{"files[]":e}:e,r&&new r,this.formSerializer)}}return o||a?(i.setContentType("application/json",!1),function(e,i,t){if(pi.isString(e))try{return(i||JSON.parse)(e),pi.trim(e)}catch(e){if("SyntaxError"!==e.name)throw e}return(t||JSON.stringify)(e)}(e)):e}],transformResponse:[function(e){var i=this.transitional||Ui.transitional,t=i&&i.forcedJSONParsing,n="json"===this.responseType;if(pi.isResponse(e)||pi.isReadableStream(e))return e;if(e&&pi.isString(e)&&(t&&!this.responseType||n)){var a=!(i&&i.silentJSONParsing)&&n;try{return JSON.parse(e)}catch(e){if(a){if("SyntaxError"===e.name)throw ci.from(e,ci.ERR_BAD_RESPONSE,this,null,this.response);throw e}}}return e}],timeout:0,xsrfCookieName:"XSRF-TOKEN",xsrfHeaderName:"X-XSRF-TOKEN",maxContentLength:-1,maxBodyLength:-1,env:{FormData:Ei.classes.FormData,Blob:Ei.classes.Blob},validateStatus:function(e){return e>=200&&e<300},headers:{common:{Accept:"application/json, text/plain, */*","Content-Type":void 0}}};pi.forEach(["delete","get","head","post","put","patch"],function(e){Ui.headers[e]={}});var xi=Ui,Ri=pi.toObjectSet(["age","authorization","content-length","content-type","etag","expires","from","host","if-modified-since","if-unmodified-since","last-modified","location","max-forwards","proxy-authorization","referer","retry-after","user-agent"]),Di=Symbol("internals");function zi(e){return e&&String(e).trim().toLowerCase()}function Bi(e){return!1===e||null==e?e:pi.isArray(e)?e.map(Bi):String(e)}function Wi(e,i,t,n,a){return pi.isFunction(n)?n.call(this,i,t):(a&&(i=t),pi.isString(i)?pi.isString(n)?-1!==i.indexOf(n):pi.isRegExp(n)?n.test(i):void 0:void 0)}var Li=function(){return g(function e(i){c(this,e),i&&this.set(i)},[{key:"set",value:function(e,i,t){var n=this;function a(e,i,t){var a=zi(i);if(!a)throw new Error("header name must be a non-empty string");var o=pi.findKey(n,a);(!o||void 0===n[o]||!0===t||void 0===t&&!1!==n[o])&&(n[o||i]=Bi(e))}var o=function(e,i){return pi.forEach(e,function(e,t){return a(e,t,i)})};if(pi.isPlainObject(e)||e instanceof this.constructor)o(e,i);else if(pi.isString(e)&&(e=e.trim())&&!/^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(e.trim()))o(function(e){var i,t,n,a={};return e&&e.split("\n").forEach(function(e){n=e.indexOf(":"),i=e.substring(0,n).trim().toLowerCase(),t=e.substring(n+1).trim(),!i||a[i]&&Ri[i]||("set-cookie"===i?a[i]?a[i].push(t):a[i]=[t]:a[i]=a[i]?a[i]+", "+t:t)}),a}(e),i);else if(pi.isHeaders(e)){var r,l=function(e,i){var t="undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(!t){if(Array.isArray(e)||(t=f(e))||i&&e&&"number"==typeof e.length){t&&(e=t);var n=0,a=function(){};return{s:a,n:function(){return n>=e.length?{done:!0}:{done:!1,value:e[n++]}},e:function(e){throw e},f:a}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var o,r=!0,l=!1;return{s:function(){t=t.call(e)},n:function(){var e=t.next();return r=e.done,e},e:function(e){l=!0,o=e},f:function(){try{r||null==t.return||t.return()}finally{if(l)throw o}}}}(e.entries());try{for(l.s();!(r=l.n()).done;){var s=m(r.value,2),u=s[0];a(s[1],u,t)}}catch(e){l.e(e)}finally{l.f()}}else null!=e&&a(i,e,t);return this}},{key:"get",value:function(e,i){if(e=zi(e)){var t=pi.findKey(this,e);if(t){var n=this[t];if(!i)return n;if(!0===i)return function(e){for(var i,t=Object.create(null),n=/([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;i=n.exec(e);)t[i[1]]=i[2];return t}(n);if(pi.isFunction(i))return i.call(this,n,t);if(pi.isRegExp(i))return i.exec(n);throw new TypeError("parser must be boolean|regexp|function")}}}},{key:"has",value:function(e,i){if(e=zi(e)){var t=pi.findKey(this,e);return!(!t||void 0===this[t]||i&&!Wi(0,this[t],t,i))}return!1}},{key:"delete",value:function(e,i){var t=this,n=!1;function a(e){if(e=zi(e)){var a=pi.findKey(t,e);!a||i&&!Wi(0,t[a],a,i)||(delete t[a],n=!0)}}return pi.isArray(e)?e.forEach(a):a(e),n}},{key:"clear",value:function(e){for(var i=Object.keys(this),t=i.length,n=!1;t--;){var a=i[t];e&&!Wi(0,this[a],a,e,!0)||(delete this[a],n=!0)}return n}},{key:"normalize",value:function(e){var i=this,t={};return pi.forEach(this,function(n,a){var o=pi.findKey(t,a);if(o)return i[o]=Bi(n),void delete i[a];var r=e?function(e){return e.trim().toLowerCase().replace(/([a-z\d])(\w*)/g,function(e,i,t){return i.toUpperCase()+t})}(a):String(a).trim();r!==a&&delete i[a],i[r]=Bi(n),t[r]=!0}),this}},{key:"concat",value:function(){for(var e,i=arguments.length,t=new Array(i),n=0;n1?t-1:0),a=1;a2&&void 0!==arguments[2]?arguments[2]:3,n=0,a=function(e,i){e=e||10;var t,n=new Array(e),a=new Array(e),o=0,r=0;return i=void 0!==i?i:1e3,function(l){var s=Date.now(),u=a[r];t||(t=s),n[o]=l,a[o]=s;for(var p=r,c=0;p!==o;)c+=n[p++],p%=e;if((o=(o+1)%e)===r&&(r=(r+1)%e),!(s-tn)return a&&(clearTimeout(a),a=null),t=r,e.apply(null,arguments);a||(a=setTimeout(function(){return a=null,t=Date.now(),e.apply(null,i)},n-(r-t)))}}(function(t){var o=t.loaded,r=t.lengthComputable?t.total:void 0,l=o-n,s=a(l);n=o;var u={loaded:o,total:r,progress:r?o/r:void 0,bytes:l,rate:s||void 0,estimated:s&&r&&o<=r?(r-o)/s:void 0,event:t,lengthComputable:null!=r};u[i?"download":"upload"]=!0,e(u)},t)},Qi=Ei.hasStandardBrowserEnv?function(){var e,i=/(msie|trident)/i.test(navigator.userAgent),t=document.createElement("a");function n(e){var n=e;return i&&(t.setAttribute("href",n),n=t.href),t.setAttribute("href",n),{href:t.href,protocol:t.protocol?t.protocol.replace(/:$/,""):"",host:t.host,search:t.search?t.search.replace(/^\?/,""):"",hash:t.hash?t.hash.replace(/^#/,""):"",hostname:t.hostname,port:t.port,pathname:"/"===t.pathname.charAt(0)?t.pathname:"/"+t.pathname}}return e=n(window.location.href),function(i){var t=pi.isString(i)?n(i):i;return t.protocol===e.protocol&&t.host===e.host}}():function(){return!0},Hi=Ei.hasStandardBrowserEnv?{write:function(e,i,t,n,a,o){var r=[e+"="+encodeURIComponent(i)];pi.isNumber(t)&&r.push("expires="+new Date(t).toGMTString()),pi.isString(n)&&r.push("path="+n),pi.isString(a)&&r.push("domain="+a),!0===o&&r.push("secure"),document.cookie=r.join("; ")},read:function(e){var i=document.cookie.match(new RegExp("(^|;\\s*)("+e+")=([^;]*)"));return i?decodeURIComponent(i[3]):null},remove:function(e){this.write(e,"",Date.now()-864e5)}}:{write:function(){},read:function(){return null},remove:function(){}};function Yi(e,i){return e&&!/^([a-z][a-z\d+\-.]*:)?\/\//i.test(i)?function(e,i){return i?e.replace(/\/?\/$/,"")+"/"+i.replace(/^\/+/,""):e}(e,i):i}var $i=function(e){return e instanceof Ni?u({},e):e};function Zi(e,i){i=i||{};var t={};function n(e,i,t){return pi.isPlainObject(e)&&pi.isPlainObject(i)?pi.merge.call({caseless:t},e,i):pi.isPlainObject(i)?pi.merge({},i):pi.isArray(i)?i.slice():i}function a(e,i,t){return pi.isUndefined(i)?pi.isUndefined(e)?void 0:n(void 0,e,t):n(e,i,t)}function o(e,i){if(!pi.isUndefined(i))return n(void 0,i)}function r(e,i){return pi.isUndefined(i)?pi.isUndefined(e)?void 0:n(void 0,e):n(void 0,i)}function l(t,a,o){return o in i?n(t,a):o in e?n(void 0,t):void 0}var s={url:o,method:o,data:o,baseURL:r,transformRequest:r,transformResponse:r,paramsSerializer:r,timeout:r,timeoutMessage:r,withCredentials:r,withXSRFToken:r,adapter:r,responseType:r,xsrfCookieName:r,xsrfHeaderName:r,onUploadProgress:r,onDownloadProgress:r,decompress:r,maxContentLength:r,maxBodyLength:r,beforeRedirect:r,transport:r,httpAgent:r,httpsAgent:r,cancelToken:r,socketPath:r,responseEncoding:r,validateStatus:l,headers:function(e,i){return a($i(e),$i(i),!0)}};return pi.forEach(Object.keys(Object.assign({},e,i)),function(n){var o=s[n]||a,r=o(e[n],i[n],n);pi.isUndefined(r)&&o!==l||(t[n]=r)}),t}var Xi,et,it,tt,nt=function(e){var i,t,n=Zi({},e),a=n.data,o=n.withXSRFToken,s=n.xsrfHeaderName,u=n.xsrfCookieName,p=n.headers,c=n.auth;if(n.headers=p=Ni.from(p),n.url=bi(Yi(n.baseURL,n.url),e.params,e.paramsSerializer),c&&p.set("Authorization","Basic "+btoa((c.username||"")+":"+(c.password?unescape(encodeURIComponent(c.password)):""))),pi.isFormData(a))if(Ei.hasStandardBrowserEnv||Ei.hasStandardBrowserWebWorkerEnv)p.setContentType(void 0);else if(!1!==(i=p.getContentType())){var d=i?i.split(";").map(function(e){return e.trim()}).filter(Boolean):[],g=y(t=d)||l(t)||f(t)||v(),h=g[0],m=g.slice(1);p.setContentType([h||"multipart/form-data"].concat(r(m)).join("; "))}if(Ei.hasStandardBrowserEnv&&(o&&pi.isFunction(o)&&(o=o(n)),o||!1!==o&&Qi(n.url))){var w=s&&u&&Hi.read(u);w&&p.set(s,w)}return n},at="undefined"!=typeof XMLHttpRequest&&function(e){return new Promise(function(i,t){var n,a=nt(e),o=a.data,r=Ni.from(a.headers).normalize(),l=a.responseType;function s(){a.cancelToken&&a.cancelToken.unsubscribe(n),a.signal&&a.signal.removeEventListener("abort",n)}var u=new XMLHttpRequest;function p(){if(u){var n=Ni.from("getAllResponseHeaders"in u&&u.getAllResponseHeaders());Vi(function(e){i(e),s()},function(e){t(e),s()},{data:l&&"text"!==l&&"json"!==l?u.response:u.responseText,status:u.status,statusText:u.statusText,headers:n,config:e,request:u}),u=null}}u.open(a.method.toUpperCase(),a.url,!0),u.timeout=a.timeout,"onloadend"in u?u.onloadend=p:u.onreadystatechange=function(){u&&4===u.readyState&&(0!==u.status||u.responseURL&&0===u.responseURL.indexOf("file:"))&&setTimeout(p)},u.onabort=function(){u&&(t(new ci("Request aborted",ci.ECONNABORTED,a,u)),u=null)},u.onerror=function(){t(new ci("Network Error",ci.ERR_NETWORK,a,u)),u=null},u.ontimeout=function(){var e=a.timeout?"timeout of "+a.timeout+"ms exceeded":"timeout exceeded",i=a.transitional||Pi;a.timeoutErrorMessage&&(e=a.timeoutErrorMessage),t(new ci(e,i.clarifyTimeoutError?ci.ETIMEDOUT:ci.ECONNABORTED,a,u)),u=null},void 0===o&&r.setContentType(null),"setRequestHeader"in u&&pi.forEach(r.toJSON(),function(e,i){u.setRequestHeader(i,e)}),pi.isUndefined(a.withCredentials)||(u.withCredentials=!!a.withCredentials),l&&"json"!==l&&(u.responseType=a.responseType),"function"==typeof a.onDownloadProgress&&u.addEventListener("progress",_i(a.onDownloadProgress,!0)),"function"==typeof a.onUploadProgress&&u.upload&&u.upload.addEventListener("progress",_i(a.onUploadProgress)),(a.cancelToken||a.signal)&&(n=function(i){u&&(t(!i||i.type?new Ji(null,e,u):i),u.abort(),u=null)},a.cancelToken&&a.cancelToken.subscribe(n),a.signal&&(a.signal.aborted?n():a.signal.addEventListener("abort",n)));var c,d,g=(c=a.url,(d=/^([-+\w]{1,25})(:?\/\/|:)/.exec(c))&&d[1]||"");g&&-1===Ei.protocols.indexOf(g)?t(new ci("Unsupported protocol "+g+":",ci.ERR_BAD_REQUEST,e)):u.send(o||null)})},ot=function(e,i){var t,n=new AbortController,a=function(e){if(!t){t=!0,r();var i=e instanceof Error?e:this.reason;n.abort(i instanceof ci?i:new Ji(i instanceof Error?i.message:i))}},o=i&&setTimeout(function(){a(new ci("timeout ".concat(i," of ms exceeded"),ci.ETIMEDOUT))},i),r=function(){e&&(o&&clearTimeout(o),o=null,e.forEach(function(e){e&&(e.removeEventListener?e.removeEventListener("abort",a):e.unsubscribe(a))}),e=null)};e.forEach(function(e){return e&&e.addEventListener&&e.addEventListener("abort",a)});var l=n.signal;return l.unsubscribe=r,[l,function(){o&&clearTimeout(o),o=null}]},rt=o().mark(function e(i,t){var n,a,r;return o().wrap(function(e){for(;;)switch(e.prev=e.next){case 0:if(n=i.byteLength,t&&!(n1?"since :\n"+l.map(yt).join("\n"):" "+yt(l[0]):"as no adapter specified"),"ERR_NOT_SUPPORT")}return t},adapters:wt};function At(e){if(e.cancelToken&&e.cancelToken.throwIfRequested(),e.signal&&e.signal.aborted)throw new Ji(null,e)}function bt(e){return At(e),e.headers=Ni.from(e.headers),e.data=Ki.call(e,e.transformRequest),-1!==["post","put","patch"].indexOf(e.method)&&e.headers.setContentType("application/x-www-form-urlencoded",!1),It.getAdapter(e.adapter||xi.adapter)(e).then(function(i){return At(e),i.data=Ki.call(e,e.transformResponse,i),i.headers=Ni.from(i.headers),i},function(i){return Fi(i)||(At(e),i&&i.response&&(i.response.data=Ki.call(e,e.transformResponse,i.response),i.response.headers=Ni.from(i.response.headers))),Promise.reject(i)})}var jt="1.7.2",kt={};["object","boolean","number","function","string","symbol"].forEach(function(e,i){kt[e]=function(t){return C(t)===e||"a"+(i<1?"n ":" ")+e}});var Pt={};kt.transitional=function(e,i,t){function n(e,i){return"[Axios v"+jt+"] Transitional option '"+e+"'"+i+(t?". "+t:"")}return function(t,a,o){if(!1===e)throw new ci(n(a," has been removed"+(i?" in "+i:"")),ci.ERR_DEPRECATED);return i&&!Pt[a]&&(Pt[a]=!0,console.warn(n(a," has been deprecated since v"+i+" and will be removed in the near future"))),!e||e(t,a,o)}};var Ot={assertOptions:function(e,i,t){if("object"!==C(e))throw new ci("options must be an object",ci.ERR_BAD_OPTION_VALUE);for(var n=Object.keys(e),a=n.length;a-- >0;){var o=n[a],r=i[o];if(r){var l=e[o],s=void 0===l||r(l,o,e);if(!0!==s)throw new ci("option "+o+" must be "+s,ci.ERR_BAD_OPTION_VALUE)}else if(!0!==t)throw new ci("Unknown option "+o,ci.ERR_BAD_OPTION)}},validators:kt},Mt=Ot.validators,Tt=function(){return g(function e(i){c(this,e),this.defaults=i,this.interceptors={request:new ki,response:new ki}},[{key:"request",value:function(){var e=a(o().mark(function e(i,t){var n,a;return o().wrap(function(e){for(;;)switch(e.prev=e.next){case 0:return e.prev=0,e.next=3,this._request(i,t);case 3:return e.abrupt("return",e.sent);case 6:if(e.prev=6,e.t0=e.catch(0),e.t0 instanceof Error){Error.captureStackTrace?Error.captureStackTrace(n={}):n=new Error,a=n.stack?n.stack.replace(/^.+\n/,""):"";try{e.t0.stack?a&&!String(e.t0.stack).endsWith(a.replace(/^.+\n.+\n/,""))&&(e.t0.stack+="\n"+a):e.t0.stack=a}catch(e){}}throw e.t0;case 10:case"end":return e.stop()}},e,this,[[0,6]])}));return function(i,t){return e.apply(this,arguments)}}()},{key:"_request",value:function(e,i){"string"==typeof e?(i=i||{}).url=e:i=e||{};var t=i=Zi(this.defaults,i),n=t.transitional,a=t.paramsSerializer,o=t.headers;void 0!==n&&Ot.assertOptions(n,{silentJSONParsing:Mt.transitional(Mt.boolean),forcedJSONParsing:Mt.transitional(Mt.boolean),clarifyTimeoutError:Mt.transitional(Mt.boolean)},!1),null!=a&&(pi.isFunction(a)?i.paramsSerializer={serialize:a}:Ot.assertOptions(a,{encode:Mt.function,serialize:Mt.function},!0)),i.method=(i.method||this.defaults.method||"get").toLowerCase();var r=o&&pi.merge(o.common,o[i.method]);o&&pi.forEach(["delete","get","head","post","put","patch","common"],function(e){delete o[e]}),i.headers=Ni.concat(r,o);var l=[],s=!0;this.interceptors.request.forEach(function(e){"function"==typeof e.runWhen&&!1===e.runWhen(i)||(s=s&&e.synchronous,l.unshift(e.fulfilled,e.rejected))});var u,p=[];this.interceptors.response.forEach(function(e){p.push(e.fulfilled,e.rejected)});var c,d=0;if(!s){var g=[bt.bind(this),void 0];for(g.unshift.apply(g,l),g.push.apply(g,p),c=g.length,u=Promise.resolve(i);d0;)n._listeners[i](e);n._listeners=null}}),this.promise.then=function(e){var i,t=new Promise(function(e){n.subscribe(e),i=e}).then(e);return t.cancel=function(){n.unsubscribe(i)},t},i(function(e,i,a){n.reason||(n.reason=new Ji(e,i,a),t(n.reason))})}return g(e,[{key:"throwIfRequested",value:function(){if(this.reason)throw this.reason}},{key:"subscribe",value:function(e){this.reason?e(this.reason):this._listeners?this._listeners.push(e):this._listeners=[e]}},{key:"unsubscribe",value:function(e){if(this._listeners){var i=this._listeners.indexOf(e);-1!==i&&this._listeners.splice(i,1)}}}],[{key:"source",value:function(){var i;return{token:new e(function(e){i=e}),cancel:i}}}])}();var Et={Continue:100,SwitchingProtocols:101,Processing:102,EarlyHints:103,Ok:200,Created:201,Accepted:202,NonAuthoritativeInformation:203,NoContent:204,ResetContent:205,PartialContent:206,MultiStatus:207,AlreadyReported:208,ImUsed:226,MultipleChoices:300,MovedPermanently:301,Found:302,SeeOther:303,NotModified:304,UseProxy:305,Unused:306,TemporaryRedirect:307,PermanentRedirect:308,BadRequest:400,Unauthorized:401,PaymentRequired:402,Forbidden:403,NotFound:404,MethodNotAllowed:405,NotAcceptable:406,ProxyAuthenticationRequired:407,RequestTimeout:408,Conflict:409,Gone:410,LengthRequired:411,PreconditionFailed:412,PayloadTooLarge:413,UriTooLong:414,UnsupportedMediaType:415,RangeNotSatisfiable:416,ExpectationFailed:417,ImATeapot:418,MisdirectedRequest:421,UnprocessableEntity:422,Locked:423,FailedDependency:424,TooEarly:425,UpgradeRequired:426,PreconditionRequired:428,TooManyRequests:429,RequestHeaderFieldsTooLarge:431,UnavailableForLegalReasons:451,InternalServerError:500,NotImplemented:501,BadGateway:502,ServiceUnavailable:503,GatewayTimeout:504,HttpVersionNotSupported:505,VariantAlsoNegotiates:506,InsufficientStorage:507,LoopDetected:508,NotExtended:510,NetworkAuthenticationRequired:511};Object.entries(Et).forEach(function(e){var i=m(e,2),t=i[0],n=i[1];Et[n]=t});var Gt=Et;var Ut=function e(i){var t=new qt(i),n=Pe(qt.prototype.request,t);return pi.extend(n,qt.prototype,t,{allOwnKeys:!0}),pi.extend(n,t,null,{allOwnKeys:!0}),n.create=function(t){return e(Zi(i,t))},n}(xi);Ut.Axios=qt,Ut.CanceledError=Ji,Ut.CancelToken=St,Ut.isCancel=Fi,Ut.VERSION=jt,Ut.toFormData=wi,Ut.AxiosError=ci,Ut.Cancel=Ut.CanceledError,Ut.all=function(e){return Promise.all(e)},Ut.spread=function(e){return function(i){return e.apply(null,i)}},Ut.isAxiosError=function(e){return pi.isObject(e)&&!0===e.isAxiosError},Ut.mergeConfig=Zi,Ut.AxiosHeaders=Ni,Ut.formToJSON=function(e){return Gi(pi.isHTMLForm(e)?new FormData(e):e)},Ut.getAdapter=It.getAdapter,Ut.HttpStatusCode=Gt,Ut.default=Ut;var xt=Ut,Rt={level:{LNone:"none",LError:"error",LDebug:"debug",LTrace:"trace"}},Dt={formats:{JSON:"json",TEXT:"text"}},zt=function(){return g(function e(){c(this,e),this.log_level=Rt.level.LNone,this.log_format=Dt.formats.TEXT,this.log_to_console=!0,this.log_file_path,this.log_response_body=!1,this.log_request_body=!1,this.setLogger()},[{key:"logLevelEnum",get:function(){return Rt}},{key:"logFormatEnum",get:function(){return Dt}},{key:"setLogger",value:function(){}},{key:"log",value:function(e,i,t,n,a,o,r,l){var s=this.formatLog(e,i,t,n,a,o,r,l);"undefined"!=typeof window?this.calculateLogLevel(e)>0&&!0===this.log_to_console&&(this.log_format===this.logFormatEnum.formats.JSON?console.log(s):console.log("".concat(e.toUpperCase(),": ").concat(s))):this.logger.transports.length>0&&this.logger.log(e,s)}},{key:"calculateLogLevel",value:function(e){switch(this.log_level){case this.logLevelEnum.level.LError:return e!==this.logLevelEnum.level.LError?-1:1;case this.logLevelEnum.level.LDebug:return e===this.logLevelEnum.level.LTrace?-1:1;case this.logLevelEnum.level.LTrace:return 1;default:return-1}}},{key:"formatLog",value:function(e,i,t,n,a,o,r,l){var s,u=a?JSON.parse(JSON.stringify(a)):null,p=o?JSON.parse(JSON.stringify(o)):null,c=r?JSON.parse(JSON.stringify(r)):null,d=l?JSON.parse(JSON.stringify(l)):null;return a&&(u.Authorization="[REDACTED]"),this.log_request_body||(c=void 0),this.log_response_body||(d=void 0),this.log_format&&this.log_format===Dt.formats.JSON?(s={level:e,date:(new Date).toISOString(),method:t,url:decodeURIComponent(n),correlationId:p&&p["inin-correlation-id"]?p["inin-correlation-id"]:"",statusCode:i},u&&(s.requestHeaders=u),p&&(s.responseHeaders=p),c&&(s.requestBody=c),d&&(s.responseBody=d)):s="".concat((new Date).toISOString(),"\n=== REQUEST === \n").concat(this.formatValue("URL",decodeURIComponent(n))).concat(this.formatValue("Method",t)).concat(this.formatValue("Headers",this.formatHeaderString(u))).concat(this.formatValue("Body",c?JSON.stringify(c,null,2):""),"\n=== RESPONSE ===\n").concat(this.formatValue("Status",i)).concat(this.formatValue("Headers",this.formatHeaderString(p))).concat(this.formatValue("CorrelationId",p&&p["inin-correlation-id"]?p["inin-correlation-id"]:"")).concat(this.formatValue("Body",d?JSON.stringify(d,null,2):"")),s}},{key:"formatHeaderString",value:function(e){var i="";if(!e)return i;for(var t=0,n=Object.entries(e);t128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");var i="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";return Array.from(crypto.getRandomValues(new Uint32Array(e))).map(function(e){return i[e%i.length]}).join("")}},{key:"computePKCECodeChallenge",value:function(e){if(e.length<43||e.length>128)throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");var i=(new TextEncoder).encode(e);return new Promise(function(e,t){window.crypto.subtle.digest("SHA-256",i).then(function(i){var t=K.from(i).toString("base64").replaceAll("+","-").replaceAll("/","_");t=t.split("=")[0],e(t)}).catch(function(e){return t(new Error("Code Challenge Error ".concat(e)))})})}},{key:"loginPKCEGrant",value:function(e,i,t,n){var a=this;if(!this.hasLocalStorage&&!n)throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");var o=this._setValuesFromUrlQuery();return this.clientId=e,this.redirectUri=i,this.codeVerifier=n,t||(t={}),new Promise(function(e,i){if(t.org&&!t.provider?i(new Error("opts.provider must be set if opts.org is set")):t.provider&&!t.org&&i(new Error("opts.org must be set if opts.provider is set")),o&&o.error)return a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),a._saveSettings({accessToken:void 0}),i(new Error("[".concat(o.error,"] ").concat(o.error_description)));o&&o.code?(a.codeVerifier||a.hasLocalStorage&&(a.codeVerifier=sessionStorage.getItem("genesys_cloud_sdk_pkce_code_verifier")),a.authorizePKCEGrant(a.clientId,a.codeVerifier,o.code,a.redirectUri).then(function(){a._testTokenAccess().then(function(){!a.authData.state&&o.state&&(a.authData.state=o.state),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),e(a.authData)}).catch(function(e){return a._saveSettings({accessToken:void 0}),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error("[".concat(e.name,"] ").concat(e.msg)))})}).catch(function(e){return a._saveSettings({accessToken:void 0}),a.hasLocalStorage&&sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier"),i(new Error("[".concat(e.name,"] ").concat(e.msg)))})):a._testTokenAccess().then(function(){!a.authData.state&&t.state&&(a.authData.state=t.state),e(a.authData)}).catch(function(e){a.codeVerifier||(a.codeVerifier=a.generatePKCECodeVerifier(128),a.hasLocalStorage&&sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",a.codeVerifier)),a.computePKCECodeChallenge(a.codeVerifier).then(function(e){var i={client_id:encodeURIComponent(a.clientId),redirect_uri:encodeURIComponent(a.redirectUri),code_challenge:encodeURIComponent(e),response_type:"code",code_challenge_method:"S256"};t.state&&(i.state=encodeURIComponent(t.state)),t.org&&(i.org=encodeURIComponent(t.org)),t.provider&&(i.provider=encodeURIComponent(t.provider));var n=a._buildAuthUrl("oauth/authorize",i);window.location.replace(n)}).catch(function(e){return i(new Error("[".concat(e.name,"]")))})})})}},{key:"_setValuesFromUrlQuery",value:function(){if("undefined"!=typeof window&&window.location.search){var e={},i=new URLSearchParams(window.location.search),t=i.get("code"),n=i.get("error"),a=i.get("error_description"),o=i.get("state");if(n)return e.error=n,a&&(e.error_description=a),e;t&&(e.code=t,o&&(e.state=o));var r,l,s=window.location;return"replaceState"in history?history.replaceState("",document.title,s.pathname):(r=document.body.scrollTop,l=document.body.scrollLeft,history.pushState("",document.title,s.pathname),document.body.scrollTop=r,document.body.scrollLeft=l),e}}},{key:"loginCodeAuthorizationGrant",value:function(e,i,t,n){var a=this;return this.clientId=e,this.clientSecret=i,new Promise(function(o,r){if("undefined"==typeof window){var l=K.from(e+":"+i).toString("base64"),s=a._formAuthRequest(l,{grant_type:"authorization_code",code:t,redirect_uri:n});s.proxy=a.proxy;var u={grant_type:"authorization_code",code:t,redirect_uri:n};a._handleCodeAuthorizationResponse(s,u,o,r)}else r(new Error("The Code Authorization grant is not supported in a browser."))})}},{key:"refreshCodeAuthorizationGrant",value:function(e,i,t){var n=this;return new Promise(function(a,o){if("undefined"==typeof window){var r=K.from(e+":"+i).toString("base64"),l=n._formAuthRequest(r,{grant_type:"refresh_token",refresh_token:t});l.proxy=n.proxy;var s={grant_type:"refresh_token",refresh_token:t};n._handleCodeAuthorizationResponse(l,s,a,o)}else o(new Error("The Code Authorization grant is not supported in a browser."))})}},{key:"_handleCodeAuthorizationResponse",value:function(e,i,t,n){var a=this;e.then(function(n){a.config.logger.log("trace",n.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,n.headers,i,void 0),a.config.logger.log("debug",n.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,void 0,i,void 0);var o=n.data.access_token,r=n.data.refresh_token;a.setAccessToken(o),a.authData.refreshToken=r,a.authData.tokenExpiryTime=(new Date).getTime()+1e3*n.data.expires_in,a.authData.tokenExpiryTimeString=new Date(a.authData.tokenExpiryTime).toUTCString(),t(a.authData)}).catch(function(t){t.response&&a.config.logger.log("error",t.response.status,"POST","https://login.".concat(a.config.environment,"/oauth/token"),e.headers,t.response.headers,i,t.response.data),n(t)})}},{key:"_formAuthRequest",value:function(e,i){return xt({method:"POST",url:"https://login.".concat(this.config.environment,"/oauth/token"),headers:{Authorization:"Basic "+e,"Content-Type":"application/x-www-form-urlencoded"},data:O.default.stringify(i)})}},{key:"_handleExpiredAccessToken",value:function(){var e=this;return new Promise(function(i,t){"undefined"==typeof window?e.refreshInProgress?e._sleep(e.config.refresh_token_wait_max).then(function(){e.refreshInProgress?t(new Error("Token refresh took longer than ".concat(e.config.refresh_token_wait_max," seconds"))):i()}):(e.refreshInProgress=!0,e.refreshCodeAuthorizationGrant(e.clientId,e.clientSecret,e.authData.refreshToken).then(function(){e.refreshInProgress=!1,i()}).catch(function(i){e.refreshInProgress=!1,t(i)})):t(new Error("This method is not supported in a browser."))})}},{key:"_sleep",value:function(e){return new Promise(function(i){return setTimeout(i,e)})}},{key:"_testTokenAccess",value:function(){var e=this;return new Promise(function(i,t){e._loadSettings(),e.authentications["PureCloud OAuth"].accessToken?e.callApi("/api/v2/tokens/me","GET",null,null,null,null,null,["PureCloud OAuth"],["application/json"],["application/json"]).then(function(){i()}).catch(function(i){e._saveSettings({accessToken:void 0}),t(i)}):t(new Error("Token is not set"))})}},{key:"_setValuesFromUrlHash",value:function(){if("undefined"!=typeof window&&window.location.hash){var e=new RegExp("^#*(.+?)=(.+?)$","i"),i={};if(window.location.hash.split("&").forEach(function(t){var n=e.exec(t);n&&(i[n[1]]=decodeURIComponent(decodeURIComponent(n[2].replace(/\+/g,"%20"))))}),i.error)return i;if(i.access_token){var t={};i.state&&(t.state=i.state),i.expires_in&&(t.tokenExpiryTime=(new Date).getTime()+1e3*parseInt(i.expires_in.replace(/\+/g,"%20")),t.tokenExpiryTimeString=new Date(t.tokenExpiryTime).toUTCString()),t.accessToken=i.access_token.replace(/\+/g,"%20");var n,a,o=window.location;"replaceState"in history?history.replaceState("",document.title,o.pathname+o.search):(n=document.body.scrollTop,a=document.body.scrollLeft,o.hash="",document.body.scrollTop=n,document.body.scrollLeft=a),this._saveSettings(t)}}}},{key:"setAccessToken",value:function(e){this._saveSettings({accessToken:e})}},{key:"setStorageKey",value:function(e){this.storageKey=e,this.setAccessToken(this.authentications["PureCloud OAuth"].accessToken)}},{key:"logout",value:function(e){this.hasLocalStorage&&this._saveSettings({accessToken:void 0,state:void 0,tokenExpiryTime:void 0,tokenExpiryTimeString:void 0});var i={client_id:encodeURIComponent(this.clientId)};e&&(i.redirect_uri=encodeURI(e));var t=this._buildAuthUrl("logout",i);window.location.replace(t)}},{key:"_buildAuthUrl",value:function(e,i){return i||(i={}),Object.keys(i).reduce(function(e,t){return i[t]?"".concat(e,"&").concat(t,"=").concat(i[t]):e},"".concat(this.config.authUrl,"/").concat(e,"?"))}},{key:"paramToString",value:function(e){return e?e instanceof Date?e.toJSON():e instanceof Boolean?e.toString().toLowerCase():e.toString():""}},{key:"serialize",value:function(e){var i={};for(var t in e)e.hasOwnProperty(t)&&void 0!==e[t]&&(i[encodeURIComponent(t)]=Array.isArray(e[t])?e[t].join(","):this.paramToString(e[t]));return i}},{key:"addHeaders",value:function(e){for(var i=arguments.length,t=new Array(i>1?i-1:0),n=1;n + +# AsyncQueryStatus getAnalyticsAgentcopilotsAggregatesJob(jobId) + + +GET /api/v2/analytics/agentcopilots/aggregates/jobs/{jobId} + +Get status for async query for agent copilot aggregates + +getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + +Requires ANY permissions: + +* analytics:agentCopilotAggregate:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.AnalyticsApi(); + +let jobId = "jobId_example"; // String | jobId + +apiInstance.getAnalyticsAgentcopilotsAggregatesJob(jobId) + .then((data) => { + console.log(`getAnalyticsAgentcopilotsAggregatesJob success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getAnalyticsAgentcopilotsAggregatesJob'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **jobId** | **String** | jobId | | +{: class="table table-striped"} + +### Return type + +**AsyncQueryStatus** + + + +# AgentCopilotAsyncAggregateQueryResponse getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) + + +GET /api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results + +Fetch a page of results for an async aggregates query + +getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + +Requires ANY permissions: + +* analytics:agentCopilotAggregate:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.AnalyticsApi(); + +let jobId = "jobId_example"; // String | jobId +let opts = { + 'cursor': "cursor_example" // String | Cursor token to retrieve next page +}; + +apiInstance.getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) + .then((data) => { + console.log(`getAnalyticsAgentcopilotsAggregatesJobResults success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getAnalyticsAgentcopilotsAggregatesJobResults'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **jobId** | **String** | jobId | | + **cursor** | **String** | Cursor token to retrieve next page | [optional] | +{: class="table table-striped"} + +### Return type + +**AgentCopilotAsyncAggregateQueryResponse** + # ReportingTurnsResponse getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) @@ -1823,6 +1936,66 @@ This endpoint does not need any parameter. **AnalyticsReportingSettings** + + +# DashboardConfigurationListing getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) + + +GET /api/v2/analytics/reporting/settings/dashboards/query + +Get list of dashboard configurations + +Requires ALL permissions: + +* analytics:dashboardConfigurations:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.AnalyticsApi(); + +let dashboardType = "dashboardType_example"; // String | List dashboard of given type +let dashboardAccessFilter = "dashboardAccessFilter_example"; // String | Filter dashboard based on the owner of dashboard +let opts = { + 'sortBy': "desc", // String | + 'pageNumber': 1, // Number | + 'pageSize': 9 // Number | +}; + +apiInstance.getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) + .then((data) => { + console.log(`getAnalyticsReportingSettingsDashboardsQuery success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getAnalyticsReportingSettingsDashboardsQuery'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **dashboardType** | **String** | List dashboard of given type |
**Values**: All, Public, Private, Shared, Favorites | + **dashboardAccessFilter** | **String** | Filter dashboard based on the owner of dashboard |
**Values**: OwnedByMe, OwnedByAnyone, NotOwnedByMe | + **sortBy** | **String** | | [optional] [default to desc] | + **pageNumber** | **Number** | | [optional] [default to 1] | + **pageSize** | **Number** | | [optional] [default to 9] | +{: class="table table-striped"} + +### Return type + +**DashboardConfigurationListing** + # DashboardConfigurationListing getAnalyticsReportingSettingsUserDashboards(userId, opts) @@ -2732,6 +2905,110 @@ apiInstance.postAnalyticsActionsAggregatesQuery(body) **ActionAggregateQueryResponse** + + +# AsyncQueryResponse postAnalyticsAgentcopilotsAggregatesJobs(body) + + +POST /api/v2/analytics/agentcopilots/aggregates/jobs + +Query for agent copilot aggregates asynchronously + +postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + +Requires ANY permissions: + +* analytics:agentCopilotAggregate:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.AnalyticsApi(); + +let body = {}; // Object | query + +apiInstance.postAnalyticsAgentcopilotsAggregatesJobs(body) + .then((data) => { + console.log(`postAnalyticsAgentcopilotsAggregatesJobs success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling postAnalyticsAgentcopilotsAggregatesJobs'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **body** | **Object** | query | | +{: class="table table-striped"} + +### Return type + +**AsyncQueryResponse** + + + +# AgentCopilotAggregateQueryResponse postAnalyticsAgentcopilotsAggregatesQuery(body) + + +POST /api/v2/analytics/agentcopilots/aggregates/query + +Query for agent copilot aggregates + +postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + +Requires ANY permissions: + +* analytics:agentCopilotAggregate:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.AnalyticsApi(); + +let body = {}; // Object | query + +apiInstance.postAnalyticsAgentcopilotsAggregatesQuery(body) + .then((data) => { + console.log(`postAnalyticsAgentcopilotsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling postAnalyticsAgentcopilotsAggregatesQuery'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **body** | **Object** | query | | +{: class="table table-striped"} + +### Return type + +**AgentCopilotAggregateQueryResponse** + # AsyncQueryResponse postAnalyticsBotsAggregatesJobs(body) @@ -3869,7 +4146,9 @@ apiInstance.postAnalyticsQueuesObservationsQuery(body) POST /api/v2/analytics/ratelimits/aggregates/query -Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded +Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + +The max property can be used to determine estimated rate limit value hit. Requires ANY permissions: diff --git a/build/docs/ConversationsApi.md b/build/docs/ConversationsApi.md index c027117c..bff61baa 100644 --- a/build/docs/ConversationsApi.md +++ b/build/docs/ConversationsApi.md @@ -93,7 +93,6 @@ All URIs are relative to *https://api.mypurecloud.com* [**getConversationsMessagingSetting**](ConversationsApi.html#getConversationsMessagingSetting) | **GET** /api/v2/conversations/messaging/settings/{messageSettingId} | Get a messaging setting [**getConversationsMessagingSettings**](ConversationsApi.html#getConversationsMessagingSettings) | **GET** /api/v2/conversations/messaging/settings | Get a list of messaging settings [**getConversationsMessagingSettingsDefault**](ConversationsApi.html#getConversationsMessagingSettingsDefault) | **GET** /api/v2/conversations/messaging/settings/default | Get the organization's default settings that will be used as the default when creating an integration. -[**getConversationsMessagingSticker**](ConversationsApi.html#getConversationsMessagingSticker) | **GET** /api/v2/conversations/messaging/stickers/{messengerType} | Get a list of Messaging Stickers (Deprecated) [**getConversationsMessagingSupportedcontent**](ConversationsApi.html#getConversationsMessagingSupportedcontent) | **GET** /api/v2/conversations/messaging/supportedcontent | Get a list of Supported Content profiles [**getConversationsMessagingSupportedcontentDefault**](ConversationsApi.html#getConversationsMessagingSupportedcontentDefault) | **GET** /api/v2/conversations/messaging/supportedcontent/default | Get the organization's default supported content profile that will be used as the default when creating an integration. [**getConversationsMessagingSupportedcontentSupportedContentId**](ConversationsApi.html#getConversationsMessagingSupportedcontentSupportedContentId) | **GET** /api/v2/conversations/messaging/supportedcontent/{supportedContentId} | Get a supported content profile @@ -191,6 +190,7 @@ All URIs are relative to *https://api.mypurecloud.com* [**postConversationsEmailMessagesDraftAttachmentsCopy**](ConversationsApi.html#postConversationsEmailMessagesDraftAttachmentsCopy) | **POST** /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy | Copy attachments from an email message to the current draft. [**postConversationsEmailParticipantCommunicationWrapup**](ConversationsApi.html#postConversationsEmailParticipantCommunicationWrapup) | **POST** /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup | Apply wrap-up for this conversation communication [**postConversationsEmailParticipantReplace**](ConversationsApi.html#postConversationsEmailParticipantReplace) | **POST** /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address +[**postConversationsEmailReconnect**](ConversationsApi.html#postConversationsEmailReconnect) | **POST** /api/v2/conversations/emails/{conversationId}/reconnect | Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation [**postConversationsEmails**](ConversationsApi.html#postConversationsEmails) | **POST** /api/v2/conversations/emails | Create an email conversation [**postConversationsEmailsAgentless**](ConversationsApi.html#postConversationsEmailsAgentless) | **POST** /api/v2/conversations/emails/agentless | Create an email conversation, per API [**postConversationsFaxes**](ConversationsApi.html#postConversationsFaxes) | **POST** /api/v2/conversations/faxes | Create Fax Conversation @@ -4667,65 +4667,6 @@ This endpoint does not need any parameter. **MessagingSetting** - - -# MessagingStickerEntityListing getConversationsMessagingSticker(messengerType, opts) - -DEPRECATED - -GET /api/v2/conversations/messaging/stickers/{messengerType} - -Get a list of Messaging Stickers (Deprecated) - -This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - -Requires ALL permissions: - -* conversation:message:create - -### Example Usage - -```{"language":"javascript"} -// Browser -const platformClient = require('platformClient'); -// Node -const platformClient = require('purecloud-platform-client-v2'); - -// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) -platformClient.ApiClient.instance.setAccessToken(yourAccessToken); - -let apiInstance = new platformClient.ConversationsApi(); - -let messengerType = "messengerType_example"; // String | Messenger Type -let opts = { - 'pageSize': 25, // Number | Page size - 'pageNumber': 1 // Number | Page number -}; - -apiInstance.getConversationsMessagingSticker(messengerType, opts) - .then((data) => { - console.log(`getConversationsMessagingSticker success! data: ${JSON.stringify(data, null, 2)}`); - }) - .catch((err) => { - console.log('There was a failure calling getConversationsMessagingSticker'); - console.error(err); - }); -``` - -### Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | - **messengerType** | **String** | Messenger Type |
**Values**: line | - **pageSize** | **Number** | Page size | [optional] [default to 25] | - **pageNumber** | **Number** | Page number | [optional] [default to 1] | -{: class="table table-striped"} - -### Return type - -**MessagingStickerEntityListing** - # SupportedContentListing getConversationsMessagingSupportedcontent(opts) @@ -9894,6 +9835,56 @@ apiInstance.postConversationsEmailParticipantReplace(conversationId, participant void (no response body) + + +# void postConversationsEmailReconnect(conversationId) + + +POST /api/v2/conversations/emails/{conversationId}/reconnect + +Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + +Requires ANY permissions: + +* conversation:communication:reconnect + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.ConversationsApi(); + +let conversationId = "conversationId_example"; // String | conversationId + +apiInstance.postConversationsEmailReconnect(conversationId) + .then(() => { + console.log('postConversationsEmailReconnect returned successfully.'); + }) + .catch((err) => { + console.log('There was a failure calling postConversationsEmailReconnect'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **conversationId** | **String** | conversationId | | +{: class="table table-striped"} + +### Return type + +void (no response body) + # EmailConversation postConversationsEmails(body) diff --git a/build/docs/GroupsApi.md b/build/docs/GroupsApi.md index c845c25b..4c406d65 100644 --- a/build/docs/GroupsApi.md +++ b/build/docs/GroupsApi.md @@ -221,7 +221,7 @@ apiInstance.getFieldconfig(type) | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | - **type** | **String** | Field type |
**Values**: person, group, org, externalContact | + **type** | **String** | Field type |
**Values**: person, group, org | {: class="table table-striped"} ### Return type diff --git a/build/docs/JourneyApi.md b/build/docs/JourneyApi.md index 6c81b499..30fa5eac 100644 --- a/build/docs/JourneyApi.md +++ b/build/docs/JourneyApi.md @@ -1900,7 +1900,7 @@ apiInstance.getJourneyViewVersionJobsLatest(viewId, journeyVersionId) -# AddressableEntityListing getJourneyViews() +# JourneyViewListing getJourneyViews() GET /api/v2/journey/views @@ -1943,7 +1943,7 @@ This endpoint does not need any parameter. ### Return type -**AddressableEntityListing** +**JourneyViewListing** diff --git a/build/docs/KnowledgeApi.md b/build/docs/KnowledgeApi.md index 5b700109..30fbad77 100644 --- a/build/docs/KnowledgeApi.md +++ b/build/docs/KnowledgeApi.md @@ -517,7 +517,7 @@ apiInstance.deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBa | ------------- | ------------- | ------------- | ------------- | **categoryId** | **String** | Category ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | {: class="table table-striped"} ### Return type @@ -572,7 +572,7 @@ apiInstance.deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBa | ------------- | ------------- | ------------- | ------------- | **documentId** | **String** | Document ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | {: class="table table-striped"} ### Return type @@ -626,7 +626,7 @@ apiInstance.deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **importId** | **String** | Import ID | | {: class="table table-striped"} @@ -1864,7 +1864,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languag | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **before** | **String** | The cursor that points to the start of the set of entities that has been returned. | [optional] | **after** | **String** | The cursor that points to the end of the set of entities that has been returned. | [optional] | **limit** | **String** | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize | [optional] | @@ -1924,7 +1924,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseI | ------------- | ------------- | ------------- | ------------- | **categoryId** | **String** | Category ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | {: class="table table-striped"} ### Return type @@ -1979,7 +1979,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseI | ------------- | ------------- | ------------- | ------------- | **documentId** | **String** | Document ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | {: class="table table-striped"} ### Return type @@ -2037,7 +2037,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledg | ------------- | ------------- | ------------- | ------------- | **documentId** | **String** | Document ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **uploadId** | **String** | UploadId | | {: class="table table-striped"} @@ -2102,7 +2102,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, language | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **before** | **String** | The cursor that points to the start of the set of entities that has been returned. | [optional] | **after** | **String** | The cursor that points to the end of the set of entities that has been returned. | [optional] | **limit** | **String** | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize | [optional] | @@ -2165,7 +2165,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, la | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **importId** | **String** | Import ID | | {: class="table table-striped"} @@ -2220,7 +2220,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageC | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **trainingId** | **String** | Training ID | | {: class="table table-striped"} @@ -2281,7 +2281,7 @@ apiInstance.getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, language | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **before** | **String** | The cursor that points to the start of the set of entities that has been returned. | [optional] | **after** | **String** | The cursor that points to the end of the set of entities that has been returned. | [optional] | **limit** | **String** | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize | [optional] | @@ -2329,7 +2329,8 @@ let opts = { 'userId': ["userId_example"], // [String] | If specified, retrieves operations associated with user ids, comma separated values expected. 'type': ["type_example"], // [String] | If specified, retrieves operations with specified operation type, comma separated values expected. 'status': ["status_example"], // [String] | If specified, retrieves operations with specified operation status, comma separated values expected. - 'interval': "interval_example" // String | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + 'interval': "interval_example", // String | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + 'sourceId': ["sourceId_example"] // [String] | If specified, retrieves operations associated with source ids, comma separated values expected. }; apiInstance.getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) @@ -2355,6 +2356,7 @@ apiInstance.getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) **type** | **[String]** | If specified, retrieves operations with specified operation type, comma separated values expected. | [optional]
**Values**: Export, Import, Parse, Sync | **status** | **[String]** | If specified, retrieves operations with specified operation status, comma separated values expected. | [optional] | **interval** | **String** | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ | [optional] | + **sourceId** | **[String]** | If specified, retrieves operations associated with source ids, comma separated values expected. | [optional] | {: class="table table-striped"} ### Return type @@ -2763,7 +2765,7 @@ apiInstance.getKnowledgeKnowledgebases(opts) **limit** | **String** | Number of entities to return. Maximum of 100. Deprecated in favour of pageSize | [optional] | **pageSize** | **String** | Number of entities to return. Maximum of 100. | [optional] | **name** | **String** | Filter by Name. | [optional] | - **coreLanguage** | **String** | Filter by core language. | [optional]
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **coreLanguage** | **String** | Filter by core language. | [optional]
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **published** | **Boolean** | Filter by published status. | [optional] | **sortBy** | **String** | Sort by. | [optional]
**Values**: Name, Date | **sortOrder** | **String** | Sort Order. | [optional]
**Values**: ASC, ascending, DESC, descending | @@ -3251,7 +3253,7 @@ apiInstance.patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBas | ------------- | ------------- | ------------- | ------------- | **categoryId** | **String** | Category ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -3308,7 +3310,7 @@ apiInstance.patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBas | ------------- | ------------- | ------------- | ------------- | **documentId** | **String** | Document ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -3363,7 +3365,7 @@ apiInstance.patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, langua | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -3420,7 +3422,7 @@ apiInstance.patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **importId** | **String** | Import ID | | **body** | **Object** | | | {: class="table table-striped"} @@ -4849,7 +4851,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, langua | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -4908,7 +4910,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowle | ------------- | ------------- | ------------- | ------------- | **documentId** | **String** | Document ID | | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -4963,7 +4965,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languag | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -5018,7 +5020,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **body** | **Object** | | | {: class="table table-striped"} @@ -5073,7 +5075,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, l | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | **trainingId** | **String** | Training ID | | {: class="table table-striped"} @@ -5127,7 +5129,7 @@ apiInstance.postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languag | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | **knowledgeBaseId** | **String** | Knowledge base ID | | - **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL | + **languageCode** | **String** | Language code, format: iso2-LOCALE |
**Values**: en-US, en-UK, en-AU, en-CA, en-HK, en-IN, en-IE, en-NZ, en-PH, en-SG, en-ZA, de-DE, de-AT, de-CH, es-AR, es-CO, es-MX, es-US, es-ES, fr-FR, fr-BE, fr-CA, fr-CH, pt-BR, pt-PT, nl-NL, nl-BE, it-IT, ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA | {: class="table table-striped"} ### Return type diff --git a/build/docs/LearningApi.md b/build/docs/LearningApi.md index b6a46b0d..244fef6f 100644 --- a/build/docs/LearningApi.md +++ b/build/docs/LearningApi.md @@ -10,17 +10,21 @@ All URIs are relative to *https://api.mypurecloud.com* [**deleteLearningAssignment**](LearningApi.html#deleteLearningAssignment) | **DELETE** /api/v2/learning/assignments/{assignmentId} | Delete a learning assignment [**deleteLearningModule**](LearningApi.html#deleteLearningModule) | **DELETE** /api/v2/learning/modules/{moduleId} | Delete a learning module [**getLearningAssignment**](LearningApi.html#getLearningAssignment) | **GET** /api/v2/learning/assignments/{assignmentId} | Get Learning Assignment +[**getLearningAssignmentStep**](LearningApi.html#getLearningAssignmentStep) | **GET** /api/v2/learning/assignments/{assignmentId}/steps/{stepId} | Get Learning Assignment Step [**getLearningAssignments**](LearningApi.html#getLearningAssignments) | **GET** /api/v2/learning/assignments | List of Learning module Assignments [**getLearningAssignmentsMe**](LearningApi.html#getLearningAssignmentsMe) | **GET** /api/v2/learning/assignments/me | List of Learning Assignments assigned to current user [**getLearningModule**](LearningApi.html#getLearningModule) | **GET** /api/v2/learning/modules/{moduleId} | Get a learning module [**getLearningModuleJob**](LearningApi.html#getLearningModuleJob) | **GET** /api/v2/learning/modules/{moduleId}/jobs/{jobId} | Get a specific Learning Module job status +[**getLearningModulePreview**](LearningApi.html#getLearningModulePreview) | **GET** /api/v2/learning/modules/{moduleId}/preview | Get a learning module preview [**getLearningModuleRule**](LearningApi.html#getLearningModuleRule) | **GET** /api/v2/learning/modules/{moduleId}/rule | Get a learning module rule [**getLearningModuleVersion**](LearningApi.html#getLearningModuleVersion) | **GET** /api/v2/learning/modules/{moduleId}/versions/{versionId} | Get specific version of a published module [**getLearningModules**](LearningApi.html#getLearningModules) | **GET** /api/v2/learning/modules | Get all learning modules of an organization [**getLearningModulesAssignments**](LearningApi.html#getLearningModulesAssignments) | **GET** /api/v2/learning/modules/assignments | Get all learning modules of an organization including assignments for a specific user [**getLearningModulesCoverartCoverArtId**](LearningApi.html#getLearningModulesCoverartCoverArtId) | **GET** /api/v2/learning/modules/coverart/{coverArtId} | Get a specific Learning Module cover art using ID +[**getLearningScormScormId**](LearningApi.html#getLearningScormScormId) | **GET** /api/v2/learning/scorm/{scormId} | Get Learning SCORM Result [**patchLearningAssignment**](LearningApi.html#patchLearningAssignment) | **PATCH** /api/v2/learning/assignments/{assignmentId} | Update Learning Assignment [**patchLearningAssignmentReschedule**](LearningApi.html#patchLearningAssignmentReschedule) | **PATCH** /api/v2/learning/assignments/{assignmentId}/reschedule | Reschedule Learning Assignment +[**patchLearningAssignmentStep**](LearningApi.html#patchLearningAssignmentStep) | **PATCH** /api/v2/learning/assignments/{assignmentId}/steps/{stepId} | Update Learning Assignment Step [**patchLearningModuleUserAssignments**](LearningApi.html#patchLearningModuleUserAssignments) | **PATCH** /api/v2/learning/modules/{moduleId}/users/{userId}/assignments | Update an external assignment for a specific user [**postLearningAssessmentsScoring**](LearningApi.html#postLearningAssessmentsScoring) | **POST** /api/v2/learning/assessments/scoring | Score learning assessment for preview [**postLearningAssignmentReassign**](LearningApi.html#postLearningAssignmentReassign) | **POST** /api/v2/learning/assignments/{assignmentId}/reassign | Reassign Learning Assignment @@ -34,7 +38,9 @@ All URIs are relative to *https://api.mypurecloud.com* [**postLearningModules**](LearningApi.html#postLearningModules) | **POST** /api/v2/learning/modules | Create a new learning module [**postLearningRulesQuery**](LearningApi.html#postLearningRulesQuery) | **POST** /api/v2/learning/rules/query | Get users for learning module rule [**postLearningScheduleslotsQuery**](LearningApi.html#postLearningScheduleslotsQuery) | **POST** /api/v2/learning/scheduleslots/query | Get list of possible slots where a learning activity can be scheduled. +[**postLearningScorm**](LearningApi.html#postLearningScorm) | **POST** /api/v2/learning/scorm | Create a SCORM package upload request [**putLearningModule**](LearningApi.html#putLearningModule) | **PUT** /api/v2/learning/modules/{moduleId} | Update a learning module +[**putLearningModulePreview**](LearningApi.html#putLearningModulePreview) | **PUT** /api/v2/learning/modules/{moduleId}/preview | Update a learning module preview [**putLearningModuleRule**](LearningApi.html#putLearningModuleRule) | **PUT** /api/v2/learning/modules/{moduleId}/rule | Update a learning module rule {: class="table table-striped"} @@ -196,6 +202,66 @@ apiInstance.getLearningAssignment(assignmentId, opts) **LearningAssignment** + + +# LearningAssignmentStep getLearningAssignmentStep(assignmentId, stepId, opts) + + +GET /api/v2/learning/assignments/{assignmentId}/steps/{stepId} + +Get Learning Assignment Step + +Permission not required if you are the assigned user of the learning assignment + +Requires ANY permissions: + +* learning:assignment:viewOwn + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let assignmentId = "assignmentId_example"; // String | The ID of Learning Assignment +let stepId = "stepId_example"; // String | The ID of Learning Assignment Step +let opts = { + 'shareableContentObjectId': "shareableContentObjectId_example", // String | The ID of SCO to load + 'expand': ["expand_example"] // [String] | Fields to expand in response +}; + +apiInstance.getLearningAssignmentStep(assignmentId, stepId, opts) + .then((data) => { + console.log(`getLearningAssignmentStep success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getLearningAssignmentStep'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **assignmentId** | **String** | The ID of Learning Assignment | | + **stepId** | **String** | The ID of Learning Assignment Step | | + **shareableContentObjectId** | **String** | The ID of SCO to load | [optional] | + **expand** | **[String]** | Fields to expand in response | [optional]
**Values**: moduleStep | +{: class="table table-striped"} + +### Return type + +**LearningAssignmentStep** + # LearningAssignmentsDomainEntity getLearningAssignments(opts) @@ -460,6 +526,56 @@ apiInstance.getLearningModuleJob(moduleId, jobId) **LearningModuleJobResponse** + + +# LearningModulePreviewGetResponse getLearningModulePreview(moduleId) + + +GET /api/v2/learning/modules/{moduleId}/preview + +Get a learning module preview + +Requires ANY permissions: + +* learning:module:preview + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let moduleId = "moduleId_example"; // String | The ID of the learning module + +apiInstance.getLearningModulePreview(moduleId) + .then((data) => { + console.log(`getLearningModulePreview success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getLearningModulePreview'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **moduleId** | **String** | The ID of the learning module | | +{: class="table table-striped"} + +### Return type + +**LearningModulePreviewGetResponse** + # LearningModuleRule getLearningModuleRule(moduleId) @@ -753,6 +869,56 @@ apiInstance.getLearningModulesCoverartCoverArtId(coverArtId) **LearningModuleCoverArtResponse** + + +# LearningScormResponse getLearningScormScormId(scormId) + + +GET /api/v2/learning/scorm/{scormId} + +Get Learning SCORM Result + +Requires ANY permissions: + +* learning:scorm:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let scormId = "scormId_example"; // String | The ID of the SCORM package + +apiInstance.getLearningScormScormId(scormId) + .then((data) => { + console.log(`getLearningScormScormId success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getLearningScormScormId'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **scormId** | **String** | The ID of the SCORM package | | +{: class="table table-striped"} + +### Return type + +**LearningScormResponse** + # LearningAssignment patchLearningAssignment(assignmentId, opts) @@ -859,6 +1025,64 @@ apiInstance.patchLearningAssignmentReschedule(assignmentId, opts) **LearningAssignment** + + +# LearningAssignmentStep patchLearningAssignmentStep(assignmentId, stepId, opts) + + +PATCH /api/v2/learning/assignments/{assignmentId}/steps/{stepId} + +Update Learning Assignment Step + +Permission not required if you are the assigned user of the learning assignment + +Requires ANY permissions: + +* learning:assignment:editOwn + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let assignmentId = "assignmentId_example"; // String | The ID of Learning Assignment +let stepId = "stepId_example"; // String | The ID of Learning Assignment Step +let opts = { + 'body': {} // Object | The Learning Assignment Step to be updated +}; + +apiInstance.patchLearningAssignmentStep(assignmentId, stepId, opts) + .then((data) => { + console.log(`patchLearningAssignmentStep success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling patchLearningAssignmentStep'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **assignmentId** | **String** | The ID of Learning Assignment | | + **stepId** | **String** | The ID of Learning Assignment Step | | + **body** | **Object** | The Learning Assignment Step to be updated | [optional] | +{: class="table table-striped"} + +### Return type + +**LearningAssignmentStep** + # LearningAssignment patchLearningModuleUserAssignments(moduleId, userId, body) @@ -1541,6 +1765,58 @@ apiInstance.postLearningScheduleslotsQuery(body) **LearningScheduleSlotsQueryResponse** + + +# LearningScormUploadResponse postLearningScorm(opts) + + +POST /api/v2/learning/scorm + +Create a SCORM package upload request + +Requires ANY permissions: + +* learning:scorm:add + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let opts = { + 'body': {} // Object | The SCORM package to be uploaded +}; + +apiInstance.postLearningScorm(opts) + .then((data) => { + console.log(`postLearningScorm success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling postLearningScorm'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **body** | **Object** | The SCORM package to be uploaded | [optional] | +{: class="table table-striped"} + +### Return type + +**LearningScormUploadResponse** + # LearningModule putLearningModule(moduleId, body) @@ -1595,6 +1871,60 @@ apiInstance.putLearningModule(moduleId, body) **LearningModule** + + +# LearningModulePreviewUpdateResponse putLearningModulePreview(moduleId, body) + + +PUT /api/v2/learning/modules/{moduleId}/preview + +Update a learning module preview + +This will update a learning module preview + +Requires ANY permissions: + +* learning:module:preview + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.LearningApi(); + +let moduleId = "moduleId_example"; // String | The ID of the learning module +let body = {}; // Object | The learning module to be updated + +apiInstance.putLearningModulePreview(moduleId, body) + .then((data) => { + console.log(`putLearningModulePreview success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling putLearningModulePreview'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **moduleId** | **String** | The ID of the learning module | | + **body** | **Object** | The learning module to be updated | | +{: class="table table-striped"} + +### Return type + +**LearningModulePreviewUpdateResponse** + # LearningModuleRule putLearningModuleRule(moduleId, body) diff --git a/build/docs/OrganizationApi.md b/build/docs/OrganizationApi.md index c233dd9e..fc3a9206 100644 --- a/build/docs/OrganizationApi.md +++ b/build/docs/OrganizationApi.md @@ -70,7 +70,7 @@ apiInstance.getFieldconfig(type) | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | - **type** | **String** | Field type |
**Values**: person, group, org, externalContact | + **type** | **String** | Field type |
**Values**: person, group, org | {: class="table table-striped"} ### Return type diff --git a/build/docs/RoutingApi.md b/build/docs/RoutingApi.md index 4c5d7d4a..739e1df4 100644 --- a/build/docs/RoutingApi.md +++ b/build/docs/RoutingApi.md @@ -1017,8 +1017,6 @@ DELETE /api/v2/routing/utilization/labels/{labelId} Delete a utilization label -deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:manage @@ -4049,8 +4047,6 @@ GET /api/v2/routing/utilization/labels/{labelId} Get details about this utilization label -getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:view @@ -4101,8 +4097,6 @@ GET /api/v2/routing/utilization/labels/{labelId}/agents Get list of agent ids associated with a utilization label -getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:view @@ -4153,8 +4147,6 @@ GET /api/v2/routing/utilization/labels Get list of utilization labels -getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:view @@ -6837,8 +6829,6 @@ POST /api/v2/routing/utilization/labels Create a utilization label -postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:manage @@ -7558,8 +7548,6 @@ PUT /api/v2/routing/utilization/labels/{labelId} Update a utilization label -putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice - Requires ALL permissions: * routing:utilization:manage diff --git a/build/docs/SpeechTextAnalyticsApi.md b/build/docs/SpeechTextAnalyticsApi.md index 17228052..1203ba5a 100644 --- a/build/docs/SpeechTextAnalyticsApi.md +++ b/build/docs/SpeechTextAnalyticsApi.md @@ -7,12 +7,16 @@ All URIs are relative to *https://api.mypurecloud.com* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | +[**deleteSpeechandtextanalyticsCategory**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsCategory) | **DELETE** /api/v2/speechandtextanalytics/categories/{categoryId} | Delete a Speech and Text Analytics category by ID [**deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId) | **DELETE** /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} | Delete a Speech and Text Analytics DictionaryFeedback by Id [**deleteSpeechandtextanalyticsProgram**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsProgram) | **DELETE** /api/v2/speechandtextanalytics/programs/{programId} | Delete a Speech and Text Analytics program by id [**deleteSpeechandtextanalyticsSentimentfeedback**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsSentimentfeedback) | **DELETE** /api/v2/speechandtextanalytics/sentimentfeedback | Delete All Speech and Text Analytics SentimentFeedback [**deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId) | **DELETE** /api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId} | Delete a Speech and Text Analytics SentimentFeedback by Id [**deleteSpeechandtextanalyticsTopic**](SpeechTextAnalyticsApi.html#deleteSpeechandtextanalyticsTopic) | **DELETE** /api/v2/speechandtextanalytics/topics/{topicId} | Delete a Speech and Text Analytics topic by id +[**getSpeechandtextanalyticsCategories**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsCategories) | **GET** /api/v2/speechandtextanalytics/categories | Get the list of Speech and Text Analytics categories +[**getSpeechandtextanalyticsCategory**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsCategory) | **GET** /api/v2/speechandtextanalytics/categories/{categoryId} | Get a Speech and Text Analytics Category by ID [**getSpeechandtextanalyticsConversation**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsConversation) | **GET** /api/v2/speechandtextanalytics/conversations/{conversationId} | Get Speech and Text Analytics for a specific conversation +[**getSpeechandtextanalyticsConversationCategories**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsConversationCategories) | **GET** /api/v2/speechandtextanalytics/conversations/{conversationId}/categories | Get the list of detected Speech and Text Analytics categories of conversation [**getSpeechandtextanalyticsConversationCommunicationTranscripturl**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsConversationCommunicationTranscripturl) | **GET** /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation [**getSpeechandtextanalyticsConversationCommunicationTranscripturls**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsConversationCommunicationTranscripturls) | **GET** /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls | Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation [**getSpeechandtextanalyticsDictionaryfeedback**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsDictionaryfeedback) | **GET** /api/v2/speechandtextanalytics/dictionaryfeedback | Get the list of Speech and Text Analytics dictionary feedbacks @@ -36,6 +40,7 @@ All URIs are relative to *https://api.mypurecloud.com* [**getSpeechandtextanalyticsTopicsGeneralStatus**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsTopicsGeneralStatus) | **GET** /api/v2/speechandtextanalytics/topics/general/status | Get the list of general topics from the org and the system with their current status [**getSpeechandtextanalyticsTopicsPublishjob**](SpeechTextAnalyticsApi.html#getSpeechandtextanalyticsTopicsPublishjob) | **GET** /api/v2/speechandtextanalytics/topics/publishjobs/{jobId} | Get a Speech and Text Analytics publish topics job by id [**patchSpeechandtextanalyticsSettings**](SpeechTextAnalyticsApi.html#patchSpeechandtextanalyticsSettings) | **PATCH** /api/v2/speechandtextanalytics/settings | Patch Speech And Text Analytics Settings +[**postSpeechandtextanalyticsCategories**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsCategories) | **POST** /api/v2/speechandtextanalytics/categories | Create new Speech and Text Analytics category [**postSpeechandtextanalyticsDictionaryfeedback**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsDictionaryfeedback) | **POST** /api/v2/speechandtextanalytics/dictionaryfeedback | Create a Speech and Text Analytics DictionaryFeedback [**postSpeechandtextanalyticsPrograms**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsPrograms) | **POST** /api/v2/speechandtextanalytics/programs | Create new Speech and Text Analytics program [**postSpeechandtextanalyticsProgramsGeneralJobs**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsProgramsGeneralJobs) | **POST** /api/v2/speechandtextanalytics/programs/general/jobs | Create new Speech and Text Analytics general program job @@ -44,6 +49,7 @@ All URIs are relative to *https://api.mypurecloud.com* [**postSpeechandtextanalyticsTopics**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsTopics) | **POST** /api/v2/speechandtextanalytics/topics | Create new Speech and Text Analytics topic [**postSpeechandtextanalyticsTopicsPublishjobs**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsTopicsPublishjobs) | **POST** /api/v2/speechandtextanalytics/topics/publishjobs | Create new Speech and Text Analytics publish topics job [**postSpeechandtextanalyticsTranscriptsSearch**](SpeechTextAnalyticsApi.html#postSpeechandtextanalyticsTranscriptsSearch) | **POST** /api/v2/speechandtextanalytics/transcripts/search | Search resources. +[**putSpeechandtextanalyticsCategory**](SpeechTextAnalyticsApi.html#putSpeechandtextanalyticsCategory) | **PUT** /api/v2/speechandtextanalytics/categories/{categoryId} | Update a Speech and Text Analytics category by ID [**putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId**](SpeechTextAnalyticsApi.html#putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId) | **PUT** /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} | Update existing Speech and Text Analytics dictionary feedback by id [**putSpeechandtextanalyticsProgram**](SpeechTextAnalyticsApi.html#putSpeechandtextanalyticsProgram) | **PUT** /api/v2/speechandtextanalytics/programs/{programId} | Update existing Speech and Text Analytics program [**putSpeechandtextanalyticsProgramMappings**](SpeechTextAnalyticsApi.html#putSpeechandtextanalyticsProgramMappings) | **PUT** /api/v2/speechandtextanalytics/programs/{programId}/mappings | Set Speech and Text Analytics program mappings to queues and flows @@ -52,6 +58,56 @@ All URIs are relative to *https://api.mypurecloud.com* [**putSpeechandtextanalyticsTopic**](SpeechTextAnalyticsApi.html#putSpeechandtextanalyticsTopic) | **PUT** /api/v2/speechandtextanalytics/topics/{topicId} | Update existing Speech and Text Analytics topic {: class="table table-striped"} + + +# void deleteSpeechandtextanalyticsCategory(categoryId) + + +DELETE /api/v2/speechandtextanalytics/categories/{categoryId} + +Delete a Speech and Text Analytics category by ID + +Requires ALL permissions: + +* speechAndTextAnalytics:category:delete + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let categoryId = "categoryId_example"; // String | The id of the category + +apiInstance.deleteSpeechandtextanalyticsCategory(categoryId) + .then(() => { + console.log('deleteSpeechandtextanalyticsCategory returned successfully.'); + }) + .catch((err) => { + console.log('There was a failure calling deleteSpeechandtextanalyticsCategory'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **categoryId** | **String** | The id of the category | | +{: class="table table-striped"} + +### Return type + +void (no response body) + # void deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId) @@ -301,6 +357,118 @@ apiInstance.deleteSpeechandtextanalyticsTopic(topicId) void (no response body) + + +# CategoriesEntityListing getSpeechandtextanalyticsCategories(opts) + + +GET /api/v2/speechandtextanalytics/categories + +Get the list of Speech and Text Analytics categories + +Requires ALL permissions: + +* speechAndTextAnalytics:category:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let opts = { + 'pageSize': 25, // Number | The page size for the listing. The max that will be returned is 50. + 'pageNumber': 1, // Number | The page number for the listing + 'name': "name_example", // String | The category name filter applied to the listing + 'sortOrder': "asc", // String | The sort order for the listing + 'sortBy': "name", // String | The field to sort by for the listing + 'ids': ["ids_example"] // [String] | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. +}; + +apiInstance.getSpeechandtextanalyticsCategories(opts) + .then((data) => { + console.log(`getSpeechandtextanalyticsCategories success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getSpeechandtextanalyticsCategories'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **pageSize** | **Number** | The page size for the listing. The max that will be returned is 50. | [optional] [default to 25] | + **pageNumber** | **Number** | The page number for the listing | [optional] [default to 1] | + **name** | **String** | The category name filter applied to the listing | [optional] | + **sortOrder** | **String** | The sort order for the listing | [optional] [default to asc]
**Values**: asc, desc | + **sortBy** | **String** | The field to sort by for the listing | [optional] [default to name]
**Values**: name, description | + **ids** | **[String]** | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. | [optional] | +{: class="table table-striped"} + +### Return type + +**CategoriesEntityListing** + + + +# StaCategory getSpeechandtextanalyticsCategory(categoryId) + + +GET /api/v2/speechandtextanalytics/categories/{categoryId} + +Get a Speech and Text Analytics Category by ID + +Requires ALL permissions: + +* speechAndTextAnalytics:category:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let categoryId = "categoryId_example"; // String | The id of the category + +apiInstance.getSpeechandtextanalyticsCategory(categoryId) + .then((data) => { + console.log(`getSpeechandtextanalyticsCategory success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getSpeechandtextanalyticsCategory'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **categoryId** | **String** | The id of the category | | +{: class="table table-striped"} + +### Return type + +**StaCategory** + # ConversationMetrics getSpeechandtextanalyticsConversation(conversationId) @@ -352,6 +520,62 @@ apiInstance.getSpeechandtextanalyticsConversation(conversationId) **ConversationMetrics** + + +# ConversationCategoriesEntityListing getSpeechandtextanalyticsConversationCategories(conversationId, opts) + + +GET /api/v2/speechandtextanalytics/conversations/{conversationId}/categories + +Get the list of detected Speech and Text Analytics categories of conversation + +Requires ALL permissions: + +* speechAndTextAnalytics:data:view + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let conversationId = "conversationId_example"; // String | The id of the conversation +let opts = { + 'pageSize': 25, // Number | The page size for the listing. The max that will be returned is 50. + 'pageNumber': 1 // Number | The page number for the listing +}; + +apiInstance.getSpeechandtextanalyticsConversationCategories(conversationId, opts) + .then((data) => { + console.log(`getSpeechandtextanalyticsConversationCategories success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling getSpeechandtextanalyticsConversationCategories'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **conversationId** | **String** | The id of the conversation | | + **pageSize** | **Number** | The page size for the listing. The max that will be returned is 50. | [optional] [default to 25] | + **pageNumber** | **Number** | The page number for the listing | [optional] [default to 1] | +{: class="table table-striped"} + +### Return type + +**ConversationCategoriesEntityListing** + # TranscriptUrl getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId, communicationId) @@ -1527,6 +1751,56 @@ apiInstance.patchSpeechandtextanalyticsSettings(body) **SpeechTextAnalyticsSettingsResponse** + + +# StaCategory postSpeechandtextanalyticsCategories(body) + + +POST /api/v2/speechandtextanalytics/categories + +Create new Speech and Text Analytics category + +Requires ALL permissions: + +* speechAndTextAnalytics:category:add + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let body = {}; // Object | The category to create + +apiInstance.postSpeechandtextanalyticsCategories(body) + .then((data) => { + console.log(`postSpeechandtextanalyticsCategories success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling postSpeechandtextanalyticsCategories'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **body** | **Object** | The category to create | | +{: class="table table-striped"} + +### Return type + +**StaCategory** + # DictionaryFeedback postSpeechandtextanalyticsDictionaryfeedback(body) @@ -1931,6 +2205,58 @@ apiInstance.postSpeechandtextanalyticsTranscriptsSearch(body) **JsonSearchResponse** + + +# StaCategory putSpeechandtextanalyticsCategory(categoryId, body) + + +PUT /api/v2/speechandtextanalytics/categories/{categoryId} + +Update a Speech and Text Analytics category by ID + +Requires ALL permissions: + +* speechAndTextAnalytics:category:edit + +### Example Usage + +```{"language":"javascript"} +// Browser +const platformClient = require('platformClient'); +// Node +const platformClient = require('purecloud-platform-client-v2'); + +// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...) +platformClient.ApiClient.instance.setAccessToken(yourAccessToken); + +let apiInstance = new platformClient.SpeechTextAnalyticsApi(); + +let categoryId = "categoryId_example"; // String | The id of the category +let body = {}; // Object | The updated category + +apiInstance.putSpeechandtextanalyticsCategory(categoryId, body) + .then((data) => { + console.log(`putSpeechandtextanalyticsCategory success! data: ${JSON.stringify(data, null, 2)}`); + }) + .catch((err) => { + console.log('There was a failure calling putSpeechandtextanalyticsCategory'); + console.error(err); + }); +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | + **categoryId** | **String** | The id of the category | | + **body** | **Object** | The updated category | | +{: class="table table-striped"} + +### Return type + +**StaCategory** + # DictionaryFeedback putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId, opts) diff --git a/build/docs/UsersApi.md b/build/docs/UsersApi.md index 3175a8d7..dc23bebf 100644 --- a/build/docs/UsersApi.md +++ b/build/docs/UsersApi.md @@ -1134,7 +1134,7 @@ apiInstance.getFieldconfig(type) | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | - **type** | **String** | Field type |
**Values**: person, group, org, externalContact | + **type** | **String** | Field type |
**Values**: person, group, org | {: class="table table-striped"} ### Return type diff --git a/build/docs/index.md b/build/docs/index.md index 393b58f4..69171925 100644 --- a/build/docs/index.md +++ b/build/docs/index.md @@ -31,7 +31,7 @@ For direct use in a browser script: ```html - + diff --git a/build/docs/releaseNotes.md b/build/docs/releaseNotes.md index 3e5be0ee..5a276863 100644 --- a/build/docs/releaseNotes.md +++ b/build/docs/releaseNotes.md @@ -1,241 +1,520 @@ -Platform API version: 8117 +Platform API version: 8165 -# Major Changes (19 changes) +# Major Changes (10 changes) -**/api/v2/conversations/messaging/integrations/line/{integrationId}** (1 change) +**/api/v2/conversations/messaging/stickers/{messengerType}** (1 change) -* Path /api/v2/conversations/messaging/integrations/line/{integrationId} was removed +* Path /api/v2/conversations/messaging/stickers/{messengerType} was removed -**/api/v2/conversations/messaging/integrations/line** (1 change) +**GET /api/v2/journey/views** (1 change) -* Path /api/v2/conversations/messaging/integrations/line was removed +* Response 200 type was changed from AddressableEntityListing to JourneyViewListing -**/api/v2/conversations/messaging/integrations/twitter/{integrationId}** (1 change) +**GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations** (1 change) -* Path /api/v2/conversations/messaging/integrations/twitter/{integrationId} was removed +* Parameter sourceId was added -**/api/v2/conversations/messaging/integrations/twitter** (1 change) +**MessagingSticker** (1 change) -* Path /api/v2/conversations/messaging/integrations/twitter was removed +* Model MessagingSticker was removed -**GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships** (1 change) +**MessagingStickerEntityListing** (1 change) -* Parameter expand was changed from string to array +* Model MessagingStickerEntityListing was removed -**GET /api/v2/externalcontacts/organizations/{externalOrganizationId}** (1 change) +**AddressableEntityListing** (1 change) -* Parameter expand was changed from string to array +* Model AddressableEntityListing was removed -**GET /api/v2/externalcontacts/relationships/{relationshipId}** (1 change) +**FieldConfig** (1 change) -* Parameter expand was changed from string to array +* Enum value externalContact was removed from property entityType -**ConditionalGroupRoutingCondition** (1 change) +**KeyPerformanceIndicator** (1 change) -* Model ConditionalGroupRoutingCondition was removed +* Enum value NumberOfTransfers was removed from property kpiType -**LineIntegration** (1 change) +**EngineIntegration** (1 change) -* Model LineIntegration was removed +* Property name was removed -**LineIntegrationRequest** (1 change) +**FieldConfigs** (1 change) -* Model LineIntegrationRequest was removed +* Property externalContact was removed -**LineIntegrationEntityListing** (1 change) -* Model LineIntegrationEntityListing was removed +# Minor Changes (178 changes) -**TwitterIntegration** (1 change) +**/api/v2/analytics/reporting/settings/dashboards/query** (1 change) -* Model TwitterIntegration was removed +* Operation get was added. Summary: Get list of dashboard configurations -**TwitterIntegrationRequest** (1 change) +**/api/v2/conversations/emails/{conversationId}/reconnect** (2 changes) -* Model TwitterIntegrationRequest was removed +* Path was added +* Operation POST was added -**TwitterIntegrationEntityListing** (1 change) +**/api/v2/speechandtextanalytics/categories** (3 changes) -* Model TwitterIntegrationEntityListing was removed +* Path was added +* Operation GET was added +* Operation POST was added -**GenericActionEvent** (1 change) +**/api/v2/speechandtextanalytics/categories/{categoryId}** (4 changes) -* Model GenericActionEvent was removed +* Path was added +* Operation GET was added +* Operation PUT was added +* Operation DELETE was added -**GenericEventAction** (1 change) +**/api/v2/speechandtextanalytics/conversations/{conversationId}/categories** (2 changes) -* Model GenericEventAction was removed +* Path was added +* Operation GET was added -**PhoneStatus** (1 change) +**GET /api/v2/speechandtextanalytics/topics/general/status** (1 change) -* Property name was removed +* Response 405 was added -**WfmUserEntityListing** (1 change) +**/api/v2/learning/assignments/{assignmentId}/steps/{stepId}** (3 changes) -* Property entities was changed from User[] to UserReference[] +* Path was added +* Operation GET was added +* Operation PATCH was added -**Event** (1 change) +**/api/v2/learning/modules/{moduleId}/preview** (3 changes) -* Property genericActionEvent was removed +* Path was added +* Operation GET was added +* Operation PUT was added +**/api/v2/learning/scorm/{scormId}** (2 changes) -# Minor Changes (45 changes) +* Path was added +* Operation GET was added -**/api/v2/audits/query/realtime/related** (2 changes) +**/api/v2/learning/scorm** (2 changes) * Path was added * Operation POST was added -**/api/v2/outbound/campaigns/{campaignId}/linedistribution** (2 changes) +**POST /api/v2/taskmanagement/workitems/{workitemId}/terminate** (1 change) + +* Response 409 was added + +**/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}** (2 changes) * Path was added * Operation GET was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results** (2 changes) * Path was added -* Operation POST was added +* Operation GET was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/query** (2 changes) * Path was added * Operation POST was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/search** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/jobs** (2 changes) * Path was added * Operation POST was added -**ConversationAggregateQueryPredicate** (1 change) +**BotAggregationQuery** (2 changes) + +* Enum value oBotSessionCollection was added to property metrics +* Enum value oBotSessionCollectionSelfServed was added to property metrics + +**BotAggregationView** (2 changes) + +* Enum value oBotSessionCollection was added to property target +* Enum value oBotSessionCollectionSelfServed was added to property target + +**AnalyticsSession** (2 changes) + +* Optional property detectedSpeechEnd was added +* Optional property detectedSpeechStart was added + +**SegmentDetailQueryPredicate** (2 changes) + +* Enum value detectedSpeechEnd was added to property dimension +* Enum value detectedSpeechStart was added to property dimension + +**DashboardConfiguration** (2 changes) + +* Optional property shared was added +* Optional property dashboardsSharedWith was added + +**DashboardsSharedWith** (1 change) + +* Model was added + +**ViewFilter** (15 changes) + +* Optional property agentTalkDurationMilliseconds was added +* Optional property customerTalkDurationMilliseconds was added +* Optional property overtalkDurationMilliseconds was added +* Optional property silenceDurationMilliseconds was added +* Optional property acdDurationMilliseconds was added +* Optional property ivrDurationMilliseconds was added +* Optional property otherDurationMilliseconds was added +* Optional property agentTalkPercentage was added +* Optional property customerTalkPercentage was added +* Optional property overtalkPercentage was added +* Optional property silencePercentage was added +* Optional property acdPercentage was added +* Optional property ivrPercentage was added +* Optional property otherPercentage was added +* Optional property overtalkInstances was added + +**KnowledgeBaseReference** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**Limit** (1 change) + +* Enum value social.media was added to property namespace + +**ContactIdentifier** (1 change) + +* Enum value ExternalId was added to property type + +**ConversationMessageMetadataEvent** (1 change) + +* Enum value Video was added to property eventType + +**CreateCallRequest** (1 change) + +* Optional property attributes was added + +**ConversationEventVideo** (1 change) + +* Model was added + +**ConversationMessageEvent** (2 changes) + +* Enum value Video was added to property eventType +* Optional property video was added + +**KnowledgeBase** (5 changes) + +* Enum value hi-IN was added to property coreLanguage +* Enum value th-TH was added to property coreLanguage +* Enum value hu-HU was added to property coreLanguage +* Enum value vi-VN was added to property coreLanguage +* Enum value uk-UA was added to property coreLanguage + +**KnowledgeCategory** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeSearchDocumentV1** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeExtendedCategory** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeImport** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeDocument** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeBaseCreateRequest** (5 changes) + +* Enum value hi-IN was added to property coreLanguage +* Enum value th-TH was added to property coreLanguage +* Enum value hu-HU was added to property coreLanguage +* Enum value vi-VN was added to property coreLanguage +* Enum value uk-UA was added to property coreLanguage + +**KnowledgeOperationSource** (1 change) + +* Model was added + +**KnowledgeDocumentResponse** (2 changes) + +* Optional property source was added +* Optional property readonly was added + +**KnowledgeExportJobDocumentsFilter** (1 change) + +* Optional property sourceId was added + +**KnowledgeExportJobResponse** (1 change) + +* Optional property source was added -* Enum value videoPresent was added to property dimension +**KnowledgeExportJobRequest** (1 change) -**ConversationAggregationQuery** (1 change) +* Optional property sourceId was added -* Enum value videoPresent was added to property groupBy +**KnowledgeSearchDocumentResponse** (2 changes) -**FlowAggregateQueryPredicate** (1 change) +* Optional property source was added +* Optional property readonly was added -* Enum value videoPresent was added to property dimension +**ApprovalNamespace** (1 change) -**FlowAggregationQuery** (1 change) +* Enum value social.media was added to property namespace -* Enum value videoPresent was added to property groupBy +**LimitChangeRequestDetails** (1 change) -**ReportingTurn** (1 change) +* Enum value social.media was added to property namespace -* Optional property knowledgeBaseEvents was added +**StatusChange** (1 change) -**ReportingTurnKnowledgeEvents** (1 change) +* Enum value social.media was added to property namespace + +**RecordingMessagingMessage** (4 changes) + +* Optional property purpose was added +* Optional property participantId was added +* Optional property queue was added +* Optional property workflow was added + +**UserQueue** (1 change) + +* id is no longer readonly + +**UtilizationResponse** (1 change) + +* Optional property labelUtilizations was added + +**UtilizationRequest** (1 change) + +* Optional property labelUtilizations was added + +**AgentMaxUtilizationResponse** (1 change) + +* Optional property labelUtilizations was added + +**CategoriesEntityListing** (1 change) * Model was added -**ReportingTurnKnowledgeFeedbackEvent** (1 change) +**InfixOperator** (1 change) * Model was added -**ReportingTurnKnowledgeSearchEvent** (1 change) +**Operand** (1 change) * Model was added -**ConversationProperties** (1 change) +**OperandPosition** (1 change) -* Optional property isScreenMonitored was added +* Model was added -**ViewFilter** (2 changes) +**OperatorPosition** (1 change) -* Optional property isScreenRecorded was added -* Optional property screenMonitorUserIds was added +* Model was added -**AuditRealtimeRelatedResultsResponse** (1 change) +**StaCategory** (1 change) * Model was added -**AuditRealtimeRelatedRequest** (1 change) +**Term** (1 change) * Model was added -**AiAnswer** (1 change) +**CategoryRequest** (1 change) * Model was added -**AiScoring** (1 change) +**EngineIntegration** (1 change) + +* id is no longer readonly + +**ConversationCategoriesEntityListing** (1 change) * Model was added -**Campaign** (1 change) +**ConversationCategory** (1 change) + +* Model was added -* Optional property dynamicLineBalancingSettings was added +**VoicemailSearchCriteria** (1 change) -**CampaignOutboundLinesAllocation** (1 change) +* Enum value DATE_RANGE was added to property type + +**CobrowseSettings** (1 change) + +* Optional property pauseCriteria was added + +**LearningAssignment** (5 changes) + +* Optional property assessmentPercentageScore was added +* Optional property assessmentCompletionPercentage was added +* Optional property completionPercentage was added +* Optional property steps was added +* Optional property nextStep was added + +**LearningModule** (2 changes) + +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added + +**ReviewAssessmentResults** (2 changes) + +* Optional property byAssignees was added +* Optional property byViewers was added + +**LearningModulePreviewGetResponse** (1 change) * Model was added -**CampaignOutboundLinesDistribution** (1 change) +**LearningModulePreviewGetResponseAssignment** (1 change) * Model was added -**CampaignOutboundLinesReservation** (1 change) +**LearningModulePreviewGetResponseStep** (1 change) * Model was added -**CampaignStats** (1 change) +**LearningModulePreviewGetScoStructure** (1 change) -* Optional property linesUtilization was added +* Model was added + +**LearningModuleRequest** (2 changes) + +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added -**ContactsBulkOperationJob** (1 change) +**LearningModulePreviewUpdateResponse** (1 change) * Model was added -**ContactBulkEditRequest** (1 change) +**LearningModulePreviewUpdateResponseAssignment** (1 change) * Model was added -**ContactBulkSearchParameters** (1 change) +**LearningModulePreviewUpdateResponseCurrentStep** (1 change) * Model was added -**ContactListingResponse** (1 change) +**LearningModulePreviewUpdateScoStructure** (1 change) * Model was added -**ContactListingRequest** (1 change) +**LearningModulePreviewUpdateStep** (1 change) * Model was added -**EventMessage** (2 changes) +**LearningModulePreviewUpdateRequest** (1 change) -* Enum value ACTION_EXECUTION_FAILED was added to property code -* Enum value ACTION_EXECUTION_FAILED_INVALID_PARAMETER was added to property code +* Model was added -**FlowPathsFlowDetails** (3 changes) +**LearningModulePreviewUpdateRequestCurrentStep** (1 change) -* Enum value InboundShortMessage was added to property type -* Enum value InboundEmail was added to property type -* Enum value OutboundCall was added to property type +* Model was added -**IpAddressRange** (1 change) +**AssignedLearningModule** (2 changes) -* Enum value open-messaging was added to property service +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added -**Library** (1 change) +**LearningScormResponse** (1 change) -* version is no longer readonly +* Model was added -**PhoneStatus** (1 change) +**LearningScormUploadResponse** (1 change) -* id is no longer readonly +* Model was added + +**LearningScormUploadRequest** (1 change) + +* Model was added + +**AgentCopilotAggregateDataContainer** (1 change) + +* Model was added + +**AgentCopilotAsyncAggregateQueryResponse** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryResponse** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryClause** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryFilter** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryPredicate** (1 change) + +* Model was added + +**AgentCopilotAggregationQuery** (1 change) + +* Model was added + +**AgentCopilotAggregationView** (1 change) + +* Model was added + +**AgentCopilotAsyncAggregationQuery** (1 change) + +* Model was added + +**BotAsyncAggregationQuery** (2 changes) + +* Enum value oBotSessionCollection was added to property metrics +* Enum value oBotSessionCollectionSelfServed was added to property metrics + +**JourneyViewListing** (1 change) + +* Model was added + +**OperationResponse** (1 change) + +* Optional property source was added -**ConversationAsyncAggregationQuery** (1 change) +**WorktypeDelta** (1 change) -* Enum value videoPresent was added to property groupBy +* Optional property serviceLevelTarget was added -**FlowAsyncAggregationQuery** (1 change) -* Enum value videoPresent was added to property groupBy +# Point Changes (2 changes) +**POST /api/v2/analytics/ratelimits/aggregates/query** (2 changes) -# Point Changes (0 changes) +* Description was changed +* Summary was changed diff --git a/build/index.d.ts b/build/index.d.ts index 0d529576..7a4d444d 100644 --- a/build/index.d.ts +++ b/build/index.d.ts @@ -146,6 +146,8 @@ declare class AnalyticsApi { deleteAnalyticsUsersDetailsJob(jobId: string): Promise; getAnalyticsActionsAggregatesJob(jobId: string): Promise; getAnalyticsActionsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsActionsAggregatesJobResultsOptions): Promise; + getAnalyticsAgentcopilotsAggregatesJob(jobId: string): Promise; + getAnalyticsAgentcopilotsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsAgentcopilotsAggregatesJobResultsOptions): Promise; getAnalyticsBotflowDivisionsReportingturns(botFlowId: string, opts?: AnalyticsApi.getAnalyticsBotflowDivisionsReportingturnsOptions): Promise; getAnalyticsBotflowReportingturns(botFlowId: string, opts?: AnalyticsApi.getAnalyticsBotflowReportingturnsOptions): Promise; getAnalyticsBotflowSessions(botFlowId: string, opts?: AnalyticsApi.getAnalyticsBotflowSessionsOptions): Promise; @@ -174,6 +176,7 @@ declare class AnalyticsApi { getAnalyticsReportingExports(opts?: AnalyticsApi.getAnalyticsReportingExportsOptions): Promise; getAnalyticsReportingExportsMetadata(): Promise; getAnalyticsReportingSettings(): Promise; + getAnalyticsReportingSettingsDashboardsQuery(dashboardType: string, dashboardAccessFilter: string, opts?: AnalyticsApi.getAnalyticsReportingSettingsDashboardsQueryOptions): Promise; getAnalyticsReportingSettingsUserDashboards(userId: string, opts?: AnalyticsApi.getAnalyticsReportingSettingsUserDashboardsOptions): Promise; getAnalyticsResolutionsAggregatesJob(jobId: string): Promise; getAnalyticsResolutionsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsResolutionsAggregatesJobResultsOptions): Promise; @@ -191,6 +194,8 @@ declare class AnalyticsApi { patchAnalyticsReportingSettings(body: Models.AnalyticsReportingSettings): Promise; postAnalyticsActionsAggregatesJobs(body: Models.ActionAsyncAggregationQuery): Promise; postAnalyticsActionsAggregatesQuery(body: Models.ActionAggregationQuery): Promise; + postAnalyticsAgentcopilotsAggregatesJobs(body: Models.AgentCopilotAsyncAggregationQuery): Promise; + postAnalyticsAgentcopilotsAggregatesQuery(body: Models.AgentCopilotAggregationQuery): Promise; postAnalyticsBotsAggregatesJobs(body: Models.BotAsyncAggregationQuery): Promise; postAnalyticsBotsAggregatesQuery(body: Models.BotAggregationQuery): Promise; postAnalyticsConversationDetailsProperties(conversationId: string, body: Models.PropertyIndexRequest): Promise; @@ -240,6 +245,9 @@ declare namespace AnalyticsApi { export interface getAnalyticsActionsAggregatesJobResultsOptions { "cursor"?: string; } + export interface getAnalyticsAgentcopilotsAggregatesJobResultsOptions { + "cursor"?: string; + } export interface getAnalyticsBotflowDivisionsReportingturnsOptions { "after"?: string; "pageSize"?: string; @@ -304,6 +312,11 @@ declare namespace AnalyticsApi { "pageNumber"?: number; "pageSize"?: number; } + export interface getAnalyticsReportingSettingsDashboardsQueryOptions { + "sortBy"?: string; + "pageNumber"?: number; + "pageSize"?: number; + } export interface getAnalyticsReportingSettingsUserDashboardsOptions { "sortBy"?: string; "pageNumber"?: number; @@ -1436,7 +1449,6 @@ declare class ConversationsApi { getConversationsMessagingSetting(messageSettingId: string): Promise; getConversationsMessagingSettings(opts?: ConversationsApi.getConversationsMessagingSettingsOptions): Promise; getConversationsMessagingSettingsDefault(): Promise; - getConversationsMessagingSticker(messengerType: string, opts?: ConversationsApi.getConversationsMessagingStickerOptions): Promise; getConversationsMessagingSupportedcontent(opts?: ConversationsApi.getConversationsMessagingSupportedcontentOptions): Promise; getConversationsMessagingSupportedcontentDefault(): Promise; getConversationsMessagingSupportedcontentSupportedContentId(supportedContentId: string): Promise; @@ -1534,6 +1546,7 @@ declare class ConversationsApi { postConversationsEmailMessagesDraftAttachmentsCopy(conversationId: string, body: Models.CopyAttachmentsRequest): Promise; postConversationsEmailParticipantCommunicationWrapup(conversationId: string, participantId: string, communicationId: string, opts?: ConversationsApi.postConversationsEmailParticipantCommunicationWrapupOptions): Promise; postConversationsEmailParticipantReplace(conversationId: string, participantId: string, body: Models.TransferRequest): Promise; + postConversationsEmailReconnect(conversationId: string): Promise; postConversationsEmails(body: Models.CreateEmailRequest): Promise; postConversationsEmailsAgentless(body: Models.AgentlessEmailSendRequestDto): Promise; postConversationsFaxes(body: Models.FaxSendRequest): Promise; @@ -1711,10 +1724,6 @@ declare namespace ConversationsApi { "pageSize"?: number; "pageNumber"?: number; } - export interface getConversationsMessagingStickerOptions { - "pageSize"?: number; - "pageNumber"?: number; - } export interface getConversationsMessagingSupportedcontentOptions { "pageSize"?: number; "pageNumber"?: number; @@ -2732,7 +2741,7 @@ declare class JourneyApi { getJourneyViewVersionJob(viewId: string, journeyVersionId: string, jobId: string): Promise; getJourneyViewVersionJobResults(viewId: string, journeyViewVersion: string, jobId: string): Promise; getJourneyViewVersionJobsLatest(viewId: string, journeyVersionId: string): Promise; - getJourneyViews(): Promise; + getJourneyViews(): Promise; getJourneyViewsEventdefinition(eventDefinitionId: string): Promise; getJourneyViewsEventdefinitions(): Promise; patchJourneyActionmap(actionMapId: string, opts?: JourneyApi.patchJourneyActionmapOptions): Promise; @@ -3086,6 +3095,7 @@ declare namespace KnowledgeApi { "type"?: Array; "status"?: Array; "interval"?: string; + "sourceId"?: Array; } export interface getKnowledgeKnowledgebaseParseJobOptions { "expand"?: Array; @@ -3280,17 +3290,21 @@ declare class LearningApi { deleteLearningAssignment(assignmentId: string): Promise; deleteLearningModule(moduleId: string): Promise; getLearningAssignment(assignmentId: string, opts?: LearningApi.getLearningAssignmentOptions): Promise; + getLearningAssignmentStep(assignmentId: string, stepId: string, opts?: LearningApi.getLearningAssignmentStepOptions): Promise; getLearningAssignments(opts?: LearningApi.getLearningAssignmentsOptions): Promise; getLearningAssignmentsMe(opts?: LearningApi.getLearningAssignmentsMeOptions): Promise; getLearningModule(moduleId: string, opts?: LearningApi.getLearningModuleOptions): Promise; getLearningModuleJob(moduleId: string, jobId: string): Promise; + getLearningModulePreview(moduleId: string): Promise; getLearningModuleRule(moduleId: string): Promise; getLearningModuleVersion(moduleId: string, versionId: string, opts?: LearningApi.getLearningModuleVersionOptions): Promise; getLearningModules(opts?: LearningApi.getLearningModulesOptions): Promise; getLearningModulesAssignments(userIds: Array, opts?: LearningApi.getLearningModulesAssignmentsOptions): Promise; getLearningModulesCoverartCoverArtId(coverArtId: string): Promise; + getLearningScormScormId(scormId: string): Promise; patchLearningAssignment(assignmentId: string, opts?: LearningApi.patchLearningAssignmentOptions): Promise; patchLearningAssignmentReschedule(assignmentId: string, opts?: LearningApi.patchLearningAssignmentRescheduleOptions): Promise; + patchLearningAssignmentStep(assignmentId: string, stepId: string, opts?: LearningApi.patchLearningAssignmentStepOptions): Promise; patchLearningModuleUserAssignments(moduleId: string, userId: string, body: Models.LearningAssignmentExternalUpdate): Promise; postLearningAssessmentsScoring(body: Models.LearningAssessmentScoringRequest): Promise; postLearningAssignmentReassign(assignmentId: string): Promise; @@ -3304,7 +3318,9 @@ declare class LearningApi { postLearningModules(body: Models.LearningModuleRequest): Promise; postLearningRulesQuery(pageSize: number, pageNumber: number, body: Models.LearningAssignmentUserQuery): Promise; postLearningScheduleslotsQuery(body: Models.LearningScheduleSlotsQueryRequest): Promise; + postLearningScorm(opts?: LearningApi.postLearningScormOptions): Promise; putLearningModule(moduleId: string, body: Models.LearningModuleRequest): Promise; + putLearningModulePreview(moduleId: string, body: Models.LearningModulePreviewUpdateRequest): Promise; putLearningModuleRule(moduleId: string, body: Models.LearningModuleRule): Promise; } @@ -3312,6 +3328,10 @@ declare namespace LearningApi { export interface getLearningAssignmentOptions { "expand"?: Array; } + export interface getLearningAssignmentStepOptions { + "shareableContentObjectId"?: string; + "expand"?: Array; + } export interface getLearningAssignmentsOptions { "moduleId"?: string; "interval"?: string; @@ -3378,6 +3398,9 @@ declare namespace LearningApi { export interface patchLearningAssignmentRescheduleOptions { "body"?: Models.LearningAssignmentReschedule; } + export interface patchLearningAssignmentStepOptions { + "body"?: Models.LearningAssignmentStep; + } export interface postLearningAssignmentsOptions { "body"?: Models.LearningAssignmentCreate; } @@ -3390,6 +3413,9 @@ declare namespace LearningApi { export interface postLearningModulePublishOptions { "body"?: Models.LearningModulePublishRequest; } + export interface postLearningScormOptions { + "body"?: Models.LearningScormUploadRequest; + } } declare class LicenseApi { @@ -5443,12 +5469,16 @@ declare namespace SettingsApi { } declare class SpeechTextAnalyticsApi { + deleteSpeechandtextanalyticsCategory(categoryId: string): Promise; deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: string): Promise; deleteSpeechandtextanalyticsProgram(programId: string, opts?: SpeechTextAnalyticsApi.deleteSpeechandtextanalyticsProgramOptions): Promise; deleteSpeechandtextanalyticsSentimentfeedback(): Promise; deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId: string): Promise; deleteSpeechandtextanalyticsTopic(topicId: string): Promise; + getSpeechandtextanalyticsCategories(opts?: SpeechTextAnalyticsApi.getSpeechandtextanalyticsCategoriesOptions): Promise; + getSpeechandtextanalyticsCategory(categoryId: string): Promise; getSpeechandtextanalyticsConversation(conversationId: string): Promise; + getSpeechandtextanalyticsConversationCategories(conversationId: string, opts?: SpeechTextAnalyticsApi.getSpeechandtextanalyticsConversationCategoriesOptions): Promise; getSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId: string, communicationId: string): Promise; getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId: string, communicationId: string): Promise; getSpeechandtextanalyticsDictionaryfeedback(opts?: SpeechTextAnalyticsApi.getSpeechandtextanalyticsDictionaryfeedbackOptions): Promise; @@ -5472,6 +5502,7 @@ declare class SpeechTextAnalyticsApi { getSpeechandtextanalyticsTopicsGeneralStatus(opts?: SpeechTextAnalyticsApi.getSpeechandtextanalyticsTopicsGeneralStatusOptions): Promise; getSpeechandtextanalyticsTopicsPublishjob(jobId: string): Promise; patchSpeechandtextanalyticsSettings(body: Models.SpeechTextAnalyticsSettingsRequest): Promise; + postSpeechandtextanalyticsCategories(body: Models.CategoryRequest): Promise; postSpeechandtextanalyticsDictionaryfeedback(body: Models.DictionaryFeedback): Promise; postSpeechandtextanalyticsPrograms(body: Models.ProgramRequest): Promise; postSpeechandtextanalyticsProgramsGeneralJobs(body: Models.GeneralProgramJobRequest): Promise; @@ -5480,6 +5511,7 @@ declare class SpeechTextAnalyticsApi { postSpeechandtextanalyticsTopics(body: Models.TopicRequest): Promise; postSpeechandtextanalyticsTopicsPublishjobs(body: Models.TopicJobRequest): Promise; postSpeechandtextanalyticsTranscriptsSearch(body: Models.TranscriptSearchRequest): Promise; + putSpeechandtextanalyticsCategory(categoryId: string, body: Models.CategoryRequest): Promise; putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: string, opts?: SpeechTextAnalyticsApi.putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackIdOptions): Promise; putSpeechandtextanalyticsProgram(programId: string, body: Models.ProgramRequest): Promise; putSpeechandtextanalyticsProgramMappings(programId: string, body: Models.ProgramMappingsRequest): Promise; @@ -5492,6 +5524,18 @@ declare namespace SpeechTextAnalyticsApi { export interface deleteSpeechandtextanalyticsProgramOptions { "forceDelete"?: boolean; } + export interface getSpeechandtextanalyticsCategoriesOptions { + "pageSize"?: number; + "pageNumber"?: number; + "name"?: string; + "sortOrder"?: string; + "sortBy"?: string; + "ids"?: Array; + } + export interface getSpeechandtextanalyticsConversationCategoriesOptions { + "pageSize"?: number; + "pageNumber"?: number; + } export interface getSpeechandtextanalyticsDictionaryfeedbackOptions { "dialect"?: string; "nextPage"?: string; @@ -7707,19 +7751,6 @@ declare namespace Models { "selfUri"?: string; } - export interface AddressableEntityListing { - "entities"?: Array; - "pageSize"?: number; - "pageNumber"?: number; - "total"?: number; - "previousUri"?: string; - "lastUri"?: string; - "firstUri"?: string; - "selfUri"?: string; - "nextUri"?: string; - "pageCount"?: number; - } - export interface AddressableEntityRef { "id"?: string; "selfUri"?: string; @@ -7943,6 +7974,75 @@ declare namespace Models { "pageCount"?: number; } + export interface AgentCopilotAggregateDataContainer { + "group"?: { [key: string]: string; }; + "data"?: Array; + } + + export interface AgentCopilotAggregateQueryClause { + "type": string; + "predicates": Array; + } + + export interface AgentCopilotAggregateQueryFilter { + "type": string; + "clauses"?: Array; + "predicates"?: Array; + } + + export interface AgentCopilotAggregateQueryPredicate { + "type"?: string; + "dimension"?: string; + "operator"?: string; + "value"?: string; + "range"?: Models.NumericRange; + } + + export interface AgentCopilotAggregateQueryResponse { + "results"?: Array; + } + + export interface AgentCopilotAggregationQuery { + "interval": string; + "granularity"?: string; + "timeZone"?: string; + "groupBy"?: Array; + "filter"?: Models.AgentCopilotAggregateQueryFilter; + "metrics": Array; + "flattenMultivaluedDimensions"?: boolean; + "views"?: Array; + "alternateTimeDimension"?: string; + "queryType"?: string; + "limit"?: number; + } + + export interface AgentCopilotAggregationView { + "target": string; + "name": string; + "function": string; + "range"?: Models.AggregationRange; + } + + export interface AgentCopilotAsyncAggregateQueryResponse { + "results"?: Array; + "cursor"?: string; + } + + export interface AgentCopilotAsyncAggregationQuery { + "interval": string; + "granularity"?: string; + "timeZone"?: string; + "groupBy"?: Array; + "filter"?: Models.AgentCopilotAggregateQueryFilter; + "metrics": Array; + "flattenMultivaluedDimensions"?: boolean; + "views"?: Array; + "alternateTimeDimension"?: string; + "queryType"?: string; + "limit"?: number; + "pageSize"?: number; + } + export interface AgentEvaluatorActivity { "id"?: string; "name"?: string; @@ -7986,6 +8086,7 @@ declare namespace Models { export interface AgentMaxUtilizationResponse { "utilization"?: { [key: string]: Models.MediaUtilization; }; + "labelUtilizations"?: { [key: string]: Models.LabelUtilizationResponse; }; "level"?: string; } @@ -8454,6 +8555,8 @@ declare namespace Models { "deliveryStatus"?: string; "deliveryStatusChangeDate"?: string; "destinationAddresses"?: Array; + "detectedSpeechEnd"?: string; + "detectedSpeechStart"?: string; "direction"?: string; "dispositionAnalyzer"?: string; "dispositionName"?: string; @@ -9040,6 +9143,8 @@ declare namespace Models { "externalId"?: string; "source"?: string; "rule"?: Models.LearningModuleRule; + "enforceContentOrder"?: boolean; + "reviewAssessmentResults"?: Models.ReviewAssessmentResults; "currentAssignments"?: Array; "selfUri"?: string; "isArchived"?: boolean; @@ -11737,6 +11842,19 @@ declare namespace Models { "isSelected"?: boolean; } + export interface CategoriesEntityListing { + "entities"?: Array; + "pageSize"?: number; + "pageNumber"?: number; + "total"?: number; + "previousUri"?: string; + "lastUri"?: string; + "firstUri"?: string; + "selfUri"?: string; + "nextUri"?: string; + "pageCount"?: number; + } + export interface Category { "name"?: string; } @@ -11772,6 +11890,13 @@ declare namespace Models { "selfUri"?: string; } + export interface CategoryRequest { + "name": string; + "description"?: string; + "interactionType": string; + "criteria": Models.Operand; + } + export interface CategoryResponse { "id"?: string; "name": string; @@ -11824,8 +11949,8 @@ declare namespace Models { "expirationDate"?: string; "issueDate"?: string; "expired"?: boolean; - "signatureValid"?: boolean; "valid"?: boolean; + "signatureValid"?: boolean; } export interface Change { @@ -12298,6 +12423,7 @@ declare namespace Models { "maskSelectors"?: Array; "channels"?: Array; "readonlySelectors"?: Array; + "pauseCriteria"?: Array; } export interface CobrowseWebMessagingSession { @@ -13837,6 +13963,27 @@ declare namespace Models { "endTime"?: string; } + export interface ConversationCategoriesEntityListing { + "entities"?: Array; + "pageSize"?: number; + "pageNumber"?: number; + "total"?: number; + "previousUri"?: string; + "lastUri"?: string; + "firstUri"?: string; + "selfUri"?: string; + "nextUri"?: string; + "pageCount"?: number; + } + + export interface ConversationCategory { + "id"?: string; + "name"?: string; + "description"?: string; + "interactionType"?: string; + "criteria"?: Models.Operand; + } + export interface ConversationChannel { "type": string; "messageType"?: string; @@ -14923,6 +15070,12 @@ declare namespace Models { "duration"?: number; } + export interface ConversationEventVideo { + "type": string; + "offeringId"?: string; + "jwt"?: string; + } + export interface ConversationMessageContent { "contentType": string; "location"?: Models.ConversationContentLocation; @@ -14942,6 +15095,7 @@ declare namespace Models { "coBrowse"?: Models.ConversationEventCoBrowse; "typing"?: Models.ConversationEventTyping; "presence"?: Models.ConversationEventPresence; + "video"?: Models.ConversationEventVideo; } export interface ConversationMessageEventTopicConversationRoutingData { @@ -15267,6 +15421,7 @@ declare namespace Models { "teamId"?: string; "usedRouting"?: string; "userId"?: string; + "videoPresent"?: boolean; "waitingInteractionCounts"?: Array; "wrapUpCode"?: string; "proposedAgents"?: Array; @@ -15951,6 +16106,7 @@ declare namespace Models { "callQueueId"?: string; "callUserId"?: string; "priority"?: number; + "attributes"?: { [key: string]: string; }; "languageId"?: string; "routingSkillsIds"?: Array; "conversationIds"?: Array; @@ -16833,6 +16989,8 @@ declare namespace Models { "dateCreated": string; "dateModified": string; "createdBy"?: Models.AddressableEntityRef; + "shared"?: boolean; + "dashboardsSharedWith"?: Models.DashboardsSharedWith; "selfUri"?: string; } @@ -16882,6 +17040,11 @@ declare namespace Models { "pageCount"?: number; } + export interface DashboardsSharedWith { + "userIds"?: Array; + "teamIds"?: Array; + } + export interface DataActionConditionPredicate { "outputField": string; "outputOperator": string; @@ -20137,7 +20300,6 @@ declare namespace Models { export interface EngineIntegration { "id"?: string; - "name"?: string; "selfUri"?: string; } @@ -21688,7 +21850,6 @@ declare namespace Models { "org"?: Models.FieldConfig; "person"?: Models.FieldConfig; "group"?: Models.FieldConfig; - "externalContact"?: Models.FieldConfig; } export interface FieldList { @@ -22276,6 +22437,7 @@ declare namespace Models { "transferType"?: string; "usedRouting"?: string; "userId"?: string; + "videoPresent"?: boolean; "waitingInteractionCounts"?: Array; "wrapUpCode"?: string; "proposedAgents"?: Array; @@ -23923,6 +24085,11 @@ declare namespace Models { "pageCount"?: number; } + export interface InfixOperator { + "operatorType": string; + "operatorPosition"?: Models.OperatorPosition; + } + export interface InfrastructureascodeJob { "id"?: string; "dryRun": boolean; @@ -25216,6 +25383,12 @@ declare namespace Models { "value"?: number; } + export interface JourneyViewListing { + "total"?: number; + "entities"?: Array; + "selfUri"?: string; + } + export interface JourneyViewResult { "elements"?: Array; } @@ -26108,6 +26281,8 @@ declare namespace Models { "labels"?: Array; "knowledgeBase"?: Models.KnowledgeBaseReference; "externalId"?: string; + "source"?: Models.AddressableEntityRef; + "readonly"?: boolean; "variations"?: Array; "selfUri"?: string; } @@ -26246,6 +26421,7 @@ declare namespace Models { export interface KnowledgeExportJobDocumentsFilter { "interval"?: string; "entities"?: Array; + "sourceId"?: string; } export interface KnowledgeExportJobFilter { @@ -26256,6 +26432,7 @@ declare namespace Models { export interface KnowledgeExportJobRequest { "exportFilter": Models.KnowledgeExportJobFilter; "fileType": string; + "sourceId"?: string; "jsonFileVersion"?: number; } @@ -26272,6 +26449,7 @@ declare namespace Models { "dateCreated"?: string; "dateModified"?: string; "errorInformation"?: Models.ErrorBody; + "source"?: Models.KnowledgeOperationSource; "selfUri"?: string; } @@ -26545,6 +26723,12 @@ declare namespace Models { "migrationDetected"?: boolean; } + export interface KnowledgeOperationSource { + "id"?: string; + "type"?: string; + "selfUri"?: string; + } + export interface KnowledgeParseImportResult { "success": number; "failure": number; @@ -26609,6 +26793,8 @@ declare namespace Models { "labels"?: Array; "knowledgeBase"?: Models.KnowledgeBaseReference; "externalId"?: string; + "source"?: Models.AddressableEntityRef; + "readonly"?: boolean; "variations"?: Array; "answer"?: string; "selfUri"?: string; @@ -26824,10 +27010,15 @@ declare namespace Models { "dateModified"?: string; "isOverdue"?: boolean; "percentageScore"?: number; + "assessmentPercentageScore"?: number; "isRule"?: boolean; "isManual"?: boolean; "isPassed"?: boolean; "isLatest"?: boolean; + "assessmentCompletionPercentage"?: number; + "completionPercentage"?: number; + "steps"?: Array; + "nextStep"?: Models.LearningAssignmentStep; "selfUri"?: string; "state"?: string; "dateRecommendedForCompletion"?: string; @@ -27065,6 +27256,8 @@ declare namespace Models { "externalId"?: string; "source"?: string; "rule"?: Models.LearningModuleRule; + "enforceContentOrder"?: boolean; + "reviewAssessmentResults"?: Models.ReviewAssessmentResults; "selfUri"?: string; "isArchived"?: boolean; "isPublished"?: boolean; @@ -27123,6 +27316,101 @@ declare namespace Models { "selfUri"?: string; } + export interface LearningModulePreviewGetResponse { + "id"?: string; + "name": string; + "description"?: string; + "coverArt"?: Models.LearningModuleCoverArtResponse; + "enforceContentOrder"?: boolean; + "reviewAssessmentResults"?: Models.ReviewAssessmentResults; + "assessmentForm"?: Models.AssessmentForm; + "assignment"?: Models.LearningModulePreviewGetResponseAssignment; + "selfUri"?: string; + } + + export interface LearningModulePreviewGetResponseAssignment { + "state"?: string; + "percentageScore"?: number; + "assessmentPercentageScore"?: number; + "isPassed"?: boolean; + "assessmentCompletionPercentage"?: number; + "completionPercentage"?: number; + "steps"?: Array; + } + + export interface LearningModulePreviewGetResponseStep { + "id"?: string; + "moduleStep"?: Models.LearningModuleInformStep; + "structure"?: Array; + "successStatus"?: string; + "completionStatus"?: string; + "completionPercentage"?: number; + "percentageScore"?: number; + "signedCookie"?: Models.LearningAssignmentStepSignedCookie; + } + + export interface LearningModulePreviewGetScoStructure { + "id"?: string; + "name"?: string; + "successStatus"?: string; + "completionStatus"?: string; + "percentageScore"?: number; + "shareableContentObject"?: Models.LearningShareableContentObject; + "children"?: Array; + } + + export interface LearningModulePreviewUpdateRequest { + "state"?: string; + "currentStep"?: Models.LearningModulePreviewUpdateRequestCurrentStep; + "steps"?: Array; + "assessment"?: Models.LearningAssessment; + "assessmentForm"?: Models.AssessmentForm; + } + + export interface LearningModulePreviewUpdateRequestCurrentStep { + "id"?: string; + "completionPercentage"?: number; + "shareableContentObject"?: Models.LearningShareableContentObject; + } + + export interface LearningModulePreviewUpdateResponse { + "id"?: string; + "assignment"?: Models.LearningModulePreviewUpdateResponseAssignment; + } + + export interface LearningModulePreviewUpdateResponseAssignment { + "state"?: string; + "percentageScore"?: number; + "completionPercentage"?: number; + "assessmentPercentageScore"?: number; + "assessmentCompletionPercentage"?: number; + "isPassed"?: boolean; + "currentStep"?: Models.LearningModulePreviewUpdateResponseCurrentStep; + "steps"?: Array; + } + + export interface LearningModulePreviewUpdateResponseCurrentStep { + "shareableContentObject"?: Models.LearningShareableContentObject; + } + + export interface LearningModulePreviewUpdateScoStructure { + "id"?: string; + "name"?: string; + "successStatus"?: string; + "completionStatus"?: string; + "percentageScore"?: number; + "children"?: Array; + } + + export interface LearningModulePreviewUpdateStep { + "id"?: string; + "successStatus"?: string; + "completionStatus"?: string; + "completionPercentage"?: number; + "percentageScore"?: number; + "structure"?: Array; + } + export interface LearningModulePublishRequest { "termsAndConditionsAccepted"?: boolean; } @@ -27152,6 +27440,8 @@ declare namespace Models { "lengthInMinutes"?: number; "excludedFromCatalog"?: boolean; "externalId"?: string; + "enforceContentOrder"?: boolean; + "reviewAssessmentResults"?: Models.ReviewAssessmentResults; } export interface LearningModuleRule { @@ -27200,6 +27490,27 @@ declare namespace Models { "wfmScheduleActivities"?: Array; } + export interface LearningScormResponse { + "id"?: string; + "status"?: string; + "errorCode"?: string; + "errorMessage"?: string; + "percentageUnpacked"?: number; + "selfUri"?: string; + } + + export interface LearningScormUploadRequest { + "contentMd5": string; + } + + export interface LearningScormUploadResponse { + "id"?: string; + "status"?: string; + "uploadUrl"?: string; + "headers"?: { [key: string]: string; }; + "selfUri"?: string; + } + export interface LearningShareableContentObject { "id": string; "lessonStatus"?: string; @@ -27893,9 +28204,9 @@ declare namespace Models { "settings"?: Models.ManagementUnitSettingsResponse; "metadata"?: Models.WfmVersionedEntityMetadata; "division"?: Models.DivisionReference; + "modifiedBy"?: Models.UserReference; "version"?: number; "dateModified"?: string; - "modifiedBy"?: Models.UserReference; "selfUri"?: string; } @@ -28680,32 +28991,6 @@ declare namespace Models { "id": string; } - export interface MessagingSticker { - "id"?: string; - "name"?: string; - "providerStickerId": number; - "providerPackageId"?: number; - "packageName"?: string; - "messengerType": string; - "stickerType": string; - "providerVersion"?: number; - "uriLocation"?: string; - "selfUri"?: string; - } - - export interface MessagingStickerEntityListing { - "entities"?: Array; - "pageSize"?: number; - "pageNumber"?: number; - "total"?: number; - "previousUri"?: string; - "lastUri"?: string; - "firstUri"?: string; - "selfUri"?: string; - "nextUri"?: string; - "pageCount"?: number; - } - export interface MessagingTemplate { "whatsApp"?: Models.WhatsAppDefinition; } @@ -29891,6 +30176,25 @@ declare namespace Models { "direction": string; } + export interface Operand { + "type": string; + "occurrence"?: number; + "inverted"?: boolean; + "term"?: Models.Term; + "topicId"?: string; + "voiceSecondsPosition"?: Models.OperandPosition; + "digitalWordsPosition"?: Models.OperandPosition; + "infixOperator"?: Models.InfixOperator; + "operands"?: Array; + } + + export interface OperandPosition { + "startingPositionValue"?: number; + "startingPositionDirection"?: string; + "endingPositionValue"?: number; + "endingPositionDirection"?: string; + } + export interface Operation { "id"?: string; "complete"?: boolean; @@ -29924,6 +30228,7 @@ declare namespace Models { "createdBy"?: Models.UserReference; "dateCreated"?: string; "dateModified"?: string; + "source"?: Models.KnowledgeOperationSource; "selfUri"?: string; } @@ -29947,6 +30252,11 @@ declare namespace Models { "timestamp"?: number; } + export interface OperatorPosition { + "voiceSecondsPosition"?: number; + "digitalWordsPosition"?: number; + } + export interface OptInSettings { "keyword": Array; "response": Models.ComplianceResponse; @@ -35227,6 +35537,10 @@ declare namespace Models { "to"?: string; "timestamp"?: string; "id"?: string; + "purpose"?: string; + "participantId"?: string; + "queue"?: Models.AddressableEntityRef; + "workflow"?: Models.AddressableEntityRef; "messageText"?: string; "messageMediaAttachments"?: Array; "messageStickerAttachments"?: Array; @@ -35980,6 +36294,8 @@ declare namespace Models { } export interface ReviewAssessmentResults { + "byAssignees"?: boolean; + "byViewers"?: boolean; } export interface Ring { @@ -37878,6 +38194,19 @@ declare namespace Models { "useWaterfallRule"?: boolean; } + export interface StaCategory { + "id"?: string; + "name"?: string; + "description"?: string; + "interactionType": string; + "criteria": Models.Operand; + "createdBy"?: Models.AddressableEntityRef; + "dateCreated"?: string; + "modifiedBy"?: Models.AddressableEntityRef; + "dateModified"?: string; + "selfUri"?: string; + } + export interface StaffingGroupListing { "entities"?: Array; } @@ -38822,6 +39151,11 @@ declare namespace Models { "value"?: string; } + export interface Term { + "word": string; + "participantType": string; + } + export interface TermAttribute { "id"?: string; "name"?: string; @@ -41677,10 +42011,12 @@ declare namespace Models { export interface UtilizationRequest { "utilization"?: { [key: string]: Models.MediaUtilization; }; + "labelUtilizations"?: { [key: string]: Models.LabelUtilizationRequest; }; } export interface UtilizationResponse { "utilization"?: { [key: string]: Models.MediaUtilization; }; + "labelUtilizations"?: { [key: string]: Models.LabelUtilizationResponse; }; } export interface UtilizationTag { @@ -41706,113 +42042,22 @@ declare namespace Models { "utteranceText"?: string; } - export interface V2ConversationMessageTypingEventForUserTopicConversationButtonComponent { - "title"?: string; - "actions"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentActions; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentActions { - "url"?: string; - "urlTarget"?: string; - "textback"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentAttachment { - "id"?: string; - "mediaType"?: string; - "url"?: string; - "mime"?: string; - "text"?: string; - "sha256"?: string; - "filename"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse { - "type"?: string; - "text"?: string; - "payload"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentGeneric { - "title"?: string; - "description"?: string; - "image"?: string; - "video"?: string; - "actions"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentActions; - "components"?: Array; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentLocation { - "url"?: string; - "address"?: string; - "text"?: string; - "latitude"?: number; - "longitude"?: number; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentNotificationTemplate { - "id"?: string; - "language"?: string; - "header"?: Models.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader; - "body"?: Models.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateBody; - "footer"?: Models.V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateFooter; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply { - "text"?: string; - "payload"?: string; - "image"?: string; - "action"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationContentStory { - "type"?: string; - "url"?: string; - "replyToId"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse { - "type"?: string; - "sessionId"?: string; - "sessionJoinToken"?: string; - } - export interface V2ConversationMessageTypingEventForUserTopicConversationEventTyping { "type"?: string; "duration"?: number; } - export interface V2ConversationMessageTypingEventForUserTopicConversationMessageContent { - "contentType"?: string; - "location"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentLocation; - "story"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentStory; - "attachment"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentAttachment; - "quickReply"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentQuickReply; - "template"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentNotificationTemplate; - "buttonResponse"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentButtonResponse; - "generic"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentGeneric; - } - export interface V2ConversationMessageTypingEventForUserTopicConversationMessageEvent { "eventType"?: string; - "coBrowse"?: Models.V2ConversationMessageTypingEventForUserTopicConversationEventCoBrowse; "typing"?: Models.V2ConversationMessageTypingEventForUserTopicConversationEventTyping; } export interface V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel { "id"?: string; "platform"?: string; - "messageId"?: string; "to"?: Models.V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient; "from"?: Models.V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient; "time"?: string; - "dateModified"?: string; - "dateDeleted"?: string; - "metadata"?: Models.V2ConversationMessageTypingEventForUserTopicConversationMessagingChannelMetadata; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationMessagingChannelMetadata { - "customAttributes"?: { [key: string]: string; }; } export interface V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient { @@ -41838,44 +42083,10 @@ declare namespace Models { } export interface V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage { - "id"?: string; "channel"?: Models.V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel; "type"?: string; - "text"?: string; - "content"?: Array; "events"?: Array; - "status"?: string; - "reasons"?: Array; - "originatingEntity"?: string; - "isFinalReceipt"?: boolean; "direction"?: string; - "metadata"?: { [key: string]: string; }; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateBody { - "text"?: string; - "parameters"?: Array; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateFooter { - "text"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateHeader { - "type"?: string; - "text"?: string; - "media"?: Models.V2ConversationMessageTypingEventForUserTopicConversationContentAttachment; - "parameters"?: Array; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationNotificationTemplateParameter { - "name"?: string; - "text"?: string; - } - - export interface V2ConversationMessageTypingEventForUserTopicConversationReason { - "code"?: string; - "message"?: string; } export interface V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier { @@ -41888,113 +42099,22 @@ declare namespace Models { "normalizedMessage"?: Models.V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage; } - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationButtonComponent { - "title"?: string; - "actions"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions { - "url"?: string; - "urlTarget"?: string; - "textback"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment { - "id"?: string; - "mediaType"?: string; - "url"?: string; - "mime"?: string; - "text"?: string; - "sha256"?: string; - "filename"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse { - "type"?: string; - "text"?: string; - "payload"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentGeneric { - "title"?: string; - "description"?: string; - "image"?: string; - "video"?: string; - "actions"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentActions; - "components"?: Array; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentLocation { - "url"?: string; - "address"?: string; - "text"?: string; - "latitude"?: number; - "longitude"?: number; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentNotificationTemplate { - "id"?: string; - "language"?: string; - "header"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader; - "body"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateBody; - "footer"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateFooter; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply { - "text"?: string; - "payload"?: string; - "image"?: string; - "action"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory { - "type"?: string; - "url"?: string; - "replyToId"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse { - "type"?: string; - "sessionId"?: string; - "sessionJoinToken"?: string; - } - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping { "type"?: string; "duration"?: number; } - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationMessageContent { - "contentType"?: string; - "location"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentLocation; - "story"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentStory; - "attachment"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment; - "quickReply"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentQuickReply; - "template"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentNotificationTemplate; - "buttonResponse"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentButtonResponse; - "generic"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentGeneric; - } - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent { "eventType"?: string; - "coBrowse"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationEventCoBrowse; "typing"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping; } export interface V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel { "id"?: string; "platform"?: string; - "messageId"?: string; "to"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient; "from"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient; "time"?: string; - "dateModified"?: string; - "dateDeleted"?: string; - "metadata"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannelMetadata; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannelMetadata { - "customAttributes"?: { [key: string]: string; }; } export interface V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient { @@ -42020,44 +42140,10 @@ declare namespace Models { } export interface V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage { - "id"?: string; "channel"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel; "type"?: string; - "text"?: string; - "content"?: Array; "events"?: Array; - "status"?: string; - "reasons"?: Array; - "originatingEntity"?: string; - "isFinalReceipt"?: boolean; "direction"?: string; - "metadata"?: { [key: string]: string; }; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateBody { - "text"?: string; - "parameters"?: Array; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateFooter { - "text"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateHeader { - "type"?: string; - "text"?: string; - "media"?: Models.V2ConversationMessageTypingEventForWorkflowTopicConversationContentAttachment; - "parameters"?: Array; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationNotificationTemplateParameter { - "name"?: string; - "text"?: string; - } - - export interface V2ConversationMessageTypingEventForWorkflowTopicConversationReason { - "code"?: string; - "message"?: string; } export interface V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier { @@ -42580,6 +42666,21 @@ declare namespace Models { "surveyTypes"?: Array; "surveyResponseStatuses"?: Array; "botFlowTypes"?: Array; + "agentTalkDurationMilliseconds"?: Array; + "customerTalkDurationMilliseconds"?: Array; + "overtalkDurationMilliseconds"?: Array; + "silenceDurationMilliseconds"?: Array; + "acdDurationMilliseconds"?: Array; + "ivrDurationMilliseconds"?: Array; + "otherDurationMilliseconds"?: Array; + "agentTalkPercentage"?: Models.NumericRange; + "customerTalkPercentage"?: Models.NumericRange; + "overtalkPercentage"?: Models.NumericRange; + "silencePercentage"?: Models.NumericRange; + "acdPercentage"?: Models.NumericRange; + "ivrPercentage"?: Models.NumericRange; + "otherPercentage"?: Models.NumericRange; + "overtalkInstances"?: Models.NumericRange; "isScreenRecorded"?: boolean; "screenMonitorUserIds"?: Array; } @@ -45786,6 +45887,7 @@ declare namespace Models { "defaultQueueId"?: Models.WorkitemsAttributeChangeString; "schemaId"?: Models.WorkitemsAttributeChangeString; "schemaVersion"?: Models.WorkitemsAttributeChangeString; + "serviceLevelTarget"?: Models.WorkitemsAttributeChangeInteger; "dateModified"?: Models.WorkitemsAttributeChangeInstant; "modifiedBy"?: Models.WorkitemsAttributeChangeString; } diff --git a/build/package-lock.json b/build/package-lock.json index 455fc75a..e6bfaa5e 100644 --- a/build/package-lock.json +++ b/build/package-lock.json @@ -1,12 +1,12 @@ { "name": "purecloud-platform-client-v2", - "version": "194.0.0", + "version": "195.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "purecloud-platform-client-v2", - "version": "194.0.0", + "version": "195.0.0", "license": "MIT", "dependencies": { "axios": "^1.6.5", @@ -2288,9 +2288,9 @@ } }, "node_modules/browserslist": { - "version": "4.23.0", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.0.tgz", - "integrity": "sha512-QW8HiM1shhT2GuzkvklfjcKDiWFXHOeFCIA/huJPwHsslwcydgk7X+z2zXpEijP98UCY7HbubZt5J2Zgvf0CaQ==", + "version": "4.23.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.1.tgz", + "integrity": "sha512-TUfofFo/KsK/bWZ9TWQ5O26tsWW4Uhmt8IYklbnUa70udB6P2wA7w7o4PY4muaEPBQaAX+CEnmmIA41NVHtPVw==", "dev": true, "funding": [ { @@ -2307,10 +2307,10 @@ } ], "dependencies": { - "caniuse-lite": "^1.0.30001587", - "electron-to-chromium": "^1.4.668", + "caniuse-lite": "^1.0.30001629", + "electron-to-chromium": "^1.4.796", "node-releases": "^2.0.14", - "update-browserslist-db": "^1.0.13" + "update-browserslist-db": "^1.0.16" }, "bin": { "browserslist": "cli.js" @@ -2380,9 +2380,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001629", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001629.tgz", - "integrity": "sha512-c3dl911slnQhmxUIT4HhYzT7wnBK/XYpGnYLOj4nJBaRiw52Ibe7YxlDaAeRECvA786zCuExhxIUJ2K7nHMrBw==", + "version": "1.0.30001634", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001634.tgz", + "integrity": "sha512-fbBYXQ9q3+yp1q1gBk86tOFs4pyn/yxFm5ZNP18OXJDfA3txImOY9PhfxVggZ4vRHDqoU8NrKU81eN0OtzOgRA==", "dev": true, "funding": [ { @@ -2754,9 +2754,9 @@ "dev": true }, "node_modules/electron-to-chromium": { - "version": "1.4.794", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.794.tgz", - "integrity": "sha512-6FApLtsYhDCY0Vglq3AptsdxQ+PJLc6AxlAM0HjEihUAiOPPbkASEsq9gtxUeZY9o0sJIEa3WnF0vVH4VT4iug==", + "version": "1.4.803", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.803.tgz", + "integrity": "sha512-61H9mLzGOCLLVsnLiRzCbc63uldP0AniRYPV3hbGVtONA1pI7qSGILdbofR7A8TMbOypDocEAjH/e+9k1QIe3g==", "dev": true }, "node_modules/elliptic": { diff --git a/build/package.json b/build/package.json index fa18a69b..b72eb45f 100644 --- a/build/package.json +++ b/build/package.json @@ -1,6 +1,6 @@ { "name": "purecloud-platform-client-v2", - "version": "194.0.0", + "version": "195.0.0", "description": "A JavaScript library to interface with the PureCloud Platform API", "license": "MIT", "main": "dist/node/purecloud-platform-client-v2.js", diff --git a/build/src/purecloud-platform-client-v2/ApiClient.js b/build/src/purecloud-platform-client-v2/ApiClient.js index 3cb756ba..979fdbf2 100644 --- a/build/src/purecloud-platform-client-v2/ApiClient.js +++ b/build/src/purecloud-platform-client-v2/ApiClient.js @@ -4,7 +4,7 @@ import { default as qs } from 'qs'; /** * @module purecloud-platform-client-v2/ApiClient - * @version 194.0.0 + * @version 195.0.0 */ class ApiClient { /** @@ -1079,6 +1079,9 @@ class ApiClient { if (param instanceof Date) { return param.toJSON(); } + if (param instanceof Boolean) { + return param.toString().toLowerCase(); + } return param.toString(); } diff --git a/build/src/purecloud-platform-client-v2/api/AlertingApi.js b/build/src/purecloud-platform-client-v2/api/AlertingApi.js index 88e1f4aa..236926de 100644 --- a/build/src/purecloud-platform-client-v2/api/AlertingApi.js +++ b/build/src/purecloud-platform-client-v2/api/AlertingApi.js @@ -5,7 +5,7 @@ class AlertingApi { /** * Alerting service. * @module purecloud-platform-client-v2/api/AlertingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/AnalyticsApi.js b/build/src/purecloud-platform-client-v2/api/AnalyticsApi.js index 14a252ba..003f042f 100644 --- a/build/src/purecloud-platform-client-v2/api/AnalyticsApi.js +++ b/build/src/purecloud-platform-client-v2/api/AnalyticsApi.js @@ -5,7 +5,7 @@ class AnalyticsApi { /** * Analytics service. * @module purecloud-platform-client-v2/api/AnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -126,6 +126,62 @@ class AnalyticsApi { ); } + /** + * Get status for async query for agent copilot aggregates + * + * @param {String} jobId jobId + * getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJob(jobId) { + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}', + 'GET', + { 'jobId': jobId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Fetch a page of results for an async aggregates query + * + * @param {String} jobId jobId + * @param {Object} opts Optional parameters + * @param {String} opts.cursor Cursor token to retrieve next page + * getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) { + opts = opts || {}; + + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJobResults'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results', + 'GET', + { 'jobId': jobId }, + { 'cursor': opts['cursor'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Reporting Turns (division aware). * Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. @@ -884,6 +940,42 @@ class AnalyticsApi { ); } + /** + * Get list of dashboard configurations + * + * @param {Object} dashboardType List dashboard of given type + * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard + * @param {Object} opts Optional parameters + * @param {String} opts.sortBy (default to desc) + * @param {Number} opts.pageNumber (default to 1) + * @param {Number} opts.pageSize (default to 9) + */ + getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) { + opts = opts || {}; + + // verify the required parameter 'dashboardType' is set + if (dashboardType === undefined || dashboardType === null) { + throw 'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + // verify the required parameter 'dashboardAccessFilter' is set + if (dashboardAccessFilter === undefined || dashboardAccessFilter === null) { + throw 'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/reporting/settings/dashboards/query', + 'GET', + { }, + { 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get list of dashboards for an user * @@ -1349,6 +1441,58 @@ class AnalyticsApi { ); } + /** + * Query for agent copilot aggregates asynchronously + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesJobs(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/jobs', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Query for agent copilot aggregates + * + * @param {Object} body query + * postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice + */ + postAnalyticsAgentcopilotsAggregatesQuery(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery'; + } + + return this.apiClient.callApi( + '/api/v2/analytics/agentcopilots/aggregates/query', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Query for bot aggregates asynchronously * @@ -1922,8 +2066,8 @@ class AnalyticsApi { } /** - * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded - * + * Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate. + * The max property can be used to determine estimated rate limit value hit. * @param {Object} body query */ postAnalyticsRatelimitsAggregatesQuery(body) { diff --git a/build/src/purecloud-platform-client-v2/api/ArchitectApi.js b/build/src/purecloud-platform-client-v2/api/ArchitectApi.js index 44cb05c8..c8794cd3 100644 --- a/build/src/purecloud-platform-client-v2/api/ArchitectApi.js +++ b/build/src/purecloud-platform-client-v2/api/ArchitectApi.js @@ -5,7 +5,7 @@ class ArchitectApi { /** * Architect service. * @module purecloud-platform-client-v2/api/ArchitectApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/AuditApi.js b/build/src/purecloud-platform-client-v2/api/AuditApi.js index 0006b37a..6c6017a6 100644 --- a/build/src/purecloud-platform-client-v2/api/AuditApi.js +++ b/build/src/purecloud-platform-client-v2/api/AuditApi.js @@ -5,7 +5,7 @@ class AuditApi { /** * Audit service. * @module purecloud-platform-client-v2/api/AuditApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/AuthorizationApi.js b/build/src/purecloud-platform-client-v2/api/AuthorizationApi.js index 9bc00dff..75146ad5 100644 --- a/build/src/purecloud-platform-client-v2/api/AuthorizationApi.js +++ b/build/src/purecloud-platform-client-v2/api/AuthorizationApi.js @@ -5,7 +5,7 @@ class AuthorizationApi { /** * Authorization service. * @module purecloud-platform-client-v2/api/AuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/BillingApi.js b/build/src/purecloud-platform-client-v2/api/BillingApi.js index 67e2d8a4..55ae8af9 100644 --- a/build/src/purecloud-platform-client-v2/api/BillingApi.js +++ b/build/src/purecloud-platform-client-v2/api/BillingApi.js @@ -5,7 +5,7 @@ class BillingApi { /** * Billing service. * @module purecloud-platform-client-v2/api/BillingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/CarrierServicesApi.js b/build/src/purecloud-platform-client-v2/api/CarrierServicesApi.js index c04763b8..0626baea 100644 --- a/build/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +++ b/build/src/purecloud-platform-client-v2/api/CarrierServicesApi.js @@ -5,7 +5,7 @@ class CarrierServicesApi { /** * CarrierServices service. * @module purecloud-platform-client-v2/api/CarrierServicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ChatApi.js b/build/src/purecloud-platform-client-v2/api/ChatApi.js index 4eb11a1e..d423f626 100644 --- a/build/src/purecloud-platform-client-v2/api/ChatApi.js +++ b/build/src/purecloud-platform-client-v2/api/ChatApi.js @@ -5,7 +5,7 @@ class ChatApi { /** * Chat service. * @module purecloud-platform-client-v2/api/ChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/CoachingApi.js b/build/src/purecloud-platform-client-v2/api/CoachingApi.js index d10ec715..2166fd42 100644 --- a/build/src/purecloud-platform-client-v2/api/CoachingApi.js +++ b/build/src/purecloud-platform-client-v2/api/CoachingApi.js @@ -5,7 +5,7 @@ class CoachingApi { /** * Coaching service. * @module purecloud-platform-client-v2/api/CoachingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ContentManagementApi.js b/build/src/purecloud-platform-client-v2/api/ContentManagementApi.js index 0bd1862d..fccc8614 100644 --- a/build/src/purecloud-platform-client-v2/api/ContentManagementApi.js +++ b/build/src/purecloud-platform-client-v2/api/ContentManagementApi.js @@ -5,7 +5,7 @@ class ContentManagementApi { /** * ContentManagement service. * @module purecloud-platform-client-v2/api/ContentManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ConversationsApi.js b/build/src/purecloud-platform-client-v2/api/ConversationsApi.js index 8399fffd..c174a98e 100644 --- a/build/src/purecloud-platform-client-v2/api/ConversationsApi.js +++ b/build/src/purecloud-platform-client-v2/api/ConversationsApi.js @@ -5,7 +5,7 @@ class ConversationsApi { /** * Conversations service. * @module purecloud-platform-client-v2/api/ConversationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -2413,37 +2413,6 @@ class ConversationsApi { ); } - /** - * Get a list of Messaging Stickers (Deprecated) - * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/ - * @param {Object} messengerType Messenger Type - * @param {Object} opts Optional parameters - * @param {Number} opts.pageSize Page size (default to 25) - * @param {Number} opts.pageNumber Page number (default to 1) - * @deprecated - */ - getConversationsMessagingSticker(messengerType, opts) { - opts = opts || {}; - - // verify the required parameter 'messengerType' is set - if (messengerType === undefined || messengerType === null) { - throw 'Missing the required parameter "messengerType" when calling getConversationsMessagingSticker'; - } - - return this.apiClient.callApi( - '/api/v2/conversations/messaging/stickers/{messengerType}', - 'GET', - { 'messengerType': messengerType }, - { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, - { }, - { }, - null, - ['PureCloud OAuth'], - ['application/json'], - ['application/json'] - ); - } - /** * Get a list of Supported Content profiles * @@ -5546,6 +5515,31 @@ class ConversationsApi { ); } + /** + * Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation + * + * @param {String} conversationId conversationId + */ + postConversationsEmailReconnect(conversationId) { + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling postConversationsEmailReconnect'; + } + + return this.apiClient.callApi( + '/api/v2/conversations/emails/{conversationId}/reconnect', + 'POST', + { 'conversationId': conversationId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create an email conversation * If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. diff --git a/build/src/purecloud-platform-client-v2/api/DataExtensionsApi.js b/build/src/purecloud-platform-client-v2/api/DataExtensionsApi.js index 73e271c9..2673c933 100644 --- a/build/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +++ b/build/src/purecloud-platform-client-v2/api/DataExtensionsApi.js @@ -5,7 +5,7 @@ class DataExtensionsApi { /** * DataExtensions service. * @module purecloud-platform-client-v2/api/DataExtensionsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/DownloadsApi.js b/build/src/purecloud-platform-client-v2/api/DownloadsApi.js index 70347655..cc97bc0f 100644 --- a/build/src/purecloud-platform-client-v2/api/DownloadsApi.js +++ b/build/src/purecloud-platform-client-v2/api/DownloadsApi.js @@ -5,7 +5,7 @@ class DownloadsApi { /** * Downloads service. * @module purecloud-platform-client-v2/api/DownloadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/EmailsApi.js b/build/src/purecloud-platform-client-v2/api/EmailsApi.js index 9db7a4ae..f8277a58 100644 --- a/build/src/purecloud-platform-client-v2/api/EmailsApi.js +++ b/build/src/purecloud-platform-client-v2/api/EmailsApi.js @@ -5,7 +5,7 @@ class EmailsApi { /** * Emails service. * @module purecloud-platform-client-v2/api/EmailsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/EventsApi.js b/build/src/purecloud-platform-client-v2/api/EventsApi.js index 9bb79643..6abadc89 100644 --- a/build/src/purecloud-platform-client-v2/api/EventsApi.js +++ b/build/src/purecloud-platform-client-v2/api/EventsApi.js @@ -5,7 +5,7 @@ class EventsApi { /** * Events service. * @module purecloud-platform-client-v2/api/EventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ExternalContactsApi.js b/build/src/purecloud-platform-client-v2/api/ExternalContactsApi.js index 7b393ee9..17eb2d01 100644 --- a/build/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +++ b/build/src/purecloud-platform-client-v2/api/ExternalContactsApi.js @@ -5,7 +5,7 @@ class ExternalContactsApi { /** * ExternalContacts service. * @module purecloud-platform-client-v2/api/ExternalContactsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/FaxApi.js b/build/src/purecloud-platform-client-v2/api/FaxApi.js index 1bd544a5..bbcd37ee 100644 --- a/build/src/purecloud-platform-client-v2/api/FaxApi.js +++ b/build/src/purecloud-platform-client-v2/api/FaxApi.js @@ -5,7 +5,7 @@ class FaxApi { /** * Fax service. * @module purecloud-platform-client-v2/api/FaxApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/FlowsApi.js b/build/src/purecloud-platform-client-v2/api/FlowsApi.js index 59d9e3ec..41748e68 100644 --- a/build/src/purecloud-platform-client-v2/api/FlowsApi.js +++ b/build/src/purecloud-platform-client-v2/api/FlowsApi.js @@ -5,7 +5,7 @@ class FlowsApi { /** * Flows service. * @module purecloud-platform-client-v2/api/FlowsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/GamificationApi.js b/build/src/purecloud-platform-client-v2/api/GamificationApi.js index a1a4f93c..1d8088af 100644 --- a/build/src/purecloud-platform-client-v2/api/GamificationApi.js +++ b/build/src/purecloud-platform-client-v2/api/GamificationApi.js @@ -5,7 +5,7 @@ class GamificationApi { /** * Gamification service. * @module purecloud-platform-client-v2/api/GamificationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js b/build/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js index c30878e7..0fb4ecd6 100644 --- a/build/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +++ b/build/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js @@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi { /** * GeneralDataProtectionRegulation service. * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/GeolocationApi.js b/build/src/purecloud-platform-client-v2/api/GeolocationApi.js index 24c27b91..acc79751 100644 --- a/build/src/purecloud-platform-client-v2/api/GeolocationApi.js +++ b/build/src/purecloud-platform-client-v2/api/GeolocationApi.js @@ -5,7 +5,7 @@ class GeolocationApi { /** * Geolocation service. * @module purecloud-platform-client-v2/api/GeolocationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/GreetingsApi.js b/build/src/purecloud-platform-client-v2/api/GreetingsApi.js index 0e2dbcf1..9902eebe 100644 --- a/build/src/purecloud-platform-client-v2/api/GreetingsApi.js +++ b/build/src/purecloud-platform-client-v2/api/GreetingsApi.js @@ -5,7 +5,7 @@ class GreetingsApi { /** * Greetings service. * @module purecloud-platform-client-v2/api/GreetingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/GroupsApi.js b/build/src/purecloud-platform-client-v2/api/GroupsApi.js index 6b914c9a..ce58d08e 100644 --- a/build/src/purecloud-platform-client-v2/api/GroupsApi.js +++ b/build/src/purecloud-platform-client-v2/api/GroupsApi.js @@ -5,7 +5,7 @@ class GroupsApi { /** * Groups service. * @module purecloud-platform-client-v2/api/GroupsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/IdentityProviderApi.js b/build/src/purecloud-platform-client-v2/api/IdentityProviderApi.js index 420d42ac..6c2a10b3 100644 --- a/build/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +++ b/build/src/purecloud-platform-client-v2/api/IdentityProviderApi.js @@ -5,7 +5,7 @@ class IdentityProviderApi { /** * IdentityProvider service. * @module purecloud-platform-client-v2/api/IdentityProviderApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js b/build/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js index 6fcb36ae..2a37d6d8 100644 --- a/build/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +++ b/build/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js @@ -5,7 +5,7 @@ class InfrastructureAsCodeApi { /** * InfrastructureAsCode service. * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/IntegrationsApi.js b/build/src/purecloud-platform-client-v2/api/IntegrationsApi.js index 2c7fb2ae..3475e7df 100644 --- a/build/src/purecloud-platform-client-v2/api/IntegrationsApi.js +++ b/build/src/purecloud-platform-client-v2/api/IntegrationsApi.js @@ -5,7 +5,7 @@ class IntegrationsApi { /** * Integrations service. * @module purecloud-platform-client-v2/api/IntegrationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/JourneyApi.js b/build/src/purecloud-platform-client-v2/api/JourneyApi.js index 65c88321..4e7168f0 100644 --- a/build/src/purecloud-platform-client-v2/api/JourneyApi.js +++ b/build/src/purecloud-platform-client-v2/api/JourneyApi.js @@ -5,7 +5,7 @@ class JourneyApi { /** * Journey service. * @module purecloud-platform-client-v2/api/JourneyApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/KnowledgeApi.js b/build/src/purecloud-platform-client-v2/api/KnowledgeApi.js index 3d035cea..702974e2 100644 --- a/build/src/purecloud-platform-client-v2/api/KnowledgeApi.js +++ b/build/src/purecloud-platform-client-v2/api/KnowledgeApi.js @@ -5,7 +5,7 @@ class KnowledgeApi { /** * Knowledge service. * @module purecloud-platform-client-v2/api/KnowledgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -1359,6 +1359,7 @@ class KnowledgeApi { * @param {Array.} opts.type If specified, retrieves operations with specified operation type, comma separated values expected. * @param {Array.} opts.status If specified, retrieves operations with specified operation status, comma separated values expected. * @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ + * @param {Array.} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected. * getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) { @@ -1373,7 +1374,7 @@ class KnowledgeApi { '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations', 'GET', { 'knowledgeBaseId': knowledgeBaseId }, - { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] }, + { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'],'sourceId': this.apiClient.buildCollectionParam(opts['sourceId'], 'multi') }, { }, { }, null, diff --git a/build/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js b/build/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js index 05eee697..43c68f67 100644 --- a/build/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +++ b/build/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js @@ -5,7 +5,7 @@ class LanguageUnderstandingApi { /** * LanguageUnderstanding service. * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/LanguagesApi.js b/build/src/purecloud-platform-client-v2/api/LanguagesApi.js index 0a5dea2c..6061b365 100644 --- a/build/src/purecloud-platform-client-v2/api/LanguagesApi.js +++ b/build/src/purecloud-platform-client-v2/api/LanguagesApi.js @@ -5,7 +5,7 @@ class LanguagesApi { /** * Languages service. * @module purecloud-platform-client-v2/api/LanguagesApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/LearningApi.js b/build/src/purecloud-platform-client-v2/api/LearningApi.js index 00552aa6..fdd50afb 100644 --- a/build/src/purecloud-platform-client-v2/api/LearningApi.js +++ b/build/src/purecloud-platform-client-v2/api/LearningApi.js @@ -5,7 +5,7 @@ class LearningApi { /** * Learning service. * @module purecloud-platform-client-v2/api/LearningApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -99,6 +99,41 @@ class LearningApi { ); } + /** + * Get Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {String} opts.shareableContentObjectId The ID of SCO to load + * @param {Array.} opts.expand Fields to expand in response + */ + getLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling getLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'GET', + { 'assignmentId': assignmentId,'stepId': stepId }, + { 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * List of Learning module Assignments * Either moduleId or user value is required @@ -233,6 +268,31 @@ class LearningApi { ); } + /** + * Get a learning module preview + * + * @param {String} moduleId The ID of the learning module + */ + getLearningModulePreview(moduleId) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling getLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'GET', + { 'moduleId': moduleId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get a learning module rule * @@ -385,6 +445,31 @@ class LearningApi { ); } + /** + * Get Learning SCORM Result + * + * @param {String} scormId The ID of the SCORM package + */ + getLearningScormScormId(scormId) { + // verify the required parameter 'scormId' is set + if (scormId === undefined || scormId === null) { + throw 'Missing the required parameter "scormId" when calling getLearningScormScormId'; + } + + return this.apiClient.callApi( + '/api/v2/learning/scorm/{scormId}', + 'GET', + { 'scormId': scormId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update Learning Assignment * @@ -443,6 +528,40 @@ class LearningApi { ); } + /** + * Update Learning Assignment Step + * Permission not required if you are the assigned user of the learning assignment + * @param {String} assignmentId The ID of Learning Assignment + * @param {String} stepId The ID of Learning Assignment Step + * @param {Object} opts Optional parameters + * @param {Object} opts.body The Learning Assignment Step to be updated + */ + patchLearningAssignmentStep(assignmentId, stepId, opts) { + opts = opts || {}; + + // verify the required parameter 'assignmentId' is set + if (assignmentId === undefined || assignmentId === null) { + throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentStep'; + } + // verify the required parameter 'stepId' is set + if (stepId === undefined || stepId === null) { + throw 'Missing the required parameter "stepId" when calling patchLearningAssignmentStep'; + } + + return this.apiClient.callApi( + '/api/v2/learning/assignments/{assignmentId}/steps/{stepId}', + 'PATCH', + { 'assignmentId': assignmentId,'stepId': stepId }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update an external assignment for a specific user * @@ -794,6 +913,30 @@ class LearningApi { ); } + /** + * Create a SCORM package upload request + * + * @param {Object} opts Optional parameters + * @param {Object} opts.body The SCORM package to be uploaded + */ + postLearningScorm(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/learning/scorm', + 'POST', + { }, + { }, + { }, + { }, + opts['body'], + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module * This will update the name, description, completion time in days and inform steps for a learning module @@ -824,6 +967,36 @@ class LearningApi { ); } + /** + * Update a learning module preview + * This will update a learning module preview + * @param {String} moduleId The ID of the learning module + * @param {Object} body The learning module to be updated + */ + putLearningModulePreview(moduleId, body) { + // verify the required parameter 'moduleId' is set + if (moduleId === undefined || moduleId === null) { + throw 'Missing the required parameter "moduleId" when calling putLearningModulePreview'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putLearningModulePreview'; + } + + return this.apiClient.callApi( + '/api/v2/learning/modules/{moduleId}/preview', + 'PUT', + { 'moduleId': moduleId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update a learning module rule * This will update a learning module rule with the specified fields. diff --git a/build/src/purecloud-platform-client-v2/api/LicenseApi.js b/build/src/purecloud-platform-client-v2/api/LicenseApi.js index db1748f1..ba58ba14 100644 --- a/build/src/purecloud-platform-client-v2/api/LicenseApi.js +++ b/build/src/purecloud-platform-client-v2/api/LicenseApi.js @@ -5,7 +5,7 @@ class LicenseApi { /** * License service. * @module purecloud-platform-client-v2/api/LicenseApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/LocationsApi.js b/build/src/purecloud-platform-client-v2/api/LocationsApi.js index 89ccf117..98ece266 100644 --- a/build/src/purecloud-platform-client-v2/api/LocationsApi.js +++ b/build/src/purecloud-platform-client-v2/api/LocationsApi.js @@ -5,7 +5,7 @@ class LocationsApi { /** * Locations service. * @module purecloud-platform-client-v2/api/LocationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/LogCaptureApi.js b/build/src/purecloud-platform-client-v2/api/LogCaptureApi.js index 998ced83..53910c9d 100644 --- a/build/src/purecloud-platform-client-v2/api/LogCaptureApi.js +++ b/build/src/purecloud-platform-client-v2/api/LogCaptureApi.js @@ -5,7 +5,7 @@ class LogCaptureApi { /** * LogCapture service. * @module purecloud-platform-client-v2/api/LogCaptureApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/MessagingApi.js b/build/src/purecloud-platform-client-v2/api/MessagingApi.js index cd1d7081..6fb59312 100644 --- a/build/src/purecloud-platform-client-v2/api/MessagingApi.js +++ b/build/src/purecloud-platform-client-v2/api/MessagingApi.js @@ -5,7 +5,7 @@ class MessagingApi { /** * Messaging service. * @module purecloud-platform-client-v2/api/MessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/MobileDevicesApi.js b/build/src/purecloud-platform-client-v2/api/MobileDevicesApi.js index d4d54662..997821fb 100644 --- a/build/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +++ b/build/src/purecloud-platform-client-v2/api/MobileDevicesApi.js @@ -5,7 +5,7 @@ class MobileDevicesApi { /** * MobileDevices service. * @module purecloud-platform-client-v2/api/MobileDevicesApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/NotificationsApi.js b/build/src/purecloud-platform-client-v2/api/NotificationsApi.js index ff050299..4ac904ff 100644 --- a/build/src/purecloud-platform-client-v2/api/NotificationsApi.js +++ b/build/src/purecloud-platform-client-v2/api/NotificationsApi.js @@ -5,7 +5,7 @@ class NotificationsApi { /** * Notifications service. * @module purecloud-platform-client-v2/api/NotificationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/OAuthApi.js b/build/src/purecloud-platform-client-v2/api/OAuthApi.js index 6a85bf0e..fb5d797d 100644 --- a/build/src/purecloud-platform-client-v2/api/OAuthApi.js +++ b/build/src/purecloud-platform-client-v2/api/OAuthApi.js @@ -5,7 +5,7 @@ class OAuthApi { /** * OAuth service. * @module purecloud-platform-client-v2/api/OAuthApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ObjectsApi.js b/build/src/purecloud-platform-client-v2/api/ObjectsApi.js index 79b71729..69e95427 100644 --- a/build/src/purecloud-platform-client-v2/api/ObjectsApi.js +++ b/build/src/purecloud-platform-client-v2/api/ObjectsApi.js @@ -5,7 +5,7 @@ class ObjectsApi { /** * Objects service. * @module purecloud-platform-client-v2/api/ObjectsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/OperationalEventsApi.js b/build/src/purecloud-platform-client-v2/api/OperationalEventsApi.js index 76effdc7..21af3c12 100644 --- a/build/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +++ b/build/src/purecloud-platform-client-v2/api/OperationalEventsApi.js @@ -5,7 +5,7 @@ class OperationalEventsApi { /** * OperationalEvents service. * @module purecloud-platform-client-v2/api/OperationalEventsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/OrganizationApi.js b/build/src/purecloud-platform-client-v2/api/OrganizationApi.js index 51283701..0efee977 100644 --- a/build/src/purecloud-platform-client-v2/api/OrganizationApi.js +++ b/build/src/purecloud-platform-client-v2/api/OrganizationApi.js @@ -5,7 +5,7 @@ class OrganizationApi { /** * Organization service. * @module purecloud-platform-client-v2/api/OrganizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js b/build/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js index 1d997736..73197c4f 100644 --- a/build/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +++ b/build/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js @@ -5,7 +5,7 @@ class OrganizationAuthorizationApi { /** * OrganizationAuthorization service. * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/OutboundApi.js b/build/src/purecloud-platform-client-v2/api/OutboundApi.js index db90f10f..d35e663f 100644 --- a/build/src/purecloud-platform-client-v2/api/OutboundApi.js +++ b/build/src/purecloud-platform-client-v2/api/OutboundApi.js @@ -5,7 +5,7 @@ class OutboundApi { /** * Outbound service. * @module purecloud-platform-client-v2/api/OutboundApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/PresenceApi.js b/build/src/purecloud-platform-client-v2/api/PresenceApi.js index bdde6bd4..76cd98bb 100644 --- a/build/src/purecloud-platform-client-v2/api/PresenceApi.js +++ b/build/src/purecloud-platform-client-v2/api/PresenceApi.js @@ -5,7 +5,7 @@ class PresenceApi { /** * Presence service. * @module purecloud-platform-client-v2/api/PresenceApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js b/build/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js index ed9e76c1..838f002c 100644 --- a/build/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +++ b/build/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js @@ -5,7 +5,7 @@ class ProcessAutomationApi { /** * ProcessAutomation service. * @module purecloud-platform-client-v2/api/ProcessAutomationApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/QualityApi.js b/build/src/purecloud-platform-client-v2/api/QualityApi.js index c4efa942..c196f4a2 100644 --- a/build/src/purecloud-platform-client-v2/api/QualityApi.js +++ b/build/src/purecloud-platform-client-v2/api/QualityApi.js @@ -5,7 +5,7 @@ class QualityApi { /** * Quality service. * @module purecloud-platform-client-v2/api/QualityApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/RecordingApi.js b/build/src/purecloud-platform-client-v2/api/RecordingApi.js index a656aaa1..b68982b5 100644 --- a/build/src/purecloud-platform-client-v2/api/RecordingApi.js +++ b/build/src/purecloud-platform-client-v2/api/RecordingApi.js @@ -5,7 +5,7 @@ class RecordingApi { /** * Recording service. * @module purecloud-platform-client-v2/api/RecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ResponseManagementApi.js b/build/src/purecloud-platform-client-v2/api/ResponseManagementApi.js index f571329b..7382c6f5 100644 --- a/build/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +++ b/build/src/purecloud-platform-client-v2/api/ResponseManagementApi.js @@ -5,7 +5,7 @@ class ResponseManagementApi { /** * ResponseManagement service. * @module purecloud-platform-client-v2/api/ResponseManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/RoutingApi.js b/build/src/purecloud-platform-client-v2/api/RoutingApi.js index f46719f1..1c28c77a 100644 --- a/build/src/purecloud-platform-client-v2/api/RoutingApi.js +++ b/build/src/purecloud-platform-client-v2/api/RoutingApi.js @@ -5,7 +5,7 @@ class RoutingApi { /** * Routing service. * @module purecloud-platform-client-v2/api/RoutingApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -466,7 +466,6 @@ class RoutingApi { * @param {String} labelId Utilization Label ID * @param {Object} opts Optional parameters * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false) - * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ deleteRoutingUtilizationLabel(labelId, opts) { opts = opts || {}; @@ -1985,7 +1984,6 @@ class RoutingApi { * Get details about this utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabel(labelId) { // verify the required parameter 'labelId' is set @@ -2011,7 +2009,6 @@ class RoutingApi { * Get list of agent ids associated with a utilization label * * @param {String} labelId Utilization Label ID - * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabelAgents(labelId) { // verify the required parameter 'labelId' is set @@ -2041,7 +2038,6 @@ class RoutingApi { * @param {Number} opts.pageNumber Page number (default to 1) * @param {Object} opts.sortOrder Sort order by name (default to ascending) * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' - * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ getRoutingUtilizationLabels(opts) { opts = opts || {}; @@ -3464,7 +3460,6 @@ class RoutingApi { * Create a utilization label * * @param {Object} body UtilizationLabel - * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ postRoutingUtilizationLabels(body) { // verify the required parameter 'body' is set @@ -3857,7 +3852,6 @@ class RoutingApi { * * @param {String} labelId Utilization Label ID * @param {Object} body UtilizationLabel - * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice */ putRoutingUtilizationLabel(labelId, body) { // verify the required parameter 'labelId' is set diff --git a/build/src/purecloud-platform-client-v2/api/SCIMApi.js b/build/src/purecloud-platform-client-v2/api/SCIMApi.js index 71a399be..1511bc90 100644 --- a/build/src/purecloud-platform-client-v2/api/SCIMApi.js +++ b/build/src/purecloud-platform-client-v2/api/SCIMApi.js @@ -5,7 +5,7 @@ class SCIMApi { /** * SCIM service. * @module purecloud-platform-client-v2/api/SCIMApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js b/build/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js index b507d86e..a67e9b35 100644 --- a/build/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +++ b/build/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js @@ -5,7 +5,7 @@ class ScreenRecordingApi { /** * ScreenRecording service. * @module purecloud-platform-client-v2/api/ScreenRecordingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/ScriptsApi.js b/build/src/purecloud-platform-client-v2/api/ScriptsApi.js index 83cb3e55..fdff6170 100644 --- a/build/src/purecloud-platform-client-v2/api/ScriptsApi.js +++ b/build/src/purecloud-platform-client-v2/api/ScriptsApi.js @@ -5,7 +5,7 @@ class ScriptsApi { /** * Scripts service. * @module purecloud-platform-client-v2/api/ScriptsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/SearchApi.js b/build/src/purecloud-platform-client-v2/api/SearchApi.js index 3f96d3d0..81dc0e66 100644 --- a/build/src/purecloud-platform-client-v2/api/SearchApi.js +++ b/build/src/purecloud-platform-client-v2/api/SearchApi.js @@ -5,7 +5,7 @@ class SearchApi { /** * Search service. * @module purecloud-platform-client-v2/api/SearchApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/SettingsApi.js b/build/src/purecloud-platform-client-v2/api/SettingsApi.js index 9779a4b9..6a76ac47 100644 --- a/build/src/purecloud-platform-client-v2/api/SettingsApi.js +++ b/build/src/purecloud-platform-client-v2/api/SettingsApi.js @@ -5,7 +5,7 @@ class SettingsApi { /** * Settings service. * @module purecloud-platform-client-v2/api/SettingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js b/build/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js index 58677f2c..fbbcd556 100644 --- a/build/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +++ b/build/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js @@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi { /** * SpeechTextAnalytics service. * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi - * @version 194.0.0 + * @version 195.0.0 */ /** @@ -20,6 +20,31 @@ class SpeechTextAnalyticsApi { } + /** + * Delete a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + */ + deleteSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling deleteSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'DELETE', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Delete a Speech and Text Analytics DictionaryFeedback by Id * @@ -144,6 +169,60 @@ class SpeechTextAnalyticsApi { ); } + /** + * Get the list of Speech and Text Analytics categories + * + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + * @param {String} opts.name The category name filter applied to the listing + * @param {Object} opts.sortOrder The sort order for the listing (default to asc) + * @param {Object} opts.sortBy The field to sort by for the listing (default to name) + * @param {Array.} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. + */ + getSpeechandtextanalyticsCategories(opts) { + opts = opts || {}; + + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'GET', + { }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi') }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + + /** + * Get a Speech and Text Analytics Category by ID + * + * @param {String} categoryId The id of the category + */ + getSpeechandtextanalyticsCategory(categoryId) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling getSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'GET', + { 'categoryId': categoryId }, + { }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get Speech and Text Analytics for a specific conversation * @@ -169,6 +248,36 @@ class SpeechTextAnalyticsApi { ); } + /** + * Get the list of detected Speech and Text Analytics categories of conversation + * + * @param {String} conversationId The id of the conversation + * @param {Object} opts Optional parameters + * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 50. (default to 25) + * @param {Number} opts.pageNumber The page number for the listing (default to 1) + */ + getSpeechandtextanalyticsConversationCategories(conversationId, opts) { + opts = opts || {}; + + // verify the required parameter 'conversationId' is set + if (conversationId === undefined || conversationId === null) { + throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/conversations/{conversationId}/categories', + 'GET', + { 'conversationId': conversationId }, + { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] }, + { }, + { }, + null, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Get the pre-signed S3 URL for the transcript of a specific communication of a conversation * @@ -739,6 +848,31 @@ class SpeechTextAnalyticsApi { ); } + /** + * Create new Speech and Text Analytics category + * + * @param {Object} body The category to create + */ + postSpeechandtextanalyticsCategories(body) { + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsCategories'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories', + 'POST', + { }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Create a Speech and Text Analytics DictionaryFeedback * @@ -939,6 +1073,36 @@ class SpeechTextAnalyticsApi { ); } + /** + * Update a Speech and Text Analytics category by ID + * + * @param {String} categoryId The id of the category + * @param {Object} body The updated category + */ + putSpeechandtextanalyticsCategory(categoryId, body) { + // verify the required parameter 'categoryId' is set + if (categoryId === undefined || categoryId === null) { + throw 'Missing the required parameter "categoryId" when calling putSpeechandtextanalyticsCategory'; + } + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsCategory'; + } + + return this.apiClient.callApi( + '/api/v2/speechandtextanalytics/categories/{categoryId}', + 'PUT', + { 'categoryId': categoryId }, + { }, + { }, + { }, + body, + ['PureCloud OAuth'], + ['application/json'], + ['application/json'] + ); + } + /** * Update existing Speech and Text Analytics dictionary feedback by id * diff --git a/build/src/purecloud-platform-client-v2/api/StationsApi.js b/build/src/purecloud-platform-client-v2/api/StationsApi.js index f10e4726..379353f8 100644 --- a/build/src/purecloud-platform-client-v2/api/StationsApi.js +++ b/build/src/purecloud-platform-client-v2/api/StationsApi.js @@ -5,7 +5,7 @@ class StationsApi { /** * Stations service. * @module purecloud-platform-client-v2/api/StationsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/SuggestApi.js b/build/src/purecloud-platform-client-v2/api/SuggestApi.js index e4b5e05e..bbc16528 100644 --- a/build/src/purecloud-platform-client-v2/api/SuggestApi.js +++ b/build/src/purecloud-platform-client-v2/api/SuggestApi.js @@ -5,7 +5,7 @@ class SuggestApi { /** * Suggest service. * @module purecloud-platform-client-v2/api/SuggestApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TaskManagementApi.js b/build/src/purecloud-platform-client-v2/api/TaskManagementApi.js index 48b18795..34a6657a 100644 --- a/build/src/purecloud-platform-client-v2/api/TaskManagementApi.js +++ b/build/src/purecloud-platform-client-v2/api/TaskManagementApi.js @@ -5,7 +5,7 @@ class TaskManagementApi { /** * TaskManagement service. * @module purecloud-platform-client-v2/api/TaskManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TeamsApi.js b/build/src/purecloud-platform-client-v2/api/TeamsApi.js index 54e8b4de..82d52aeb 100644 --- a/build/src/purecloud-platform-client-v2/api/TeamsApi.js +++ b/build/src/purecloud-platform-client-v2/api/TeamsApi.js @@ -5,7 +5,7 @@ class TeamsApi { /** * Teams service. * @module purecloud-platform-client-v2/api/TeamsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TelephonyApi.js b/build/src/purecloud-platform-client-v2/api/TelephonyApi.js index 3167a7ce..412519e5 100644 --- a/build/src/purecloud-platform-client-v2/api/TelephonyApi.js +++ b/build/src/purecloud-platform-client-v2/api/TelephonyApi.js @@ -5,7 +5,7 @@ class TelephonyApi { /** * Telephony service. * @module purecloud-platform-client-v2/api/TelephonyApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js b/build/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js index e40a0376..b0f5122a 100644 --- a/build/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +++ b/build/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js @@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi { /** * TelephonyProvidersEdge service. * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TextbotsApi.js b/build/src/purecloud-platform-client-v2/api/TextbotsApi.js index ec43dca1..2509d7a0 100644 --- a/build/src/purecloud-platform-client-v2/api/TextbotsApi.js +++ b/build/src/purecloud-platform-client-v2/api/TextbotsApi.js @@ -5,7 +5,7 @@ class TextbotsApi { /** * Textbots service. * @module purecloud-platform-client-v2/api/TextbotsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/TokensApi.js b/build/src/purecloud-platform-client-v2/api/TokensApi.js index d6098cc0..69254f07 100644 --- a/build/src/purecloud-platform-client-v2/api/TokensApi.js +++ b/build/src/purecloud-platform-client-v2/api/TokensApi.js @@ -5,7 +5,7 @@ class TokensApi { /** * Tokens service. * @module purecloud-platform-client-v2/api/TokensApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/UploadsApi.js b/build/src/purecloud-platform-client-v2/api/UploadsApi.js index 43c61e11..b12cd3f8 100644 --- a/build/src/purecloud-platform-client-v2/api/UploadsApi.js +++ b/build/src/purecloud-platform-client-v2/api/UploadsApi.js @@ -5,7 +5,7 @@ class UploadsApi { /** * Uploads service. * @module purecloud-platform-client-v2/api/UploadsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/UsageApi.js b/build/src/purecloud-platform-client-v2/api/UsageApi.js index ed118620..938e643e 100644 --- a/build/src/purecloud-platform-client-v2/api/UsageApi.js +++ b/build/src/purecloud-platform-client-v2/api/UsageApi.js @@ -5,7 +5,7 @@ class UsageApi { /** * Usage service. * @module purecloud-platform-client-v2/api/UsageApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/UserRecordingsApi.js b/build/src/purecloud-platform-client-v2/api/UserRecordingsApi.js index edb56640..73a755c6 100644 --- a/build/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +++ b/build/src/purecloud-platform-client-v2/api/UserRecordingsApi.js @@ -5,7 +5,7 @@ class UserRecordingsApi { /** * UserRecordings service. * @module purecloud-platform-client-v2/api/UserRecordingsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/UsersApi.js b/build/src/purecloud-platform-client-v2/api/UsersApi.js index 915b2615..32f44e80 100644 --- a/build/src/purecloud-platform-client-v2/api/UsersApi.js +++ b/build/src/purecloud-platform-client-v2/api/UsersApi.js @@ -5,7 +5,7 @@ class UsersApi { /** * Users service. * @module purecloud-platform-client-v2/api/UsersApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/UtilitiesApi.js b/build/src/purecloud-platform-client-v2/api/UtilitiesApi.js index db3ad96c..f869290b 100644 --- a/build/src/purecloud-platform-client-v2/api/UtilitiesApi.js +++ b/build/src/purecloud-platform-client-v2/api/UtilitiesApi.js @@ -5,7 +5,7 @@ class UtilitiesApi { /** * Utilities service. * @module purecloud-platform-client-v2/api/UtilitiesApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/VoicemailApi.js b/build/src/purecloud-platform-client-v2/api/VoicemailApi.js index 71ffad5b..0e72c3ba 100644 --- a/build/src/purecloud-platform-client-v2/api/VoicemailApi.js +++ b/build/src/purecloud-platform-client-v2/api/VoicemailApi.js @@ -5,7 +5,7 @@ class VoicemailApi { /** * Voicemail service. * @module purecloud-platform-client-v2/api/VoicemailApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/WebChatApi.js b/build/src/purecloud-platform-client-v2/api/WebChatApi.js index a31c5f10..a2c2812b 100644 --- a/build/src/purecloud-platform-client-v2/api/WebChatApi.js +++ b/build/src/purecloud-platform-client-v2/api/WebChatApi.js @@ -5,7 +5,7 @@ class WebChatApi { /** * WebChat service. * @module purecloud-platform-client-v2/api/WebChatApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js b/build/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js index afe5ba27..247bcb9a 100644 --- a/build/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +++ b/build/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js @@ -5,7 +5,7 @@ class WebDeploymentsApi { /** * WebDeployments service. * @module purecloud-platform-client-v2/api/WebDeploymentsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/WebMessagingApi.js b/build/src/purecloud-platform-client-v2/api/WebMessagingApi.js index 9530419e..3f92d2c1 100644 --- a/build/src/purecloud-platform-client-v2/api/WebMessagingApi.js +++ b/build/src/purecloud-platform-client-v2/api/WebMessagingApi.js @@ -5,7 +5,7 @@ class WebMessagingApi { /** * WebMessaging service. * @module purecloud-platform-client-v2/api/WebMessagingApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/WidgetsApi.js b/build/src/purecloud-platform-client-v2/api/WidgetsApi.js index c4097cbc..c0960fd8 100644 --- a/build/src/purecloud-platform-client-v2/api/WidgetsApi.js +++ b/build/src/purecloud-platform-client-v2/api/WidgetsApi.js @@ -5,7 +5,7 @@ class WidgetsApi { /** * Widgets service. * @module purecloud-platform-client-v2/api/WidgetsApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js b/build/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js index 126807ff..4bae9ba7 100644 --- a/build/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +++ b/build/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js @@ -5,7 +5,7 @@ class WorkforceManagementApi { /** * WorkforceManagement service. * @module purecloud-platform-client-v2/api/WorkforceManagementApi - * @version 194.0.0 + * @version 195.0.0 */ /** diff --git a/build/src/purecloud-platform-client-v2/index.js b/build/src/purecloud-platform-client-v2/index.js index 86958732..193c735b 100644 --- a/build/src/purecloud-platform-client-v2/index.js +++ b/build/src/purecloud-platform-client-v2/index.js @@ -107,7 +107,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js'; * *

* @module purecloud-platform-client-v2/index - * @version 194.0.0 + * @version 195.0.0 */ class platformClient { constructor() { diff --git a/releaseNotes.md b/releaseNotes.md index 3e5be0ee..5a276863 100644 --- a/releaseNotes.md +++ b/releaseNotes.md @@ -1,241 +1,520 @@ -Platform API version: 8117 +Platform API version: 8165 -# Major Changes (19 changes) +# Major Changes (10 changes) -**/api/v2/conversations/messaging/integrations/line/{integrationId}** (1 change) +**/api/v2/conversations/messaging/stickers/{messengerType}** (1 change) -* Path /api/v2/conversations/messaging/integrations/line/{integrationId} was removed +* Path /api/v2/conversations/messaging/stickers/{messengerType} was removed -**/api/v2/conversations/messaging/integrations/line** (1 change) +**GET /api/v2/journey/views** (1 change) -* Path /api/v2/conversations/messaging/integrations/line was removed +* Response 200 type was changed from AddressableEntityListing to JourneyViewListing -**/api/v2/conversations/messaging/integrations/twitter/{integrationId}** (1 change) +**GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations** (1 change) -* Path /api/v2/conversations/messaging/integrations/twitter/{integrationId} was removed +* Parameter sourceId was added -**/api/v2/conversations/messaging/integrations/twitter** (1 change) +**MessagingSticker** (1 change) -* Path /api/v2/conversations/messaging/integrations/twitter was removed +* Model MessagingSticker was removed -**GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships** (1 change) +**MessagingStickerEntityListing** (1 change) -* Parameter expand was changed from string to array +* Model MessagingStickerEntityListing was removed -**GET /api/v2/externalcontacts/organizations/{externalOrganizationId}** (1 change) +**AddressableEntityListing** (1 change) -* Parameter expand was changed from string to array +* Model AddressableEntityListing was removed -**GET /api/v2/externalcontacts/relationships/{relationshipId}** (1 change) +**FieldConfig** (1 change) -* Parameter expand was changed from string to array +* Enum value externalContact was removed from property entityType -**ConditionalGroupRoutingCondition** (1 change) +**KeyPerformanceIndicator** (1 change) -* Model ConditionalGroupRoutingCondition was removed +* Enum value NumberOfTransfers was removed from property kpiType -**LineIntegration** (1 change) +**EngineIntegration** (1 change) -* Model LineIntegration was removed +* Property name was removed -**LineIntegrationRequest** (1 change) +**FieldConfigs** (1 change) -* Model LineIntegrationRequest was removed +* Property externalContact was removed -**LineIntegrationEntityListing** (1 change) -* Model LineIntegrationEntityListing was removed +# Minor Changes (178 changes) -**TwitterIntegration** (1 change) +**/api/v2/analytics/reporting/settings/dashboards/query** (1 change) -* Model TwitterIntegration was removed +* Operation get was added. Summary: Get list of dashboard configurations -**TwitterIntegrationRequest** (1 change) +**/api/v2/conversations/emails/{conversationId}/reconnect** (2 changes) -* Model TwitterIntegrationRequest was removed +* Path was added +* Operation POST was added -**TwitterIntegrationEntityListing** (1 change) +**/api/v2/speechandtextanalytics/categories** (3 changes) -* Model TwitterIntegrationEntityListing was removed +* Path was added +* Operation GET was added +* Operation POST was added -**GenericActionEvent** (1 change) +**/api/v2/speechandtextanalytics/categories/{categoryId}** (4 changes) -* Model GenericActionEvent was removed +* Path was added +* Operation GET was added +* Operation PUT was added +* Operation DELETE was added -**GenericEventAction** (1 change) +**/api/v2/speechandtextanalytics/conversations/{conversationId}/categories** (2 changes) -* Model GenericEventAction was removed +* Path was added +* Operation GET was added -**PhoneStatus** (1 change) +**GET /api/v2/speechandtextanalytics/topics/general/status** (1 change) -* Property name was removed +* Response 405 was added -**WfmUserEntityListing** (1 change) +**/api/v2/learning/assignments/{assignmentId}/steps/{stepId}** (3 changes) -* Property entities was changed from User[] to UserReference[] +* Path was added +* Operation GET was added +* Operation PATCH was added -**Event** (1 change) +**/api/v2/learning/modules/{moduleId}/preview** (3 changes) -* Property genericActionEvent was removed +* Path was added +* Operation GET was added +* Operation PUT was added +**/api/v2/learning/scorm/{scormId}** (2 changes) -# Minor Changes (45 changes) +* Path was added +* Operation GET was added -**/api/v2/audits/query/realtime/related** (2 changes) +**/api/v2/learning/scorm** (2 changes) * Path was added * Operation POST was added -**/api/v2/outbound/campaigns/{campaignId}/linedistribution** (2 changes) +**POST /api/v2/taskmanagement/workitems/{workitemId}/terminate** (1 change) + +* Response 409 was added + +**/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}** (2 changes) * Path was added * Operation GET was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results** (2 changes) * Path was added -* Operation POST was added +* Operation GET was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/query** (2 changes) * Path was added * Operation POST was added -**/api/v2/outbound/contactlists/{contactListId}/contacts/search** (2 changes) +**/api/v2/analytics/agentcopilots/aggregates/jobs** (2 changes) * Path was added * Operation POST was added -**ConversationAggregateQueryPredicate** (1 change) +**BotAggregationQuery** (2 changes) + +* Enum value oBotSessionCollection was added to property metrics +* Enum value oBotSessionCollectionSelfServed was added to property metrics + +**BotAggregationView** (2 changes) + +* Enum value oBotSessionCollection was added to property target +* Enum value oBotSessionCollectionSelfServed was added to property target + +**AnalyticsSession** (2 changes) + +* Optional property detectedSpeechEnd was added +* Optional property detectedSpeechStart was added + +**SegmentDetailQueryPredicate** (2 changes) + +* Enum value detectedSpeechEnd was added to property dimension +* Enum value detectedSpeechStart was added to property dimension + +**DashboardConfiguration** (2 changes) + +* Optional property shared was added +* Optional property dashboardsSharedWith was added + +**DashboardsSharedWith** (1 change) + +* Model was added + +**ViewFilter** (15 changes) + +* Optional property agentTalkDurationMilliseconds was added +* Optional property customerTalkDurationMilliseconds was added +* Optional property overtalkDurationMilliseconds was added +* Optional property silenceDurationMilliseconds was added +* Optional property acdDurationMilliseconds was added +* Optional property ivrDurationMilliseconds was added +* Optional property otherDurationMilliseconds was added +* Optional property agentTalkPercentage was added +* Optional property customerTalkPercentage was added +* Optional property overtalkPercentage was added +* Optional property silencePercentage was added +* Optional property acdPercentage was added +* Optional property ivrPercentage was added +* Optional property otherPercentage was added +* Optional property overtalkInstances was added + +**KnowledgeBaseReference** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**Limit** (1 change) + +* Enum value social.media was added to property namespace + +**ContactIdentifier** (1 change) + +* Enum value ExternalId was added to property type + +**ConversationMessageMetadataEvent** (1 change) + +* Enum value Video was added to property eventType + +**CreateCallRequest** (1 change) + +* Optional property attributes was added + +**ConversationEventVideo** (1 change) + +* Model was added + +**ConversationMessageEvent** (2 changes) + +* Enum value Video was added to property eventType +* Optional property video was added + +**KnowledgeBase** (5 changes) + +* Enum value hi-IN was added to property coreLanguage +* Enum value th-TH was added to property coreLanguage +* Enum value hu-HU was added to property coreLanguage +* Enum value vi-VN was added to property coreLanguage +* Enum value uk-UA was added to property coreLanguage + +**KnowledgeCategory** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeSearchDocumentV1** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeExtendedCategory** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeImport** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeDocument** (5 changes) + +* Enum value hi-IN was added to property languageCode +* Enum value th-TH was added to property languageCode +* Enum value hu-HU was added to property languageCode +* Enum value vi-VN was added to property languageCode +* Enum value uk-UA was added to property languageCode + +**KnowledgeBaseCreateRequest** (5 changes) + +* Enum value hi-IN was added to property coreLanguage +* Enum value th-TH was added to property coreLanguage +* Enum value hu-HU was added to property coreLanguage +* Enum value vi-VN was added to property coreLanguage +* Enum value uk-UA was added to property coreLanguage + +**KnowledgeOperationSource** (1 change) + +* Model was added + +**KnowledgeDocumentResponse** (2 changes) + +* Optional property source was added +* Optional property readonly was added + +**KnowledgeExportJobDocumentsFilter** (1 change) + +* Optional property sourceId was added + +**KnowledgeExportJobResponse** (1 change) + +* Optional property source was added -* Enum value videoPresent was added to property dimension +**KnowledgeExportJobRequest** (1 change) -**ConversationAggregationQuery** (1 change) +* Optional property sourceId was added -* Enum value videoPresent was added to property groupBy +**KnowledgeSearchDocumentResponse** (2 changes) -**FlowAggregateQueryPredicate** (1 change) +* Optional property source was added +* Optional property readonly was added -* Enum value videoPresent was added to property dimension +**ApprovalNamespace** (1 change) -**FlowAggregationQuery** (1 change) +* Enum value social.media was added to property namespace -* Enum value videoPresent was added to property groupBy +**LimitChangeRequestDetails** (1 change) -**ReportingTurn** (1 change) +* Enum value social.media was added to property namespace -* Optional property knowledgeBaseEvents was added +**StatusChange** (1 change) -**ReportingTurnKnowledgeEvents** (1 change) +* Enum value social.media was added to property namespace + +**RecordingMessagingMessage** (4 changes) + +* Optional property purpose was added +* Optional property participantId was added +* Optional property queue was added +* Optional property workflow was added + +**UserQueue** (1 change) + +* id is no longer readonly + +**UtilizationResponse** (1 change) + +* Optional property labelUtilizations was added + +**UtilizationRequest** (1 change) + +* Optional property labelUtilizations was added + +**AgentMaxUtilizationResponse** (1 change) + +* Optional property labelUtilizations was added + +**CategoriesEntityListing** (1 change) * Model was added -**ReportingTurnKnowledgeFeedbackEvent** (1 change) +**InfixOperator** (1 change) * Model was added -**ReportingTurnKnowledgeSearchEvent** (1 change) +**Operand** (1 change) * Model was added -**ConversationProperties** (1 change) +**OperandPosition** (1 change) -* Optional property isScreenMonitored was added +* Model was added -**ViewFilter** (2 changes) +**OperatorPosition** (1 change) -* Optional property isScreenRecorded was added -* Optional property screenMonitorUserIds was added +* Model was added -**AuditRealtimeRelatedResultsResponse** (1 change) +**StaCategory** (1 change) * Model was added -**AuditRealtimeRelatedRequest** (1 change) +**Term** (1 change) * Model was added -**AiAnswer** (1 change) +**CategoryRequest** (1 change) * Model was added -**AiScoring** (1 change) +**EngineIntegration** (1 change) + +* id is no longer readonly + +**ConversationCategoriesEntityListing** (1 change) * Model was added -**Campaign** (1 change) +**ConversationCategory** (1 change) + +* Model was added -* Optional property dynamicLineBalancingSettings was added +**VoicemailSearchCriteria** (1 change) -**CampaignOutboundLinesAllocation** (1 change) +* Enum value DATE_RANGE was added to property type + +**CobrowseSettings** (1 change) + +* Optional property pauseCriteria was added + +**LearningAssignment** (5 changes) + +* Optional property assessmentPercentageScore was added +* Optional property assessmentCompletionPercentage was added +* Optional property completionPercentage was added +* Optional property steps was added +* Optional property nextStep was added + +**LearningModule** (2 changes) + +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added + +**ReviewAssessmentResults** (2 changes) + +* Optional property byAssignees was added +* Optional property byViewers was added + +**LearningModulePreviewGetResponse** (1 change) * Model was added -**CampaignOutboundLinesDistribution** (1 change) +**LearningModulePreviewGetResponseAssignment** (1 change) * Model was added -**CampaignOutboundLinesReservation** (1 change) +**LearningModulePreviewGetResponseStep** (1 change) * Model was added -**CampaignStats** (1 change) +**LearningModulePreviewGetScoStructure** (1 change) -* Optional property linesUtilization was added +* Model was added + +**LearningModuleRequest** (2 changes) + +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added -**ContactsBulkOperationJob** (1 change) +**LearningModulePreviewUpdateResponse** (1 change) * Model was added -**ContactBulkEditRequest** (1 change) +**LearningModulePreviewUpdateResponseAssignment** (1 change) * Model was added -**ContactBulkSearchParameters** (1 change) +**LearningModulePreviewUpdateResponseCurrentStep** (1 change) * Model was added -**ContactListingResponse** (1 change) +**LearningModulePreviewUpdateScoStructure** (1 change) * Model was added -**ContactListingRequest** (1 change) +**LearningModulePreviewUpdateStep** (1 change) * Model was added -**EventMessage** (2 changes) +**LearningModulePreviewUpdateRequest** (1 change) -* Enum value ACTION_EXECUTION_FAILED was added to property code -* Enum value ACTION_EXECUTION_FAILED_INVALID_PARAMETER was added to property code +* Model was added -**FlowPathsFlowDetails** (3 changes) +**LearningModulePreviewUpdateRequestCurrentStep** (1 change) -* Enum value InboundShortMessage was added to property type -* Enum value InboundEmail was added to property type -* Enum value OutboundCall was added to property type +* Model was added -**IpAddressRange** (1 change) +**AssignedLearningModule** (2 changes) -* Enum value open-messaging was added to property service +* Optional property enforceContentOrder was added +* Optional property reviewAssessmentResults was added -**Library** (1 change) +**LearningScormResponse** (1 change) -* version is no longer readonly +* Model was added -**PhoneStatus** (1 change) +**LearningScormUploadResponse** (1 change) -* id is no longer readonly +* Model was added + +**LearningScormUploadRequest** (1 change) + +* Model was added + +**AgentCopilotAggregateDataContainer** (1 change) + +* Model was added + +**AgentCopilotAsyncAggregateQueryResponse** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryResponse** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryClause** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryFilter** (1 change) + +* Model was added + +**AgentCopilotAggregateQueryPredicate** (1 change) + +* Model was added + +**AgentCopilotAggregationQuery** (1 change) + +* Model was added + +**AgentCopilotAggregationView** (1 change) + +* Model was added + +**AgentCopilotAsyncAggregationQuery** (1 change) + +* Model was added + +**BotAsyncAggregationQuery** (2 changes) + +* Enum value oBotSessionCollection was added to property metrics +* Enum value oBotSessionCollectionSelfServed was added to property metrics + +**JourneyViewListing** (1 change) + +* Model was added + +**OperationResponse** (1 change) + +* Optional property source was added -**ConversationAsyncAggregationQuery** (1 change) +**WorktypeDelta** (1 change) -* Enum value videoPresent was added to property groupBy +* Optional property serviceLevelTarget was added -**FlowAsyncAggregationQuery** (1 change) -* Enum value videoPresent was added to property groupBy +# Point Changes (2 changes) +**POST /api/v2/analytics/ratelimits/aggregates/query** (2 changes) -# Point Changes (0 changes) +* Description was changed +* Summary was changed diff --git a/swagger.json b/swagger.json index 5a91bc70..7ef530a3 100644 --- a/swagger.json +++ b/swagger.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://help.mypurecloud.com/articles/terms-and-conditions/","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.genesys.cloud","email":"DeveloperEvangelists@genesys.com"},"license":{"name":"UNLICENSED","url":"https://help.mypurecloud.com/articles/terms-and-conditions/"}},"host":"api.mypurecloud.com","tags":[{"name":"Events","description":"Events","externalDocs":{"description":"Events Documentation","url":"https://developer.genesys.cloud/api/rest/v2/events/"}},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"OAuth","description":"OAuth clients, providers","externalDocs":{"description":"OAuth Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/oauth/"}},{"name":"Objects","description":"Access-controlled objects in the platform","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"name":"Alerting","description":"Rules and alerts","externalDocs":{"description":"Alerting Documentation","url":"https://developer.genesys.cloud/notificationsalerts/alerting/alerting-apis"}},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"Analytics Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis"}},{"name":"Architect","description":"Flows, Prompts, IVR schedules, Dependency Tracking","externalDocs":{"description":"Architect Documentation","url":"https://developer.genesys.cloud/routing/architect/"}},{"name":"Audit","description":"","externalDocs":{"description":"Audit Documentation","url":"https://developer.genesys.cloud/platform/audit/"}},{"name":"Billing","description":"","externalDocs":{"description":"billing Documentation","url":"https://developer.genesys.cloud/billing/"}},{"name":"Callbacks","description":""},{"name":"Calls","description":""},{"name":"Carrier Services","description":""},{"name":"Chat","description":""},{"name":"Coaching","description":"Schedule and manage coaching appointments","externalDocs":{"description":"Coaching","url":"https://developer.genesys.cloud/routing/conversations/coaching-apis"}},{"name":"Compliance","description":""},{"name":"Configuration","description":"","externalDocs":{"description":"Configuration Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Content Management","description":"","externalDocs":{"description":"Content Management Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/contentmanagement/contentmanagement-apis"}},{"name":"Conversations","description":"","externalDocs":{"description":"Conversations Documentation","url":"https://developer.genesys.cloud/routing/conversations/conversations-apis"}},{"name":"Data Extensions","description":"Data extensions","externalDocs":{"description":"Data Extensions","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Downloads","description":"Download file","externalDocs":{"description":"Downloads Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Emails","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships","externalDocs":{"description":"External Contacts","url":"https://developer.genesys.cloud/commdigital/externalcontacts/externalcontacts-apis"}},{"name":"Fax","description":"","externalDocs":{"description":"Fax Documentation","url":"https://developer.genesys.cloud/commdigital/fax/"}},{"name":"Flows","description":"IVR Flows","externalDocs":{"description":"Flow Aggregates Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/analytics/aggregate/flow-query"}},{"name":"Gamification","description":"Gamification, Scorecard, and leaderboard","externalDocs":{"description":"Gamification Documentation","url":"https://developer.genesys.cloud/useragentman/gamification/"}},{"name":"General Data Protection Regulation","description":"Working with General Data Protection Regulation (GDPR) requests","externalDocs":{"description":"GDPR Documentation","url":"https://developer.genesys.cloud/gdprprivacy/"}},{"name":"Geolocation","description":"","externalDocs":{"description":"Geolocation Documentation","url":"https://developer.genesys.cloud/platform/geolocation-apis"}},{"name":"Greetings","description":"","externalDocs":{"description":"Greetings Documentation","url":"https://developer.genesys.cloud/commdigital/greetings/"}},{"name":"Groups","description":"Groups, members","externalDocs":{"description":"Groups Documentation","url":"https://developer.genesys.cloud/useragentman/groups/"}},{"name":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/identityprovider/"}},{"name":"Infrastructure as Code","description":"Accelerated infrastructure configuration via reusable modules","externalDocs":{"description":"Infrastructure as Code Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Integrations","description":"","externalDocs":{"description":"Integrations Documentation","url":"https://developer.genesys.cloud/platform/integrations/"}},{"name":"Journey","description":"Predictive Engagement, Customer Journey","externalDocs":{"description":"Journey documentation","url":"https://developer.genesys.cloud/commdigital/digital/webmessaging/journey/journey-apis"}},{"name":"Languages","description":"Available languages","externalDocs":{"description":"Languages Documentation","url":"https://developer.genesys.cloud/organization/languages-apis"}},{"name":"Knowledge","description":"Knowledge administration and search"},{"name":"Language Understanding","description":"Language Understanding","externalDocs":{"description":"Language Understanding documentation","url":"https://developer.genesys.cloud/organization/languageunderstanding/languageunderstanding-apis"}},{"name":"Learning","description":"Manage learning modules"},{"name":"Licensing","description":""},{"name":"License","description":"Per-user platform license assignments","externalDocs":{"description":"License Documentation","url":"https://developer.genesys.cloud/organization/license-apis"}},{"name":"Locations","description":"Physical locations","externalDocs":{"description":"Locations Documentation","url":"https://developer.genesys.cloud/telephony/locations-apis"}},{"name":"Log Capture","description":"Browser Log Capture"},{"name":"Messaging","description":"Messaging","externalDocs":{"description":"Messaging Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Mobile Devices","description":"Devices","externalDocs":{"description":"Devices Documentation","url":"https://developer.genesys.cloud/organization/mobiledevices-apis"}},{"name":"Notifications","description":"Channels, subscriptions, topics, mobile push registration","externalDocs":{"description":"Notifications Documentation","url":"https://developer.genesys.cloud/notificationsalerts/notifications/notifications-apis"}},{"name":"Operational Events","description":"Operational events"},{"name":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.genesys.cloud/organization/organization/"}},{"name":"Organization Authorization","description":"Organization Authorization","externalDocs":{"description":"Organization Authorization Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/organizationauthorization-apis"}},{"name":"Outbound","description":"","externalDocs":{"description":"Outbound Documentation","url":"https://developer.genesys.cloud/routing/outbound/"}},{"name":"Presence","description":"User and organization presences","externalDocs":{"description":"Presence Documentation","url":"https://developer.genesys.cloud/useragentman/presence/"}},{"name":"Process Automation","description":"Work items, flows, triggers"},{"name":"Quality","description":"Evaluations, calibrations","externalDocs":{"description":"Quality Management Documentation","url":"https://developer.genesys.cloud/useragentman/quality/"}},{"name":"Recording","description":"Recordings, policies, annotations, orphans","externalDocs":{"description":"Recording Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/recording/"}},{"name":"Response Management","description":"Responses, library, Response Assets, query","externalDocs":{"description":"Response Management Documentation","url":"https://developer.genesys.cloud/organization/responsemanagement-apis"}},{"name":"Routing","description":"Queues, wrapup codes, skills, email & sms config, predictive routing","externalDocs":{"description":"Routing Documentation","url":"https://developer.genesys.cloud/routing/routing/"}},{"name":"SCIM","description":"System for Cross-domain Identity Management","externalDocs":{"description":"System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements","url":"https://developer.genesys.cloud/useragentman/scim/scim-apis"}},{"name":"Screen Recording","description":"Screen recording with background assistant"},{"name":"Scripts","description":"Agent-facing scripts for interactions","externalDocs":{"description":"Scripts Documentation","url":"https://developer.genesys.cloud/routing/scripts/"}},{"name":"Search","description":"Search aggregate, users, groups","externalDocs":{"description":"Search Documentation","url":"https://developer.genesys.cloud/organization/search/"}},{"name":"Settings","description":"Persist settings"},{"name":"Socialize","description":"Gets, sets and updates entity data for the Socialize service"},{"name":"Speech & Text Analytics","description":""},{"name":"Stations","description":"Stations","externalDocs":{"description":"Stations Documentation","url":"https://developer.genesys.cloud/telephony/stations-apis"}},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Teams","description":"Teams, members","externalDocs":{"description":"Teams Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Telephony","description":"Telephony providers and configuration","externalDocs":{"description":"Telephony Documentation","url":"https://developer.genesys.cloud/telephony/telephony-apis"}},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.genesys.cloud/telephony/telephony-apis"}},{"name":"Textbots","description":"Chatbot Interactions"},{"name":"Uploads","description":"Presigned url generator for uploading files","externalDocs":{"description":"Upload Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/uploads/uploads-apis"}},{"name":"User Recordings","description":"Summary, media","externalDocs":{"description":"User Recordings Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/recording/userrecordings-apis"}},{"name":"Users","description":"Me, routing, roles","externalDocs":{"description":"Users Documentation","url":"https://developer.genesys.cloud/useragentman/users/"}},{"name":"Utilities","description":"","externalDocs":{"description":"Utilities Documentation","url":"https://developer.genesys.cloud/organization/utilities-apis"}},{"name":"Videos","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy","externalDocs":{"description":"Voicemail Documentation","url":"https://developer.genesys.cloud/commdigital/voicemail/"}},{"name":"WebChat","description":"WebChat deployments","externalDocs":{"description":"WebChat Deployment Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/webchat-apis"}},{"name":"WebMessaging","description":"Web messaging","externalDocs":{"description":"Web Messaging Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webmessaging/webmessaging-apis"}},{"name":"Widgets","description":"Widget deployments","externalDocs":{"description":"Widget Deployment Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/widgets-apis"}},{"name":"Usage","description":"View organizational level usage data","externalDocs":{"description":"Usage Documentation","url":"https://developer.genesys.cloud/platform/usage-apis"}},{"name":"Workforce Management","description":"Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration","externalDocs":{"description":"Workforce Management Documentation","url":"https://developer.genesys.cloud/useragentman/workforcemanagement/"}},{"name":"Web Deployments","description":"Web Deployments","externalDocs":{"description":"Web Deployments Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/webdeployments-apis"}},{"name":"Task Management","description":"Task Management"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v2/events/conversations":{"post":{"tags":["Events"],"summary":"Publish Conversation Batch Events","description":"","operationId":"postEventsConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchConversationEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conversation:inject"]},"x-purecloud-method-name":"postEventsConversations"}},"/api/v2/events/users/routingstatus":{"post":{"tags":["Events"],"summary":"Publish Agent Routing Status Batch Events","description":"","operationId":"postEventsUsersRoutingstatus","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserRoutingStatusEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:routingstatus:inject"]},"x-purecloud-method-name":"postEventsUsersRoutingstatus"}},"/api/v2/events/users/presence":{"post":{"tags":["Events"],"summary":"Publish User Presence Status Batch Events","description":"","operationId":"postEventsUsersPresence","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserPresenceEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:inject"]},"x-purecloud-method-name":"postEventsUsersPresence"}},"/api/v2/authorization/divisions/{divisionId}":{"get":{"tags":["Authorization","Objects"],"summary":"Returns an authorization division.","description":"","operationId":"getAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectCount","in":"query","description":"Get count of objects in this division, grouped by type","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivision"},"put":{"tags":["Authorization","Objects"],"summary":"Update a division.","description":"","operationId":"putAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated division data","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:edit"]},"x-purecloud-method-name":"putAuthorizationDivision"},"delete":{"tags":["Authorization","Objects"],"summary":"Delete a division.","description":"","operationId":"deleteAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Force delete this division as well as the grants and objects associated with it","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"precondition.failure":"One or more preconditions was not met.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:delete"]},"x-purecloud-method-name":"deleteAuthorizationDivision"}},"/api/v2/authorization/divisions/{divisionId}/restore":{"post":{"tags":["Authorization","Objects"],"summary":"Recreate a previously deleted division.","description":"","operationId":"postAuthorizationDivisionRestore","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recreated division data","required":false,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"Scope with that ID already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:add"]},"x-purecloud-method-name":"postAuthorizationDivisionRestore"}},"/api/v2/authorization/divisions":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve a list of all divisions defined for the organization","description":"Request specific divisions by id using a query param \"id\", e.g. \n?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","operationId":"getAuthorizationDivisions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"objectCount","in":"query","description":"Include the count of objects contained in the division","required":false,"type":"boolean","default":false},{"name":"id","in":"query","description":"Optionally request specific divisions by their IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisions"},"post":{"tags":["Authorization","Objects"],"summary":"Create a division.","description":"","operationId":"postAuthorizationDivisions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Division","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"A resource with that name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:division:add","authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationDivisions"}},"/api/v2/tokens/me":{"get":{"tags":["Tokens"],"summary":"Fetch information about the current token","description":"","operationId":"getTokensMe","produces":["application/json"],"parameters":[{"name":"preserveIdleTTL","in":"query","description":"preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getTokensMe"},"head":{"tags":["Tokens"],"summary":"Verify user token","description":"","operationId":"headTokensMe","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"headTokensMe"},"delete":{"tags":["Tokens"],"summary":"Delete auth token used to make the request.","description":"","operationId":"deleteTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"deleteTokensMe"}},"/api/v2/tokens/{userId}":{"delete":{"tags":["Tokens"],"summary":"Delete all auth tokens for the specified user.","description":"","operationId":"deleteToken","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Missing required division permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:token:delete"]},"x-purecloud-method-name":"deleteToken"}},"/api/v2/alerting/alerts/active":{"get":{"tags":["Alerting"],"summary":"Gets active alert count for a user","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to 'Count' and alertStatus to 'Active' in the request body.","operationId":"getAlertingAlertsActive","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActiveAlertCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingAlertsActive"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.","operationId":"getAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlert"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.","operationId":"putAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"InteractionStatsAlert","required":true,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.","operationId":"deleteAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsAlert"}},"/api/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query.","operationId":"getAlertingInteractionstatsAlerts","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlerts"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule","description":"Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.","operationId":"getAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRule"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.","operationId":"putAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsRule"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule","description":"Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.","operationId":"deleteAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsRule"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list","description":"Apps should migrate to use POST /api/v2/alerting/rules/query.","operationId":"getAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule","description":"Apps should migrate to use POST /api/v2/alerting/rules.","operationId":"postAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingInteractionstatsRules"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to 'Count' and viewStatus to 'Unread' in the request body.","operationId":"getAlertingInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingInteractionstatsAlertsUnread"}},"/api/v2/analytics/actions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for action aggregates","description":"","operationId":"postAnalyticsActionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ActionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"postAnalyticsActionsAggregatesQuery"}},"/api/v2/analytics/bots/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for bot aggregates","description":"","operationId":"postAnalyticsBotsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/BotAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"postAnalyticsBotsAggregatesQuery"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation aggregates","description":"","operationId":"postAnalyticsConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/activity/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation activity observations","description":"","operationId":"postAnalyticsConversationsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsConversationsActivityQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details","description":"","operationId":"postAnalyticsConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"payload.too.large":"The response payload was too large.","request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsQuery"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Get a conversation by id","description":"","operationId":"getAnalyticsConversationDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationDetails"}},"/api/v2/analytics/conversations/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Gets multiple conversations by id","description":"","operationId":"getAnalyticsConversationsDetails","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma-separated conversation ids","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Analytics","Conversations"],"summary":"Index conversation properties","description":"","operationId":"postAnalyticsConversationDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"202":{"description":"Accepted - Indexing properties","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationProperties:index"]},"x-purecloud-method-name":"postAnalyticsConversationDetailsProperties"}},"/api/v2/analytics/conversations/details/jobs":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details asynchronously","description":"","operationId":"postAnalyticsConversationsDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncConversationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsJobs"}},"/api/v2/analytics/conversations/details/jobs/{jobId}":{"get":{"tags":["Analytics","Conversations"],"summary":"Get status for async query for conversation details","description":"","operationId":"getAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJob"},"delete":{"tags":["Analytics","Conversations"],"summary":"Delete/cancel an async details job","description":"","operationId":"deleteAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsConversationsDetailsJob"}},"/api/v2/analytics/conversations/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Conversations"],"summary":"Fetch a page of results for an async details job","description":"","operationId":"getAnalyticsConversationsDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobResults"}},"/api/v2/analytics/conversations/details/jobs/availability":{"get":{"tags":["Analytics","Conversations"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsConversationsDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobsAvailability"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for evaluation aggregates","description":"","operationId":"postAnalyticsEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesQuery"}},"/api/v2/analytics/flowexecutions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for flow execution aggregates","description":"","operationId":"postAnalyticsFlowexecutionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowExecutionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowexecutionsAggregatesQuery"}},"/api/v2/analytics/flows/aggregates/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow aggregates","description":"","operationId":"postAnalyticsFlowsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to query for flow aggregates.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesQuery"}},"/api/v2/analytics/flows/observations/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow observations","description":"","operationId":"postAnalyticsFlowsObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsObservationsQuery"}},"/api/v2/analytics/flows/activity/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow activity observations","description":"","operationId":"postAnalyticsFlowsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsActivityQuery"}},"/api/v2/analytics/journeys/aggregates/query":{"post":{"tags":["Analytics","Journey"],"summary":"Query for journey aggregates","description":"","operationId":"postAnalyticsJourneysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesQuery"}},"/api/v2/analytics/knowledge/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for knowledge aggregates","description":"","operationId":"postAnalyticsKnowledgeAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/KnowledgeAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"postAnalyticsKnowledgeAggregatesQuery"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for queue observations","description":"","operationId":"postAnalyticsQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QueueObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"This user is not permitted to query for queue.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsQueuesObservationsQuery"}},"/api/v2/analytics/ratelimits/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded","description":"","operationId":"postAnalyticsRatelimitsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RateLimitAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RateLimitAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:rateLimitAggregate:view"]},"x-purecloud-method-name":"postAnalyticsRatelimitsAggregatesQuery"}},"/api/v2/analytics/routing/activity/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsRoutingActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RoutingActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsRoutingActivityQuery"}},"/api/v2/analytics/surveys/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for survey aggregates","description":"","operationId":"postAnalyticsSurveysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesQuery"}},"/api/v2/analytics/teams/activity/query":{"post":{"tags":["Analytics","Teams"],"summary":"Query for team activity observations","description":"","operationId":"postAnalyticsTeamsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TeamActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:teamObservation:view"]},"x-purecloud-method-name":"postAnalyticsTeamsActivityQuery"}},"/api/v2/analytics/transcripts/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates","description":"","operationId":"postAnalyticsTranscriptsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesQuery"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user aggregates","description":"","operationId":"postAnalyticsUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesQuery"}},"/api/v2/analytics/users/details/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details","description":"","operationId":"postAnalyticsUsersDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserDetailsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user observations","description":"","operationId":"postAnalyticsUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersObservationsQuery"}},"/api/v2/analytics/users/activity/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsUsersActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersActivityQuery"}},"/api/v2/analytics/users/details/jobs":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details asynchronously","description":"","operationId":"postAnalyticsUsersDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncUserDetailsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsJobs"}},"/api/v2/analytics/users/details/jobs/{jobId}":{"get":{"tags":["Analytics","Users"],"summary":"Get status for async query for user details","description":"","operationId":"getAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJob"},"delete":{"tags":["Analytics","Users"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsUsersDetailsJob"}},"/api/v2/analytics/users/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Users"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsUsersDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobResults"}},"/api/v2/analytics/users/details/jobs/availability":{"get":{"tags":["Analytics","Users"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsUsersDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobsAvailability"}},"/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns (division aware).","description":"Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowDivisionsReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowDivisionAwareReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowDivisionsReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns.","description":"Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/sessions":{"get":{"tags":["Analytics"],"summary":"Get Bot Flow Sessions.","description":"Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowSessions","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"botResultCategories","in":"query","description":"Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.","required":false,"type":"string","enum":["Unknown","UserExit","BotExit","Error","RecognitionFailure","UserDisconnect","BotDisconnect","SessionExpired","Transfer"]},{"name":"endLanguage","in":"query","description":"Optional case-insensitive language code to filter sessions by the language the sessions ended in.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowSession:view"]},"x-purecloud-method-name":"getAnalyticsBotflowSessions"}},"/api/v2/analytics/dataretention/settings":{"get":{"tags":["Analytics"],"summary":"Get analytics data retention setting","description":"","operationId":"getAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:view"]},"x-purecloud-method-name":"getAnalyticsDataretentionSettings"},"put":{"tags":["Analytics"],"summary":"Update analytics data retention setting","description":"","operationId":"putAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"retentionDays","required":true,"schema":{"$ref":"#/definitions/UpdateAnalyticsDataRetentionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"analytics.data.retention.update.conflict":"The provided analytics data retention setting conflicts with existing policies/recordings in the org. Ensure that no recording policies retain recordings for longer than the provided retentionDays, and no recordings have delete dates further away from their creation dates than the provided retentionDays."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:edit"]},"x-purecloud-method-name":"putAnalyticsDataretentionSettings"}},"/api/v2/analytics/reporting/settings":{"get":{"tags":["Analytics"],"summary":"Get AnalyticsReportingSettings for an organization","description":"","operationId":"getAnalyticsReportingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSettings"},"patch":{"tags":["Analytics"],"summary":"Patch AnalyticsReportingSettings values for an organization","description":"","operationId":"patchAnalyticsReportingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AnalyticsReportingSettingsRequest","required":true,"schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update AnalyticsReportingSettings due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"AnalyticsReportingSettings for organization not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:reportingSettings:edit"]},"x-purecloud-method-name":"patchAnalyticsReportingSettings"}},"/api/v2/analytics/reporting/settings/dashboards/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk remove dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationBulkRequest"}}],"responses":{"204":{"description":"Dashboard Configurations were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:edit"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsBulkRemove"}},"/api/v2/analytics/reporting/settings/dashboards/query":{"post":{"tags":["Analytics"],"summary":"Query dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsQuery"}},"/api/v2/analytics/reporting/dashboards/users/{userId}":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for a user","description":"","operationId":"getAnalyticsReportingDashboardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUser"}},"/api/v2/analytics/reporting/dashboards/users/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk delete dashboards owned by other user(s)","description":"","operationId":"postAnalyticsReportingDashboardsUsersBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of userIds","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Dashboards were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dashboardConfigurations:deleteActive","analytics:dashboardConfigurations:deleteInactive"]},"x-purecloud-method-name":"postAnalyticsReportingDashboardsUsersBulkRemove"}},"/api/v2/analytics/reporting/dashboards/users":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for users in a org","description":"","operationId":"getAnalyticsReportingDashboardsUsers","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","enum":["active","inactive"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUserListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUsers"}},"/api/v2/analytics/reporting/settings/users/{userId}/dashboards":{"get":{"tags":["Analytics"],"summary":"Get list of dashboards for an user","description":"","operationId":"getAnalyticsReportingSettingsUserDashboards","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":50,"format":"int32"},{"name":"publicOnly","in":"query","description":"If true, retrieve only public dashboards","required":false,"type":"boolean"},{"name":"favoriteOnly","in":"query","description":"If true, retrieve only favorite dashboards","required":false,"type":"boolean"},{"name":"name","in":"query","description":"retrieve dashboards that match with given name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:viewPrivate"]},"x-purecloud-method-name":"getAnalyticsReportingSettingsUserDashboards"}},"/api/v2/analytics/reporting/exports/metadata":{"get":{"tags":["Analytics"],"summary":"Get all export metadata","description":"","operationId":"getAnalyticsReportingExportsMetadata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportMetadataJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExportsMetadata"}},"/api/v2/analytics/reporting/exports":{"get":{"tags":["Analytics"],"summary":"Get all view export requests for a user","description":"","operationId":"getAnalyticsReportingExports","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExports"},"post":{"tags":["Analytics"],"summary":"Generate a view export request","description":"This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead","operationId":"postAnalyticsReportingExports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportingExportJobRequest","required":true,"schema":{"$ref":"#/definitions/ReportingExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to generate a view export request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:add"]},"x-purecloud-method-name":"postAnalyticsReportingExports"}},"/api/v2/audits/query/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in audits.","description":"","operationId":"getAuditsQueryServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryServicemapping"}},"/api/v2/audits/query/{transactionId}":{"get":{"tags":["Audit"],"summary":"Get status of audit query execution","description":"","operationId":"getAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionId"}},"/api/v2/audits/query/{transactionId}/results":{"get":{"tags":["Audit"],"summary":"Get results of audit query","description":"","operationId":"getAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionIdResults"}},"/api/v2/audits/query":{"post":{"tags":["Audit"],"summary":"Create audit query execution","description":"Use /api/v2/audits/query/servicemapping endpoint for a list of valid values","operationId":"postAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQuery"}},"/api/v2/audits/query/realtime":{"post":{"tags":["Audit"],"summary":"This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.","description":"Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values","operationId":"postAuditsQueryRealtime","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeQueryResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtime"}},"/api/v2/audits/query/realtime/related":{"post":{"tags":["Audit"],"summary":"Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.","description":"","operationId":"postAuditsQueryRealtimeRelated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeRelatedRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeRelatedResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtimeRelated"}},"/api/v2/audits/query/realtime/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in realtime audits.","description":"","operationId":"getAuditsQueryRealtimeServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryRealtimeServicemapping"}},"/api/v2/authorization/divisions/home":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve the home division for the organization.","description":"Will not include object counts.","operationId":"getAuthorizationDivisionsHome","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsHome"}},"/api/v2/authorization/divisions/limit":{"get":{"tags":["Authorization","Objects"],"summary":"Returns the maximum allowed number of divisions.","description":"","operationId":"getAuthorizationDivisionsLimit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int32"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsLimit"}},"/api/v2/authorization/divisions/{divisionId}/objects/{objectType}":{"post":{"tags":["Authorization","Objects"],"summary":"Assign a list of objects to a division","description":"Set the division of a specified list of objects. The objects must all be of the same type, one of: \nCAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. \nThe body of the request is a list of object IDs, which are expected to be \nGUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]","operationId":"postAuthorizationDivisionObject","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectType","in":"path","description":"The type of the objects. Must be one of the valid object types","required":true,"type":"string","enum":["QUEUE","CAMPAIGN","CONTACTLIST","DNCLIST","EMAILCAMPAIGN","MESSAGINGCAMPAIGN","MANAGEMENTUNIT","BUSINESSUNIT","FLOW","FLOWMILESTONE","FLOWOUTCOME","USER","CALLROUTE","EMERGENCYGROUPS","ROUTINGSCHEDULES","ROUTINGSCHEDULEGROUPS","DATATABLES","TEAM","WORKBIN","WORKTYPE","EXTENSIONPOOL","SKILLGROUP","SCRIPT"]},{"in":"body","name":"body","description":"Object Id List","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The divisions were updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.bulk.division.updates":"Unable to move objects because the request contained too many objects","empty.bulk.division.update":"Unable to move object because the request contained an empty object.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bulk.move.no.permission.division":"Unable to move object(s) because the requesting user does not have edit permission in the destination division","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.units.not.found":"One or more requested management units were not found","wfm.business.units.not.found":"One or more requested business units were not found","general.resource.not.found":"Requested resource is not available.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.unable.to.move":"One or more of the object(s) failed to be moved to the destination division"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed","bulk.move.permission.check.error":"Failed to check permissions in one or more of the divisions in the request","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-purecloud-method-name":"postAuthorizationDivisionObject"}},"/api/v2/authorization/subjects/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for the currently authenticated user.","description":"","operationId":"getAuthorizationSubjectsMe","produces":["application/json"],"parameters":[{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationSubjectsMe"}},"/api/v2/authorization/subjects/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getAuthorizationSubject","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has ocurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubject"}},"/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}":{"post":{"tags":["Authorization","Users"],"summary":"Make a grant of a role in a division","description":"","operationId":"postAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division to which to make the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role to grant","required":true,"type":"string"},{"name":"subjectType","in":"query","description":"what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)","required":false,"type":"string","default":"PC_USER"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectDivisionRole"},"delete":{"tags":["Authorization","Users"],"summary":"Delete a grant of a role in a division","description":"","operationId":"deleteAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division of the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role of the grant","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"deleteAuthorizationSubjectDivisionRole"}},"/api/v2/authorization/subjects/{subjectId}/bulkadd":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-grant roles and divisions to a subject.","description":"","operationId":"postAuthorizationSubjectBulkadd","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkadd"}},"/api/v2/authorization/subjects/{subjectId}/bulkreplace":{"post":{"tags":["Authorization","Users"],"summary":"Replace subject's roles and divisions with the exact list supplied in the request.","description":"This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.","operationId":"postAuthorizationSubjectBulkreplace","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Replaced"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add","authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkreplace"}},"/api/v2/authorization/subjects/{subjectId}/bulkremove":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-remove grants from a subject.","description":"","operationId":"postAuthorizationSubjectBulkremove","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"204":{"description":"Bulk Grants Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkremove"}},"/api/v2/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putAuthorizationRoleUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"putAuthorizationRoleUsersRemove"}},"/api/v2/authorization/roles/{roleId}/users":{"get":{"tags":["Authorization"],"summary":"Get a list of the users in a specified role.","description":"Get an array of the UUIDs of the users in the specified role.","operationId":"getAuthorizationRoleUsers","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationRoleUsers"}},"/api/v2/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putAuthorizationRoleUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putAuthorizationRoleUsersAdd"}},"/api/v2/authorization/divisions/{divisionId}/grants":{"get":{"tags":["Authorization"],"summary":"Gets all grants for a given division.","description":"Returns all grants assigned to a given division. Maximum page size is 500.","operationId":"getAuthorizationDivisionGrants","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionGrantEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationDivisionGrants"}},"/api/v2/authorization/divisionspermitted/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedMe","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedMe"}},"/api/v2/authorization/divisionspermitted/paged/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"","operationId":"getAuthorizationDivisionspermittedPagedMe","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedMe"}},"/api/v2/authorization/divisionspermitted/paged/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the specified user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedPagedSubjectId","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedSubjectId"}},"/api/v2/authorization/settings":{"get":{"tags":["Authorization"],"summary":"Get authorization settings","description":"","operationId":"getAuthorizationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:view"]},"x-purecloud-method-name":"getAuthorizationSettings"},"patch":{"tags":["Authorization"],"summary":"Change authorization settings","description":"Change authorization settings","operationId":"patchAuthorizationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Authorization Settings","required":true,"schema":{"$ref":"#/definitions/AuthorizationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:edit"]},"x-purecloud-method-name":"patchAuthorizationSettings"}},"/api/v2/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"userCount","in":"query","description":"Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts.","required":false,"type":"boolean","default":true,"enum":["true","false"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role","required":false,"type":"array","items":{"type":"string","enum":["unusedPermissions"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal service error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRole"},"post":{"tags":["Authorization"],"summary":"Bulk-grant subjects and divisions with an organization role.","description":"","operationId":"postAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Subjects and Divisions","required":true,"schema":{"$ref":"#/definitions/SubjectDivisions"}},{"name":"subjectType","in":"query","description":"what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.subject.type":"Bad request, invalid subject type","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationRole"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRole"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:delete"]},"x-purecloud-method-name":"deleteAuthorizationRole"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"patchAuthorizationRole"}},"/api/v2/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getAuthorizationRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"defaultRoleId","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.ids":"Only 100 roles can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postAuthorizationRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:add"]},"x-purecloud-method-name":"postAuthorizationRoles"}},"/api/v2/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getAuthorizationPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"queryType","in":"query","description":"Query filter type","required":false,"type":"string","enum":["domain","permission"]},{"name":"query","in":"query","description":"Comma-separated list of permissions or domains to query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationPermissions"}},"/api/v2/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getAuthorizationProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationProducts"}},"/api/v2/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"postAuthorizationRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization roles list","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRolesDefault"}},"/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleComparedefaultRightRoleId"},"post":{"tags":["Authorization"],"summary":"Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"postAuthorizationRoleComparedefaultRightRoleId"}},"/api/v2/authorization/roles/{roleId}/subjectgrants":{"get":{"tags":["Authorization"],"summary":"Get the subjects' granted divisions in the specified role.","description":"Includes the divisions for which the subject has a grant.","operationId":"getAuthorizationRoleSubjectgrants","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SubjectDivisionGrantsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleSubjectgrants"}},"/api/v2/authorization/subjects/rolecounts":{"get":{"tags":["Authorization"],"summary":"Get the count of roles granted to a list of subjects","description":"","operationId":"getAuthorizationSubjectsRolecounts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","max.subject.ids":"Only 100 subjects can be requested at a time.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubjectsRolecounts"}},"/api/v2/users/{subjectId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getUserRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an active user with that ID in this organization.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putUserRoles"}},"/api/v2/screenrecording/token":{"post":{"tags":["Screen Recording"],"summary":"Sign identifying information for screen recording","description":"","operationId":"postScreenrecordingToken","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingUserAuthenticatedInfo"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization:readonly"]}],"x-purecloud-method-name":"postScreenrecordingToken"}},"/api/v2/billing/reports/billableusage":{"get":{"tags":["Billing"],"summary":"Get a report of the billable license usages","description":"Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","operationId":"getBillingReportsBillableusage","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BillingUsageReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["billing:subscription:read","billing:subscription:view"]},"x-purecloud-method-name":"getBillingReportsBillableusage"}},"/api/v2/billing/trusteebillingoverview/{trustorOrgId}":{"get":{"tags":["Billing"],"summary":"Get the billing overview for an organization that is managed by a partner.","description":"Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/","operationId":"getBillingTrusteebillingoverviewTrustorOrgId","produces":["application/json"],"parameters":[{"name":"billingPeriodIndex","in":"query","description":"0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"trustorOrgId","in":"path","description":"The organization ID of the trustor (customer) organization.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeBillingOverview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing","billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["affiliateOrganization:clientBilling:view"]},"x-purecloud-method-name":"getBillingTrusteebillingoverviewTrustorOrgId"}},"/api/v2/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","callforwarding.usernotpermitted":"User is not permitted to use call forwarding","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected response code from external service"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"putUserCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"patchUserCallforwarding"}},"/api/v2/carrierservices/integrations/emergencylocations/me":{"get":{"tags":["Carrier Services"],"summary":"Get location for the logged in user","description":"","operationId":"getCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Phone number in E164 format","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getCarrierservicesIntegrationsEmergencylocationsMe"},"post":{"tags":["Carrier Services"],"summary":"Set current location for the logged in user","description":"","operationId":"postCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmergencyLocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorInfo"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"postCarrierservicesIntegrationsEmergencylocationsMe"}},"/api/v2/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postCertificateDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Certificate","required":true,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"postCertificateDetails"}},"/api/v2/chats/settings":{"get":{"tags":["Chat"],"summary":"Get Chat Settings.","description":"","operationId":"getChatsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:view","chat:setting:edit"]},"x-purecloud-method-name":"getChatsSettings"},"put":{"tags":["Chat"],"summary":"Update Chat Settings.","description":"","operationId":"putChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"putChatsSettings"},"patch":{"tags":["Chat"],"summary":"Patch Chat Settings.","description":"","operationId":"patchChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"patchChatsSettings"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a room","description":"","operationId":"getChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a 1on1","description":"","operationId":"getChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessage"}},"/api/v2/chats/messages/{messageId}":{"get":{"tags":["Chat"],"summary":"Get a message","description":"","operationId":"getChatsMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view","chat:room:view"]},"x-purecloud-method-name":"getChatsMessage"}},"/api/v2/chats/messages/{messageId}/reactions":{"put":{"tags":["Chat"],"summary":"Update reactions to a message","description":"","operationId":"putChatsMessageReactions","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"reactionUpdate","required":true,"schema":{"$ref":"#/definitions/ChatReactionUpdate"}}],"responses":{"204":{"description":"Reactions updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:reactions:edit"]},"x-purecloud-method-name":"putChatsMessageReactions"}},"/api/v2/chats/rooms/{roomJid}/messages":{"get":{"tags":["Chat"],"summary":"Get a room's message history","description":"","operationId":"getChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a room","description":"","operationId":"postChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:add"]},"x-purecloud-method-name":"postChatsRoomMessages"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message in a room","description":"","operationId":"deleteChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:delete"]},"x-purecloud-method-name":"deleteChatsRoomMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message in a room","description":"","operationId":"patchChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:edit"]},"x-purecloud-method-name":"patchChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages":{"get":{"tags":["Chat"],"summary":"Get 1on1 History between a user","description":"","operationId":"getChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a user","description":"","operationId":"postChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:add"]},"x-purecloud-method-name":"postChatsUserMessages"}},"/api/v2/chats/users/{userId}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message to a user","description":"","operationId":"deleteChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:delete"]},"x-purecloud-method-name":"deleteChatsUserMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message to a user","description":"","operationId":"patchChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"patchChatsUserMessage"}},"/api/v2/chats/rooms/{roomJid}/participants/{participantJid}":{"get":{"tags":["Chat"],"summary":"Get a room participant","description":"","operationId":"getChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"participantJid","in":"path","description":"participantJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants/{userId}":{"post":{"tags":["Chat"],"summary":"Join a room","description":"","operationId":"postChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"Joined room successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:add"]},"x-purecloud-method-name":"postChatsRoomParticipant"},"delete":{"tags":["Chat"],"summary":"Remove a user from a room.","description":"","operationId":"deleteChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"User removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:delete"]},"x-purecloud-method-name":"deleteChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants":{"get":{"tags":["Chat"],"summary":"Get room participants in a room","description":"","operationId":"getChatsRoomParticipants","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipantsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomParticipants"}},"/api/v2/chats/rooms/{roomJid}":{"get":{"tags":["Chat"],"summary":"Get a room","description":"","operationId":"getChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Room"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoom"},"patch":{"tags":["Chat"],"summary":"Set properties for a room","description":"","operationId":"patchChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/RoomUpdateRequest"}}],"responses":{"204":{"description":"Room updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"patchChatsRoom"}},"/api/v2/chats/rooms":{"post":{"tags":["Chat"],"summary":"Create an adhoc room","description":"","operationId":"postChatsRooms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/CreateRoomRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateRoomResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:add"]},"x-purecloud-method-name":"postChatsRooms"}},"/api/v2/chats/rooms/{roomJid}/messages/pins":{"post":{"tags":["Chat"],"summary":"Add pinned messages for a room, up to a maximum of 5 pinned messages","description":"","operationId":"postChatsRoomMessagesPins","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Pinned Message Ids","required":true,"schema":{"$ref":"#/definitions/PinnedMessageRequest"}}],"responses":{"204":{"description":"Pinned messages added successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"postChatsRoomMessagesPins"}},"/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}":{"delete":{"tags":["Chat"],"summary":"Remove a pinned message from a room","description":"","operationId":"deleteChatsRoomMessagesPin","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"pinnedMessageId","in":"path","description":"pinnedMessageId","required":true,"type":"string"}],"responses":{"204":{"description":"Pinned message removed successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"deleteChatsRoomMessagesPin"}},"/api/v2/chats/threads/{threadId}/messages":{"get":{"tags":["Chat"],"summary":"Get history by thread","description":"","operationId":"getChatsThreadMessages","produces":["application/json"],"parameters":[{"name":"threadId","in":"path","description":"threadId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsThreadMessages"}},"/api/v2/conversations/{conversationId}/cobrowse":{"post":{"tags":["Conversations"],"summary":"Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.","description":"","operationId":"postConversationCobrowse","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cobrowse:add","conversation:cobrowseVoice:add"]},"x-purecloud-method-name":"postConversationCobrowse"}},"/api/v2/scripts/{scriptId}/export":{"post":{"tags":["Scripts"],"summary":"Export a script via download service.","description":"","operationId":"postScriptExport","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ExportScriptRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportScriptResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"postScriptExport"}},"/api/v2/scripts/uploads/{uploadId}/status":{"get":{"tags":["Scripts"],"summary":"Get the upload status of an imported script","description":"","operationId":"getScriptsUploadStatus","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload ID","required":true,"type":"string"},{"name":"longPoll","in":"query","description":"Enable longPolling endpoint","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScriptStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsUploadStatus"}},"/api/v2/scripts/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get a page","description":"","operationId":"getScriptPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPage"}},"/api/v2/scripts/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of pages","description":"","operationId":"getScriptPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPages"}},"/api/v2/scripts/published/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get the published page.","description":"","operationId":"getScriptsPublishedScriptIdPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPage"}},"/api/v2/scripts/published/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of published pages","description":"","operationId":"getScriptsPublishedScriptIdPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPages"}},"/api/v2/scripts/published/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get the published script.","description":"","operationId":"getScriptsPublishedScriptId","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptId"}},"/api/v2/scripts/published/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the published scripts metadata.","description":"","operationId":"getScriptsPublishedDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:search"]},"x-purecloud-method-name":"getScriptsPublishedDivisionviews"}},"/api/v2/scripts/published":{"get":{"tags":["Scripts"],"summary":"Get the published scripts.","description":"","operationId":"getScriptsPublished","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublished"},"post":{"tags":["Scripts"],"summary":"Publish a script.","description":"","operationId":"postScriptsPublished","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PublishScriptRequestData"}},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","script.validation.error":"The script contained validation errors","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:add"]},"x-purecloud-method-name":"postScriptsPublished"}},"/api/v2/scripts/published/{scriptId}/variables":{"get":{"tags":["Scripts"],"summary":"Get the published variables","description":"","operationId":"getScriptsPublishedScriptIdVariables","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"input","in":"query","description":"input","required":false,"type":"string","enum":["true","false"]},{"name":"output","in":"query","description":"output","required":false,"type":"string","enum":["true","false"]},{"name":"type","in":"query","description":"type","required":false,"type":"string","enum":["string","number","boolean"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdVariables"}},"/api/v2/scripts/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get a script","description":"","operationId":"getScript","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScript"}},"/api/v2/scripts/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the metadata for a list of scripts","description":"","operationId":"getScriptsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsDivisionviews"}},"/api/v2/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScripts"}},"/api/v2/conversations/keyconfigurations/{keyconfigurationsId}":{"get":{"tags":["Conversations"],"summary":"Get the encryption key configurations","description":"","operationId":"getConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfiguration"},"put":{"tags":["Conversations"],"summary":"Update the encryption key configurations","description":"","operationId":"putConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"putConversationsKeyconfiguration"}},"/api/v2/conversations/keyconfigurations":{"get":{"tags":["Conversations"],"summary":"Get a list of key configurations data","description":"","operationId":"getConversationsKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfigurations"},"post":{"tags":["Conversations"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postConversationsKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurations"}},"/api/v2/conversations/keyconfigurations/validate":{"post":{"tags":["Conversations"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postConversationsKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurationsValidate"}},"/api/v2/recording/crossplatform/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:add"]},"x-purecloud-method-name":"postRecordingCrossplatformMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicies"}},"/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingCrossplatformMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingCrossplatformMediaretentionpolicy"}},"/api/v2/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.invalid":"The recording policy is invalid.","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.duplicate.name":"Policy name already exists, cannot duplicate.","recording.policy.description.exceeds.limit":"Policy description exceeds size limit.","recording.policy.analytics.retention.violation":"Policy retention was violated.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","recording.policy.name.exceeds.limit":"Policy named exceeds size limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:add"]},"x-purecloud-method-name":"postRecordingMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicies"}},"/api/v2/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.required":"Recording policy named required.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error updating policy.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingMediaretentionpolicy"}},"/api/v2/recording/recordingkeys":{"get":{"tags":["Recording"],"summary":"Get encryption key list","description":"","operationId":"getRecordingRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeys"},"post":{"tags":["Recording"],"summary":"Create encryption key","description":"","operationId":"postRecordingRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingRecordingkeys"}},"/api/v2/recording/recordingkeys/rotationschedule":{"get":{"tags":["Recording"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeysRotationschedule"},"put":{"tags":["Recording"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":true,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingRecordingkeysRotationschedule"}},"/api/v2/recording/localkeys":{"post":{"tags":["Recording"],"summary":"create a local key management recording key","description":"","operationId":"postRecordingLocalkeys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption body","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionKeyRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeys"}},"/api/v2/recording/keyconfigurations/{keyConfigurationId}":{"get":{"tags":["Recording"],"summary":"Get the encryption key configurations","description":"","operationId":"getRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfiguration"},"put":{"tags":["Recording"],"summary":"Update the encryption key configurations","description":"","operationId":"putRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingKeyconfiguration"}},"/api/v2/recording/keyconfigurations":{"get":{"tags":["Recording"],"summary":"Get a list of key configurations data","description":"","operationId":"getRecordingKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfigurations"},"post":{"tags":["Recording"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postRecordingKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurations"}},"/api/v2/recording/keyconfigurations/validate":{"post":{"tags":["Recording"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postRecordingKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurationsValidate"}},"/api/v2/externalcontacts/bulk/contacts/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove contacts","description":"","operationId":"postExternalcontactsBulkContactsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsRemove"}},"/api/v2/externalcontacts/bulk/contacts":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch contacts","description":"","operationId":"postExternalcontactsBulkContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContacts"}},"/api/v2/externalcontacts/bulk/contacts/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update contacts","description":"","operationId":"postExternalcontactsBulkContactsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUpdate"}},"/api/v2/externalcontacts/bulk/contacts/unresolved":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch unresolved ancestor contacts","description":"","operationId":"postExternalcontactsBulkContactsUnresolved","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUnresolved"}},"/api/v2/externalcontacts/bulk/contacts/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add contacts","description":"","operationId":"postExternalcontactsBulkContactsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsAdd"}},"/api/v2/externalcontacts/bulk/notes/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add notes","description":"","operationId":"postExternalcontactsBulkNotesAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesAdd"}},"/api/v2/externalcontacts/bulk/notes/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove notes","description":"","operationId":"postExternalcontactsBulkNotesRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesRemove"}},"/api/v2/externalcontacts/bulk/notes":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch notes","description":"","operationId":"postExternalcontactsBulkNotes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkNotes"}},"/api/v2/externalcontacts/bulk/notes/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update notes","description":"","operationId":"postExternalcontactsBulkNotesUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesUpdate"}},"/api/v2/externalcontacts/bulk/organizations/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsAdd"}},"/api/v2/externalcontacts/bulk/organizations/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsRemove"}},"/api/v2/externalcontacts/bulk/organizations":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch organizations","description":"","operationId":"postExternalcontactsBulkOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizations"}},"/api/v2/externalcontacts/bulk/organizations/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsUpdate"}},"/api/v2/externalcontacts/bulk/relationships/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsAdd"}},"/api/v2/externalcontacts/bulk/relationships/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsRemove"}},"/api/v2/externalcontacts/bulk/relationships":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch relationships","description":"","operationId":"postExternalcontactsBulkRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationships"}},"/api/v2/externalcontacts/bulk/relationships/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsUpdate"}},"/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external contact","description":"","operationId":"getExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external contact","description":"","operationId":"putExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContactNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external contact","description":"","operationId":"deleteExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactNote"}},"/api/v2/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external contact","description":"","operationId":"getExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external contact","description":"","operationId":"postExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsContactNotes"}},"/api/v2/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external contact","description":"","operationId":"getExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContact"},"put":{"tags":["External Contacts"],"summary":"Update an external contact","description":"","operationId":"putExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContact"},"delete":{"tags":["External Contacts"],"summary":"Delete an external contact","description":"","operationId":"deleteExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:delete","externalContacts:contact:delete"]},"x-purecloud-method-name":"deleteExternalcontactsContact"}},"/api/v2/externalcontacts/contacts/{contactId}/identifiers":{"get":{"tags":["External Contacts"],"summary":"List the identifiers for a contact","description":"","operationId":"getExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactIdentifiers"},"patch":{"tags":["External Contacts"],"summary":"Claim or release identifiers for a contact","description":"","operationId":"patchExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ClaimRequest","required":true,"schema":{"$ref":"#/definitions/IdentifierClaimRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactIdentifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.operation.type":"Invalid operation type","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","identifier.cannot.be.released":"Identifier cannot be released because it is not claimed by the contact","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.claim.conflict":"Identifier is already claimed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.cannot.be.claimed":"Identifier cannot be claimed as there's no empty field on the contact to place the identifier","operation.validation.failed":"Operation cannot take the value","validation.failed":"Field operation is not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"patchExternalcontactsContactIdentifiers"}},"/api/v2/externalcontacts/contacts/{contactId}/promotion":{"post":{"tags":["External Contacts"],"summary":"Promote an observed contact (ephemeral or identified) to a curated contact","description":"","operationId":"postExternalcontactsContactPromotion","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","promotion.of.curated.contact.failed":"The contact is a curated contact and cannot be promoted","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"The contact's type must be equal to \"Ephemeral\" or \"Identified\""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:promote"]},"x-purecloud-method-name":"postExternalcontactsContactPromotion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsContactsSchema"},"delete":{"tags":["External Contacts"],"summary":"Delete a schema","description":"","operationId":"deleteExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Delete operation forbidden.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactsSchema"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsContactsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external contact's schema","description":"","operationId":"getExternalcontactsContactsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersions"}},"/api/v2/externalcontacts/contacts/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsContactsSchemas"}},"/api/v2/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts","description":"","operationId":"getExternalcontactsContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContacts"},"post":{"tags":["External Contacts"],"summary":"Create an external contact","description":"","operationId":"postExternalcontactsContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:add","externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsContacts"}},"/api/v2/externalcontacts/merge/contacts":{"post":{"tags":["External Contacts"],"summary":"Merge two contacts into a new contact record","description":"Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details","operationId":"postExternalcontactsMergeContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MergeRequest","required":true,"schema":{"$ref":"#/definitions/MergeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"One of the contacts in the merge request was not found by ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"mergeset.max.size":"The number of merges exceeds the maximum size"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"User supplied an invalid merge request","merge.across.divisions.disallowed":"User supplied an invalid merge request"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:merge"]},"x-purecloud-method-name":"postExternalcontactsMergeContacts"}},"/api/v2/externalcontacts/scan/contacts":{"get":{"tags":["External Contacts"],"summary":"Scan for external contacts using paging","description":"","operationId":"getExternalcontactsScanContacts","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of contacts per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanContacts"}},"/api/v2/externalcontacts/conversations/{conversationId}":{"put":{"tags":["External Contacts"],"summary":"Associate/disassociate an external contact with a conversation","description":"To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","operationId":"putExternalcontactsConversation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationAssociation","required":true,"schema":{"$ref":"#/definitions/ConversationAssociation"}},{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing association"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The JSON body of the request was not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","eternal.contacts.invalid.entity.id":"The entity ID was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.association.communication.id.required":"The communication id is required"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External contact is not found by conversation id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:conversation:associate","externalContacts:conversation:associate"]},"x-purecloud-method-name":"putExternalcontactsConversation"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts in an external organization","description":"","operationId":"getExternalcontactsOrganizationContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationContacts"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external organization","description":"","operationId":"getExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external organization","description":"","operationId":"putExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external organization","description":"","operationId":"deleteExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationNote"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external organization","description":"","operationId":"getExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external organization","description":"","operationId":"postExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsOrganizationNotes"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship for an external organization","description":"","operationId":"getExternalcontactsOrganizationRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\"","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationRelationships"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external organization","description":"","operationId":"getExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganization"},"put":{"tags":["External Contacts"],"summary":"Update an external organization","description":"","operationId":"putExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganization"},"delete":{"tags":["External Contacts"],"summary":"Delete an external organization","description":"","operationId":"deleteExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"deleteExternalcontactsOrganization"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationsSchema"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersion"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external organization's schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersions"}},"/api/v2/externalcontacts/organizations/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizationsSchemas"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}":{"put":{"tags":["External Contacts"],"summary":"Links a Trustor with an External Organization","description":"","operationId":"putExternalcontactsOrganizationTrustorTrustorId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"trustorId","in":"path","description":"Trustor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationTrustorLink"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Trustor is not found by trustor id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided fields are not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationTrustorTrustorId"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor":{"delete":{"tags":["External Contacts"],"summary":"Unlink the Trustor for this External Organization","description":"","operationId":"deleteExternalcontactsOrganizationTrustor","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"204":{"description":"Trustor link has been deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Organization is not found by organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationTrustor"}},"/api/v2/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for external organizations","description":"","operationId":"getExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"trustorId","in":"query","description":"Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an external organization","description":"","operationId":"postExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The provided custom field is not valid.","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizations"}},"/api/v2/externalcontacts/scan/organizations":{"get":{"tags":["External Contacts"],"summary":"Scan for external organizations using paging","description":"","operationId":"getExternalcontactsScanOrganizations","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of organizations per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsScanOrganizations"}},"/api/v2/externalcontacts/identifierlookup":{"post":{"tags":["External Contacts"],"summary":"Fetch a contact using an identifier type and value.","description":"Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"","operationId":"postExternalcontactsIdentifierlookup","produces":["application/json"],"parameters":[{"in":"body","name":"identifier","required":true,"schema":{"$ref":"#/definitions/ContactIdentifier"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request body","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided identifier is not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view","relate:contact:view"]},"x-purecloud-method-name":"postExternalcontactsIdentifierlookup"}},"/api/v2/externalcontacts/contacts/{contactId}/journey/sessions":{"get":{"tags":["External Contacts","Journey"],"summary":"Retrieve all sessions for a given external contact.","description":"","operationId":"getExternalcontactsContactJourneySessions","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"includeMerged","in":"query","description":"Indicates whether to return sessions from all external contacts in the merge-set of the given one.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:session:view"]},"x-purecloud-method-name":"getExternalcontactsContactJourneySessions"}},"/api/v2/externalcontacts/scan/notes":{"get":{"tags":["External Contacts"],"summary":"Scan for notes using paging","description":"","operationId":"getExternalcontactsScanNotes","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of notes per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorNoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanNotes"}},"/api/v2/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsRelationship"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsRelationship"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsRelationship"}},"/api/v2/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postExternalcontactsRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The provided external organization was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsRelationships"}},"/api/v2/externalcontacts/scan/relationships":{"get":{"tags":["External Contacts"],"summary":"Scan for relationships","description":"","operationId":"getExternalcontactsScanRelationships","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of relationships per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorRelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanRelationships"}},"/api/v2/externalcontacts/reversewhitepageslookup":{"get":{"tags":["External Contacts"],"summary":"Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.","description":"","operationId":"getExternalcontactsReversewhitepageslookup","produces":["application/json"],"parameters":[{"name":"lookupVal","in":"query","description":"User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)","required":true,"type":"string"},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["contacts.externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReverseWhitepagesLookupResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsReversewhitepageslookup"}},"/api/v2/externalcontacts/contacts/{contactId}/unresolved":{"get":{"tags":["External Contacts"],"summary":"Fetch an unresolved external contact","description":"","operationId":"getExternalcontactsContactUnresolved","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactUnresolved"}},"/api/v2/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: a file attachment or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from downloading content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":true,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Ready for upload","schema":{"$ref":"#/definitions/ReplaceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid request, null argument provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"resource.conflict":"Resource conflict - Unexpected changeNumber was provided."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation","x-inin-error-codes":{"locked":"Locked - The document is locked by another operation."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocumentContent"}},"/api/v2/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["lockInfo","acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from getting document","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocument"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocument"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementDocument"}},"/api/v2/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getContentmanagementDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postContentmanagementDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid, null arguments provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from adding a document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocuments"}},"/api/v2/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getContentmanagementQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postContentmanagementQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","trustee.forbidden":"Forbidden due to trustee from deleting query content.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting query content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementQuery"}},"/api/v2/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getContentmanagementSecurityprofile","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofile"}},"/api/v2/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getContentmanagementSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofiles"}},"/api/v2/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShare"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a share.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementShare"}},"/api/v2/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getContentmanagementSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated.","schema":{"$ref":"#/definitions/SharedResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","unauthorized":"Unauthorized to access document.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSharedSharedId"}},"/api/v2/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares. You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getContentmanagementShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postContentmanagementShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":true,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from saving a share.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementShares"}},"/api/v2/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementStatusStatusId"}},"/api/v2/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getContentmanagementStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatus"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalue"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tag.value.too.long":"The tag value is too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","tag.value.empty":"The tag value cannot be empty.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceTagvalue"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceTagvalue"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postContentmanagementWorkspaceTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvaluesQuery"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvalues"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getContentmanagementUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementUsage"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementWorkspaceDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceDocuments"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMember"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace Member","required":true,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to add a member to a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceMember"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to delete a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceMember"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getContentmanagementWorkspaceMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get workspace members","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMembers"}},"/api/v2/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from getting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspace"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to update a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspace"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspace"}},"/api/v2/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level.","required":false,"type":"array","items":{"type":"string","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"],"default":"document:viewmetadata"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.workspace.access.fields":"Has invalid workspace fields.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaces"}},"/api/v2/conversations/participants/attributes/search":{"post":{"tags":["Conversations","Search"],"summary":"Search conversations","description":"","operationId":"postConversationsParticipantsAttributesSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/ConversationParticipantSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonCursorSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"postConversationsParticipantsAttributesSearch"}},"/api/v2/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:view"]},"x-purecloud-method-name":"getConversation"}},"/api/v2/conversations/{conversationId}/disconnect":{"post":{"tags":["Conversations"],"summary":"Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.","description":"","operationId":"postConversationDisconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationDisconnect"}},"/api/v2/conversations/{conversationId}/assign":{"post":{"tags":["Conversations"],"summary":"Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"postConversationAssign","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/ConversationUser"}}],"responses":{"202":{"description":"The manual assignment request was accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.status":"The user's current routing status does not allow for new conversation assignments.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","feature.not.enabled":"The feature allowing manual assignment is not enabled for this queue.","operation.failed":"The manual assignment attempt failed.","invalid.id":"The targeted user ID is missing or invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You do not have the required permission for this operation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The conversation or queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Too many active requests. Try again later."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:pull","conversation:call:assign","conversation:callback:pull","conversation:callback:assign","conversation:webchat:pull","conversation:webchat:assign","conversation:email:pull","conversation:email:assign","conversation:message:pull","conversation:message:assign"]},"x-purecloud-method-name":"postConversationAssign"}},"/api/v2/conversations/{conversationId}/tags":{"put":{"tags":["Conversations"],"summary":"Update the tags on a conversation.","description":"","operationId":"putConversationTags","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Tags","required":true,"schema":{"$ref":"#/definitions/ConversationTagsUpdate"}}],"responses":{"202":{"description":"The tags update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:externalTag:edit"]},"x-purecloud-method-name":"putConversationTags"}},"/api/v2/conversations/{conversationId}/secureattributes":{"get":{"tags":["Conversations"],"summary":"Get the secure attributes on a conversation.","description":"","operationId":"getConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"Secure attributes retrieved successfully","schema":{"$ref":"#/definitions/ConversationSecureAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","secure.attributes.not.found":"Secure attributes could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"getConversationSecureattributes"},"put":{"tags":["Conversations"],"summary":"Set the secure attributes on a conversation.","description":"","operationId":"putConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes set request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred setting the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"putConversationSecureattributes"},"patch":{"tags":["Conversations"],"summary":"Update the secure attributes on a conversation.","description":"","operationId":"patchConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred updating the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"patchConversationSecureattributes"}},"/api/v2/conversations":{"get":{"tags":["Conversations"],"summary":"Get active conversations for the logged in user","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversations"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postConversationsFaxes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":true,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.content.type.not.supported":"The fax content type is not supported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","fax.missing.field":"Missing required field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","fax.internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsFaxes"}},"/api/v2/conversations/settings":{"get":{"tags":["Conversations"],"summary":"Get Settings","description":"","operationId":"getConversationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Settings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getConversationsSettings"},"patch":{"tags":["Conversations"],"summary":"Update Settings","description":"","operationId":"patchConversationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/Settings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchConversationsSettings"}},"/api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update after-call work for this conversation communication.","description":"","operationId":"patchConversationsAftercallworkConversationIdParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"AfterCallWorkUpdate","required":true,"schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsAftercallworkConversationIdParticipantCommunication"}},"/api/v2/conversations/callbacks/bulk/update":{"post":{"tags":["Conversations"],"summary":"Update multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackPatchRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkCallbackPatchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk edit request.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"postConversationsCallbacksBulkUpdate"}},"/api/v2/conversations/callbacks/bulk/disconnect":{"post":{"tags":["Conversations"],"summary":"Disconnect multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkDisconnect","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackDisconnectRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackDisconnectRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk disconnect request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationsCallbacksBulkDisconnect"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get active call conversations for the logged in user","description":"","operationId":"getConversationsCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postConversationsCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Call request","required":true,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.create.conversation.parameters":"Only a single destination can be supplied in a create conversation request.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.create.conversation.destination.parameter":"At least one destination should be supplied in a create conversation request.","constraint.validation":"%s","conversation.error.no.user.station":"A station is required to place a call.","conversation.error.cannot.create.conference":"Unable to create a conference.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.invalid.external.contact":"The external contact supplied is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.cannot.resolve":"Cannot resolve station.","providerapi.error.user.does.not.have.a.station":"User does not have a station.","conversation.error.media.failed":"The media request failed.","providerapi.error.edge.cannot.resolve":"Cannot resolve edge.","providerapi.error.ccxml.uri.not_found":"Failed to get CCXML URI from edge config.","providerapi.error.edge.no.active":"Could not find an active Edge in Site.","providerapi.error.phone.cannot.resolve":"Cannot resolve phone.","providerapi.error.phone.no.active.edge":"The phone is not assigned to active Edges."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conference:add"]},"x-purecloud-method-name":"postConversationsCalls"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantReplace"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsCallParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:monitor"]},"x-purecloud-method-name":"postConversationsCallParticipantMonitor"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapupcodes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversation.error.consult.transfer.not.started":"The consult transfer can't be canceled since it hasn't started yet."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsCallParticipantConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantConsult"}},"/api/v2/conversations/calls/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.common.user":"This conference can not be created because there is no common user among all the active participants.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.media.failed":"The media request failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCall"},"post":{"tags":["Conversations"],"summary":"Place a new call as part of a callback conversation.","description":"","operationId":"postConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.callback.call.cannot.be.placed":"An error occurred while trying to place the callback.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCall"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants","description":"","operationId":"patchConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"Call is disconnected, cannot alter recordingState","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCall"}},"/api/v2/conversations/calls/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallRecordingstate"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantAttributes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantCommunication"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallParticipantCommunicationWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"The call is already disconnected.","conversation.error.user.not.party":"The participant for this request does not belong to the user making the request.","constraint.validation":"%s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.error.hold.alerting":"An alerting call cannot be placed on hold.","conversation.error.cannot.create.conference":"Unable to create a conference.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"Conversation not found.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallParticipant"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getConversationsCallsMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.","description":"","operationId":"postConversationsCallParticipantCoach","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:coach"]},"x-purecloud-method-name":"postConversationsCallParticipantCoach"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an agent","description":"","operationId":"postConversationsCallParticipantConsultAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination agent & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToAgent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferAgent"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultAgent"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to a queue","description":"","operationId":"postConversationsCallParticipantConsultQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination queue & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferQueue"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultQueue"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an external contact","description":"","operationId":"postConversationsCallParticipantConsultExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToExternal"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferExternal"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultExternal"}},"/api/v2/conversations/calls/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationsCallParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipants"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getConversationsCallsHistory","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size, maximum 50","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["externalorganization","externalcontact","user","queue","group"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallHistoryConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsHistory"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata":{"put":{"tags":["Conversations"],"summary":"Set uuiData to be sent on future commands.","description":"","operationId":"putConversationsCallParticipantCommunicationUuidata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"UUIData Request","required":true,"schema":{"$ref":"#/definitions/SetUuiDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsCallParticipantCommunicationUuidata"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get active callback conversations for the logged in user","description":"","operationId":"getConversationsCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Callback","required":true,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.scheduled.callback.limit.exceeded":"Number of callbacks has been exceeded for a single conversation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.number.limit.exceeded":"Number of attributes has exceeded the limit","callback.error.cannot.create.agent.owned.callback":"Cannot create agent owned callback on queue that does not have agent owned callbacks enabled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationsCallbacks"},"patch":{"tags":["Conversations"],"summary":"Update a scheduled callback","description":"","operationId":"patchConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"PatchCallbackRequest","required":true,"schema":{"$ref":"#/definitions/PatchCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PatchCallbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.missing.required.information.for.patch.request":"The patch request requires either a scheduled time or queueId.","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.conversation.not.found":"conversation not found.","callback.error.cannot.update.non.agent.owned.callback":"Cannot update non agent owned callback","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.queue.not.found":"queue not found","callback.error.agent.not.member.of.queue":"Agent is not a member of the queue","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","callback.error.scheduled.callback.job.id.not.found":"The scheduled callback job id was not found","callback.error.callback.not.found":"The callback was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.already.triggered":"Unable to update an already triggered callback."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.error.unable.to.update.schedule.callback":"Unable to update scheduled callback"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"patchConversationsCallbacks"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallbackParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred","callback.error.additional.info.value.length.invalid":"The length of the additional info value is invalid.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","conversations.error.transfer.acd.call.unattended.":"An ACD call cannot be transferred unattended.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.unable.to.schedule.callback":"Server error unable to schedule callback.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallbackParticipantReplace"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallbackParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapupcodes"}},"/api/v2/conversations/callbacks/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallback"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","conversation.error.cannot.conference.self":"A conversation cannot be merged with itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCallback"}},"/api/v2/conversations/callbacks/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallbackRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallbackRecordingstate"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallbackParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantAttributes"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallbackParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallbackParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantCommunication"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.communication.not.found":"Communication could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallbackParticipantCommunicationWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallbackParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","callback.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","callback.error.conversation.not.found":"Conversation not found.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallbackParticipant"}},"/api/v2/conversations/chats/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get a web chat conversation message","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessage"}},"/api/v2/conversations/chats/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get the messages of a chat conversation.","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If specified, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If specified, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send a message on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"chat error occurred due to null request body.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Chat error occurred due to bad request.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send a typing-indicator on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"chat conversation typing-indicator is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationTyping"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get active chat conversations for the logged in user","description":"","operationId":"getConversationsChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChats"},"post":{"tags":["Conversations"],"summary":"Create a web chat conversation","description":"","operationId":"postConversationsChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create web chat request","required":true,"schema":{"$ref":"#/definitions/CreateWebChatRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.provider":"The provider property may not be null.","chat.error.queue.not.found":"The queue does not exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:webchat:create"]},"x-purecloud-method-name":"postConversationsChats"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsChatParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsChatParticipantReplace"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsChatParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapupcodes"}},"/api/v2/conversations/chats/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChat"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsChat"}},"/api/v2/conversations/chats/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsChatRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsChatRecordingstate"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsChatParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantAttributes"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsChatParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsChatParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsChatParticipant"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsChatParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantCommunication"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsChatParticipantCommunicationWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantReplace"}},"/api/v2/conversations/cobrowsesessions":{"get":{"tags":["Conversations"],"summary":"Get active cobrowse conversations for the logged in user","description":"","operationId":"getConversationsCobrowsesessions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessions"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapupcodes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get cobrowse conversation","description":"","operationId":"getConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesession"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCobrowsesession"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCobrowsesessionRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCobrowsesessionRecordingstate"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantAttributes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantCommunication"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantCommunicationWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsEmailParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.transfer.replace.external":"External participants may not be replaced.","constraint.validation":"%s","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.transfer.not.connected":"Only connected participants can be transferred."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsEmailParticipantReplace"}},"/api/v2/conversations/emails/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsEmailMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessage"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get active email conversations for the logged in user","description":"","operationId":"getConversationsEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmails"},"post":{"tags":["Conversations"],"summary":"Create an email conversation","description":"If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","operationId":"postConversationsEmails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create email request","required":true,"schema":{"$ref":"#/definitions/CreateEmailRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.outbound.invalid.external.contact":"The external contact supplied is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","email.outbound.queue.address.required":"The queue does not have an outbound email address configured.","constraint.validation":"%s","postino.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","too.many.create.email.parameters":"One of queueId or flowId must be supplied.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.outbound.queue.required":"An outbound email conversation requires a queue ID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create"]},"x-purecloud-method-name":"postConversationsEmails"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsEmailParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapupcodes"}},"/api/v2/conversations/emails/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessagePreviewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageReply"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.attachments.upload.size":"Upload too large.","email.error.external.provider":"Operation not supported on emails with external providers.","email.error.domain.not.verified":"The email domain has not been verified.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.body":"Replies must have a textBody or htmlBody.","postino.error.reply.no.sender":"No connected internal participant found for the reply.","postino.error.reply.no.to":"Replies must have a to address.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.reply.no.receiver":"No connected external participant found for the reply.","postino.error.reply.no.userid":"Reply emails must have a userId.","email.error.invalid.email":"Attempted to send an email with an invalid parameter.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The request has timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessages"}},"/api/v2/conversations/emails/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmail"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsEmail"}},"/api/v2/conversations/emails/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsEmailRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsEmailRecordingstate"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsEmailParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantAttributes"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsEmailParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapup"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsEmailParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsEmailParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsEmailParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantCommunication"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsEmailParticipantCommunicationWrapup"}},"/api/v2/conversations/emails/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsEmailMessagesDraft"},"patch":{"tags":["Conversations"],"summary":"Reset conversation draft to its initial state and/or auto-fill draft content","description":"","operationId":"patchConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"autoFill","in":"query","description":"autoFill","required":false,"type":"boolean"},{"name":"discard","in":"query","description":"discard","required":false,"type":"boolean"},{"in":"body","name":"body","description":"Draft Manipulation Request","required":false,"schema":{"$ref":"#/definitions/DraftManipulationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax or missing field(s).","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.route.not.found":"The inbound route does not exist.","constraint.validation":"%s","postino.error.wrong.org":"OrganizationId does not match the resources organization.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","postino.error.forbidden":"User is not an active participant on the conversation","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.draft.initialized":"The draft is already initialized."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailMessagesDraft"}},"/api/v2/conversations/emails/{conversationId}/settings":{"get":{"tags":["Conversations"],"summary":"Get emails settings for a given conversation","description":"","operationId":"getConversationsEmailSettings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"The provided conversationId doesn't belong to the current organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The domain that should be used for sending, which is therefore used to determinate the emails settings, cannot be found","postino.error.not.found":"Either the conversation or related elements that permit to retrieve the concerned domain cannot be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailSettings"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationsEmailMessagesDraftAttachment","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.org.missing":"OrganizationId header is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsEmailMessagesDraftAttachment"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy":{"post":{"tags":["Conversations"],"summary":"Copy attachments from an email message to the current draft.","description":"","operationId":"postConversationsEmailMessagesDraftAttachmentsCopy","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Copy Attachment Request","required":true,"schema":{"$ref":"#/definitions/CopyAttachmentsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.userid":"Reply emails must have a userId.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessagesDraftAttachmentsCopy"}},"/api/v2/conversations/emails/{conversationId}/inboundmessages":{"post":{"tags":["Conversations"],"summary":"Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.","description":"","operationId":"postConversationsEmailInboundmessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Send external email reply","required":true,"schema":{"$ref":"#/definitions/InboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.error.internal.provider":"Operation not supported on emails with PureCloud providers","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","too.many.external.email.parameters":"Only one of queueId or flowId may be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailInboundmessages"}},"/api/v2/conversations/emails/agentless":{"post":{"tags":["Conversations"],"summary":"Create an email conversation, per API","description":"","operationId":"postConversationsEmailsAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless email request","required":true,"schema":{"$ref":"#/definitions/AgentlessEmailSendRequestDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentlessEmailSendResponseDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.subject.too.long":"The subject message was too long.","postino.error.invalid.sender.type":"The sender type is invalid","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.not.verified":"The outbound domain is not verified.","postino.error.missing.field":"Missing required field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.conversation.not.found":"The conversation does not exist or is not an email interaction.","postino.error.not.found":"The outbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error":"An error has occurred. Please contact support.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","postino.error.internal":"An internal service error has occurred. Please contact support."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create","conversation:agentlessEmail:send"]},"x-purecloud-method-name":"postConversationsEmailsAgentless"}},"/api/v2/emails/settings":{"get":{"tags":["Emails","Settings"],"summary":"Get email Contact Center settings","description":"","operationId":"getEmailsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getEmailsSettings"},"patch":{"tags":["Emails","Settings"],"summary":"Patch email Contact Center settings","description":"","operationId":"patchEmailsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmailSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchEmailsSettings"}},"/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}":{"get":{"tags":["Conversations"],"summary":"Get a cached media item","description":"","operationId":"getConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmediaCachedMediaItemId"},"delete":{"tags":["Conversations"],"summary":"Remove a cached media item asychronously","description":"","operationId":"deleteConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted to delete media from cache"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:delete"]},"x-purecloud-method-name":"deleteConversationsMessagesCachedmediaCachedMediaItemId"}},"/api/v2/conversations/messages/cachedmedia":{"get":{"tags":["Conversations"],"summary":"Get a list of cached media items","description":"","operationId":"getConversationsMessagesCachedmedia","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"url","in":"query","description":"URL to search for","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItemEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmedia"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsMessageParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsMessageParticipantReplace"}},"/api/v2/conversations/messages/{messageId}/details":{"get":{"tags":["Conversations"],"summary":"Get message","description":"","operationId":"getConversationsMessageDetails","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageDetails"}},"/api/v2/conversations/messages":{"get":{"tags":["Conversations"],"summary":"Get active message conversations for the logged in user","description":"","operationId":"getConversationsMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessages"},"post":{"tags":["Conversations"],"summary":"Create an outbound messaging conversation.","description":"If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","operationId":"postConversationsMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create outbound messaging conversation","required":true,"schema":{"$ref":"#/definitions/CreateOutboundMessagingConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.phone.numbers":"SMS phone number addresses are not in a valid E.164 format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.address.required":"The queue does not have an outbound messaging address configured.","invalid.whatsapp.address":"WhatsApp address must only contain numeric characters of destination phone number.","queue.membership.required":"Queue membership is invalid.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The SMS phone number address is not a valid E.164 format.","active.conversation":"An alerting or connected conversation is already in progress.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessages"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsMessageParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","too.many.monitors":"Only one monitor is allowed per conversation.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:monitor"]},"x-purecloud-method-name":"postConversationsMessageParticipantMonitor"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsMessageParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapupcodes"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send message","description":"Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.","operationId":"postConversationsMessageCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/AdditionalMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","not.found":"Message not found.","constraint.validation":"%s","media.too.large":"Media must comply with the size limits of the channel","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Server error handing chat."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessages"}},"/api/v2/conversations/messages/{conversationId}/messages/bulk":{"post":{"tags":["Conversations"],"summary":"Get messages in batch","description":"The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]","operationId":"postConversationsMessageMessagesBulk","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"messageIds","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"postConversationsMessageMessagesBulk"}},"/api/v2/conversations/messages/inbound/open":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Message","description":"[This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessagesInboundOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessagesInboundOpen"}},"/api/v2/conversations/messages/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get message conversation","description":"","operationId":"getConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessage"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsMessage"}},"/api/v2/conversations/messages/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsMessageRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsMessageRecordingstate"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsMessageParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantAttributes"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsMessageParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapup"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsMessageParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsMessageParticipant"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsMessageParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantCommunication"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsMessageParticipantCommunicationWrapup"}},"/api/v2/conversations/messages/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsMessageMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageMessage"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media":{"post":{"tags":["Conversations"],"summary":"Create media","description":"See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","operationId":"postConversationsMessageCommunicationMessagesMedia","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessagesMedia"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}":{"get":{"tags":["Conversations"],"summary":"Get media","description":"See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","operationId":"getConversationsMessageCommunicationMessagesMediaMediaId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"mediaId","in":"path","description":"mediaId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageCommunicationMessagesMediaMediaId"}},"/api/v2/conversations/messages/agentless":{"post":{"tags":["Conversations"],"summary":"Send an agentless outbound message","description":"Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and 'toAddress' specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.","operationId":"postConversationsMessagesAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless outbound messaging request","required":true,"schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageResponse"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.whatsapp.address":"WhatsApp address must only contain numeric characters of destination phone number.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","active.conversation":"An alerting or connected conversation is already in progress.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessagesAgentless"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/event":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Event Message","description":"Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenEvent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedEvent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenEvent"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/message":{"post":{"tags":["Conversations"],"summary":"Send inbound Open Message","description":"Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenMessage","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenMessage"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/receipt":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Receipt Message","description":"Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenReceipt","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedReceipt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenReceipt"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send message typing event","description":"Send message typing event for existing conversation/communication.","operationId":"postConversationsMessageCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"MessageTypingEvent","required":true,"schema":{"$ref":"#/definitions/MessageTypingEventRequest"}}],"responses":{"204":{"description":"Message typing event sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationTyping"}},"/api/v2/conversations/screenshares/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"putConversationsScreenshareRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsScreenshareRecordingstate"}},"/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsScreenshareParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsScreenshareParticipantCommunicationWrapup"}},"/api/v2/conversations/socials/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsSocialRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsSocialRecordingstate"}},"/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsSocialParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsSocialParticipantCommunicationWrapup"}},"/api/v2/conversations/videos/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsVideoRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsVideoRecordingstate"}},"/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsVideoParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsVideoParticipantCommunicationWrapup"}},"/api/v2/conversations/messaging/integrations":{"get":{"tags":["Conversations"],"summary":"Get a list of Integrations","description":"","operationId":"getConversationsMessagingIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"array","items":{"type":"string","enum":["supportedContent","messagingSetting"]},"collectionFormat":"multi"},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrations"}},"/api/v2/conversations/messaging/stickers/{messengerType}":{"get":{"tags":["Conversations"],"summary":"Get a list of Messaging Stickers (Deprecated)","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/","operationId":"getConversationsMessagingSticker","produces":["application/json"],"parameters":[{"name":"messengerType","in":"path","description":"Messenger Type","required":true,"type":"string","enum":["line"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingStickerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"getConversationsMessagingSticker"}},"/api/v2/conversations/messaging/threadingtimeline":{"get":{"tags":["Conversations"],"summary":"Get conversation threading window timeline for each messaging type","description":"Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.","operationId":"getConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:view"]},"x-purecloud-method-name":"getConversationsMessagingThreadingtimeline"},"put":{"tags":["Conversations"],"summary":"Update conversation threading window timeline for each messaging type","description":"PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.","operationId":"putConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationThreadingWindowRequest","required":true,"schema":{"$ref":"#/definitions/ConversationThreadingWindow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.threading.window.timeout":"The provided conversation threading window timeout for a messaging type is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:edit"]},"x-purecloud-method-name":"putConversationsMessagingThreadingtimeline"}},"/api/v2/conversations/messaging/facebook/app":{"get":{"tags":["Conversations"],"summary":"Get Genesys Facebook App Id","description":"","operationId":"getConversationsMessagingFacebookApp","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookAppCredentials"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookApp"}},"/api/v2/conversations/messaging/integrations/facebook/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Facebook messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebookIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Facebook messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Facebook integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsFacebookIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Facebook messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"FacebookIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsFacebookIntegrationId"}},"/api/v2/conversations/messaging/integrations/facebook":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Integrations","description":"","operationId":"getConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebook"},"post":{"tags":["Conversations"],"summary":"Create a Facebook Integration","description":"","operationId":"postConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FacebookIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Facebook permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","unsupported.message.channel":"Unsupported messageChannel.","constraint.validation":"%s","facebook.public.not.yet.supported":"Facebook Public not yet supported.","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature.","existing.active.webhook.facebook.subscription":"There is another active webhook subscription for this Facebook App."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsFacebook"}},"/api/v2/conversations/messaging/facebook/permissions":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Permissions","description":"","operationId":"getConversationsMessagingFacebookPermissions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Completed request for public message.","schema":{"$ref":"#/definitions/FacebookPermissionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:integration:add","messaging:integration:edit","messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookPermissions"}},"/api/v2/conversations/messaging/integrations/instagram/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get Instagram messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagramIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete Instagram messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Instagram integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsInstagramIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Instagram messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"InstagramIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsInstagramIntegrationId"}},"/api/v2/conversations/messaging/integrations/instagram":{"get":{"tags":["Conversations"],"summary":"Get a list of Instagram Integrations","description":"","operationId":"getConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagram"},"post":{"tags":["Conversations"],"summary":"Create Instagram Integration","description":"","operationId":"postConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"InstagramIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Instagram permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","instagram.not.yet.supported":"Instagram not yet supported.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","no.instagram.account.associated.with.page":"No Instagram account associated with page.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","page.subscription.error":"Encountered an error while subscribing Facebook page to webhooks. Verify that any existing integration linked to this page is in a valid state","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsInstagram"}},"/api/v2/conversations/messaging/integrations/open/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpenIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"deleteConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Open messaging integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsOpenIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"patchConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OpenIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsOpenIntegrationId"}},"/api/v2/conversations/messaging/integrations/open":{"get":{"tags":["Conversations"],"summary":"Get a list of Open messaging integrations","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpen"},"post":{"tags":["Conversations"],"summary":"Create an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"postConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OpenIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsOpen"}},"/api/v2/conversations/messaging/settings/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"getConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettingsDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default setting that may be applied to to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"putConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putConversationsMessagingSettingsDefault"},"delete":{"tags":["Conversations"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"deleteConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSettingsDefault"}},"/api/v2/conversations/messaging/settings":{"get":{"tags":["Conversations"],"summary":"Get a list of messaging settings","description":"","operationId":"getConversationsMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettings"},"post":{"tags":["Conversations"],"summary":"Create a messaging setting","description":"","operationId":"postConversationsMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postConversationsMessagingSettings"}},"/api/v2/conversations/messaging/settings/{messageSettingId}":{"get":{"tags":["Conversations"],"summary":"Get a messaging setting","description":"","operationId":"getConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSetting"},"delete":{"tags":["Conversations"],"summary":"Delete a messaging setting","description":"","operationId":"deleteConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSetting"},"patch":{"tags":["Conversations"],"summary":"Update a messaging setting","description":"","operationId":"patchConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSetting"}},"/api/v2/conversations/messaging/supportedcontent/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default supported content profile that will be used as the default when creating an integration.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"getConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default supported content profile that may be assigned to an integration when it is created.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"putConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContentReference"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.id.required":"The supported content ID is required","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"putConversationsMessagingSupportedcontentDefault"}},"/api/v2/conversations/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Conversations"],"summary":"Get a supported content profile","description":"","operationId":"getConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Conversations"],"summary":"Delete a supported content profile","description":"","operationId":"deleteConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Conversations"],"summary":"Update a supported content profile","description":"","operationId":"patchConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSupportedcontentSupportedContentId"}},"/api/v2/conversations/messaging/supportedcontent":{"get":{"tags":["Conversations"],"summary":"Get a list of Supported Content profiles","description":"","operationId":"getConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontent"},"post":{"tags":["Conversations"],"summary":"Create a Supported Content profile","description":"","operationId":"postConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postConversationsMessagingSupportedcontent"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}":{"patch":{"tags":["Conversations"],"summary":"Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow","description":"Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active","operationId":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationActivationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationActivationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration activation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","phone.number.not.found.on.waba":"The phone number provided was not found on the WABA.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"please.ensure.two.factor.authentication.is.disabled":"Please ensure two-factor authentication is disabled.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup":{"post":{"tags":["Conversations"],"summary":"Create a WhatsApp Integration using the WhatsApp embedded signup flow","description":"Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.","operationId":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup"}},"/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a WhatsApp messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsappIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a WhatsApp messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Request Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"WhatsApp integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update a WhatsApp messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Processing Request","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp":{"get":{"tags":["Conversations"],"summary":"Get a list of WhatsApp Integrations","description":"","operationId":"getConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsapp"},"post":{"tags":["Conversations"],"summary":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration","description":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.","operationId":"postConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsapp"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationParticipantCode","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantCode"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.cannot.disconnect.call":"The call for this request cannot be disconnected.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.hold.alerting":"An alerting call cannot be placed on hold","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","conversation.error.participant.attribute.null":"Cannot update participant attribute map to a null value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationParticipant"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationParticipantReplace"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/digits":{"post":{"tags":["Conversations"],"summary":"Sends DTMF to the participant","description":"","operationId":"postConversationParticipantDigits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digits","required":false,"schema":{"$ref":"#/definitions/Digits"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantDigits"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapupcodes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationParticipantCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackOnConversationCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.callback.already.being.routed":"A callback is already in the process of being routed on this conversation.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.queue.required":"Queue id is required for this request.","callback.error.scheduled.time.too.far.in.future":"The callback scheduled time cannot be more than 30 days into the future.","constraint.validation":"%s","conversation.error.cannot.callback.acd":"Cannot create a callback for an ACD participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.already.exists":"A callback is already scheduled on this conversation.","callback.error.target.communication.cannot.be.acd.or.ivr":"Target communication cannot belong to an acd or ivr participant.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationParticipantCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"The participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipantAttributes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapup"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified agent","description":"","operationId":"postConversationParticipantReplaceAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToAgentRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferAgent"]},"x-purecloud-method-name":"postConversationParticipantReplaceAgent"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified queue","description":"","operationId":"postConversationParticipantReplaceQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToQueueRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferQueue"]},"x-purecloud-method-name":"postConversationParticipantReplaceQueue"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the an external contact","description":"","operationId":"postConversationParticipantReplaceExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToExternalRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferExternal"]},"x-purecloud-method-name":"postConversationParticipantReplaceExternal"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason":{"put":{"tags":["Conversations"],"summary":"Set flagged reason on conversation participant to indicate bad conversation quality.","description":"","operationId":"putConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was set successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationParticipantFlaggedreason"},"delete":{"tags":["Conversations"],"summary":"Remove flagged reason from conversation participant.","description":"","operationId":"deleteConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was removed successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantFlaggedreason"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}":{"get":{"tags":["Conversations"],"summary":"Fetch info on a secure session","description":"","operationId":"getConversationParticipantSecureivrsession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"secureSessionId","in":"path","description":"secure IVR session ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsession"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions":{"get":{"tags":["Conversations"],"summary":"Get a list of secure sessions for this participant.","description":"","operationId":"getConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSessionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsessions"},"post":{"tags":["Conversations"],"summary":"Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.","description":"","operationId":"postConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSecureSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantSecureivrsessions"}},"/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback":{"post":{"tags":["Conversations"],"summary":"Submit feedback for the summary.","description":"","operationId":"postConversationSummaryFeedback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"summaryId","in":"path","description":"Summary ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FeedbackAddRequest"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conversation.not.found":"Invalid conversationId supplied.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:summaryFeedback:add"]},"x-purecloud-method-name":"postConversationSummaryFeedback"}},"/api/v2/integrations/credentials/{credentialId}":{"get":{"tags":["Integrations"],"summary":"Get a single credential with sensitive fields redacted","description":"","operationId":"getIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredential"},"put":{"tags":["Integrations"],"summary":"Update a set of credentials","description":"","operationId":"putIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationsCredential"},"delete":{"tags":["Integrations"],"summary":"Delete a set of credentials","description":"","operationId":"deleteIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegrationsCredential"}},"/api/v2/integrations/credentials/types":{"get":{"tags":["Integrations"],"summary":"List all credential types","description":"","operationId":"getIntegrationsCredentialsTypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialTypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentialsTypes"}},"/api/v2/integrations/credentials":{"get":{"tags":["Integrations"],"summary":"List multiple sets of credentials","description":"","operationId":"getIntegrationsCredentials","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfoListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentials"},"post":{"tags":["Integrations"],"summary":"Create a set of credentials","description":"","operationId":"postIntegrationsCredentials","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsCredentials"}},"/api/v2/uploads/learning/coverart":{"post":{"tags":["Uploads"],"summary":"Generates pre-signed URL to upload cover art for learning modules","description":"","operationId":"postUploadsLearningCoverart","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/LearningCoverArtUploadUrlRequest"}}],"responses":{"200":{"description":"Pre-signed urls successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:coverart:upload"]},"x-purecloud-method-name":"postUploadsLearningCoverart"}},"/api/v2/uploads/workforcemanagement/historicaldata/csv":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in csv format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataCsv","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataCsv"}},"/api/v2/uploads/publicassets/images":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a public asset image","description":"","operationId":"postUploadsPublicassetsImages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["uploads:publicasset:upload"]},"x-purecloud-method-name":"postUploadsPublicassetsImages"}},"/api/v2/uploads/recordings":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a recording file","description":"","operationId":"postUploadsRecordings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:upload"]},"x-purecloud-method-name":"postUploadsRecordings"}},"/api/v2/dataextensions/coretypes/{coretypeName}":{"get":{"tags":["Data Extensions"],"summary":"Get a specific named core type.","description":"","operationId":"getDataextensionsCoretype","produces":["application/json"],"parameters":[{"name":"coretypeName","in":"path","description":"The core type's name","required":true,"type":"string","enum":["text","longtext","url","identifier","enum","date","datetime","integer","number","checkbox","tag"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Coretype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretype"}},"/api/v2/dataextensions/coretypes":{"get":{"tags":["Data Extensions"],"summary":"Get the core types from which all schemas are built.","description":"","operationId":"getDataextensionsCoretypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoretypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretypes"}},"/api/v2/dataextensions/limits":{"get":{"tags":["Data Extensions"],"summary":"Get quantitative limits on schemas","description":"","operationId":"getDataextensionsLimits","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaQuantityLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsLimits"}},"/api/v2/flows/datatables/divisionviews/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatablesDivisionview","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionview"}},"/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an export job","description":"Returns the state information about an export job.","operationId":"getFlowsDatatableExportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"id of export job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableExportJob"}},"/api/v2/flows/datatables/{datatableId}/export/jobs":{"post":{"tags":["Architect"],"summary":"Begin an export process for exporting all rows from a datatable","description":"Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response","operationId":"postFlowsDatatableExportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"postFlowsDatatableExportJobs"}},"/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an import job","description":"Returns the state information about an import job.","operationId":"getFlowsDatatableImportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"id of import job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJob"}},"/api/v2/flows/datatables/{datatableId}/import/jobs":{"get":{"tags":["Architect"],"summary":"Get all recent import jobs","description":"Get all recent import jobs","operationId":"getFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The specified datatableId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJobs"},"post":{"tags":["Architect"],"summary":"Begin an import process for importing rows into a datatable","description":"Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response","operationId":"postFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"body","description":"import job information","required":true,"schema":{"$ref":"#/definitions/DataTableImportJob"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableImportJobs"}},"/api/v2/flows/datatables/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatable"},"put":{"tags":["Architect"],"summary":"Updates a specific datatable by id","description":"Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","operationId":"putFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.cannot.remove.fields":"The updated schema had missing fields from the old schema (can't remove previously existing fields).","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatable"},"delete":{"tags":["Architect"],"summary":"deletes a specific datatable by id","description":"Deletes an entire datatable (including the schema and data) with a given datatableId","operationId":"deleteFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"force","in":"query","description":"force delete, even if in use","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"The datatable was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.possibly.in.use":"This datatable may be in use by a published flow.","flows.datatables.in.use":"This datatable is in use by a published flow."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatable"}},"/api/v2/flows/datatables/divisionviews":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatablesDivisionviews","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionviews"}},"/api/v2/flows/datatables":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatables","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatables"},"post":{"tags":["Architect"],"summary":"Create a new datatable with the specified json-schema definition","description":"This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/","operationId":"postFlowsDatatables","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","flows.datatables.too.many.tables":"The max number of datatables allowed has been reached.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatables"}},"/api/v2/flows/datatables/{datatableId}/rows/{rowId}":{"get":{"tags":["Architect"],"summary":"Returns a specific row for the datatable","description":"Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.","operationId":"getFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"The key for the row","required":true,"type":"string"},{"name":"showbrief","in":"query","description":"if true returns just the key field for the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRow"},"put":{"tags":["Architect"],"summary":"Update a row entry","description":"Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}","operationId":"putFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"},{"in":"body","name":"body","description":"datatable row","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:edit"]},"x-purecloud-method-name":"putFlowsDatatableRow"},"delete":{"tags":["Architect"],"summary":"Delete a row entry","description":"Deletes a row with a given rowId (the value of the key field).","operationId":"deleteFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"}],"responses":{"204":{"description":"The row was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete","architect:datatableRow:delete"]},"x-purecloud-method-name":"deleteFlowsDatatableRow"}},"/api/v2/flows/datatables/{datatableId}/rows":{"get":{"tags":["Architect"],"summary":"Returns the rows for the datatable with the given id","description":"Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.","operationId":"getFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showbrief","in":"query","description":"If true returns just the key value of the row","required":false,"type":"boolean","default":true},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableRowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRows"},"post":{"tags":["Architect"],"summary":"Create a new row entry for the datatable.","description":"Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}","operationId":"postFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"dataTableRow","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.too.many.rows":"The max number of datatable rows allowed has been reached.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableRows"}},"/api/v2/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDate"}},"/api/v2/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putOutboundCampaignAgent","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":true,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.stage":"No stage was provided.","invalid.campaign.status":"The dialer campaign was not active.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-purecloud-method-name":"putOutboundCampaignAgent"}},"/api/v2/outbound/attemptlimits/{attemptLimitsId}":{"get":{"tags":["Outbound"],"summary":"Get attempt limits","description":"","operationId":"getOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimit"},"put":{"tags":["Outbound"],"summary":"Update attempt limits","description":"","operationId":"putOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts allowed per contact is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts allowed per number is 100.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:edit"]},"x-purecloud-method-name":"putOutboundAttemptlimit"},"delete":{"tags":["Outbound"],"summary":"Delete attempt limits","description":"","operationId":"deleteOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:delete"]},"x-purecloud-method-name":"deleteOutboundAttemptlimit"}},"/api/v2/outbound/attemptlimits":{"get":{"tags":["Outbound"],"summary":"Query attempt limits list","description":"","operationId":"getOutboundAttemptlimits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimits"},"post":{"tags":["Outbound"],"summary":"Create attempt limits","description":"","operationId":"postOutboundAttemptlimits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts per contact limit is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts per number limit is 100.","constraint.validation":"%s","max.entity.count.reached":"The maximum attempt limits count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:add"]},"x-purecloud-method-name":"postOutboundAttemptlimits"}},"/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponseset"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.call.analysis.response.set":"The call analysis response set is invalid.","constraint.validation":"%s","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:edit"]},"x-purecloud-method-name":"putOutboundCallanalysisresponseset"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallanalysisresponseset"}},"/api/v2/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum call analysis response set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:add"]},"x-purecloud-method-name":"postOutboundCallanalysisresponsesets"}},"/api/v2/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimeset"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:edit"]},"x-purecloud-method-name":"putOutboundCallabletimeset"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","callable.time.set.in.use":"The callable time set is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallabletimeset"}},"/api/v2/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getOutboundCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postOutboundCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.time.zone":"There is an unrecognized time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum callable time set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:add"]},"x-purecloud-method-name":"postOutboundCallabletimesets"}},"/api/v2/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign (Deprecated)","description":"This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"","operationId":"postOutboundCampaignCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":true,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.cannot.be.blank":"The contact cannot be blank.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"The contact list cannot be blank.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","schedule.cannot.be.blank":"The schedule cannot be blank.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.schedule.format":"The schedule format is invalid.","callback.schedule.invalid":"The callback schedule is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.scheduling.error":""}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"deprecated":true,"x-purecloud-method-name":"postOutboundCampaignCallbackSchedule"}},"/api/v2/outbound/campaigns/divisionviews/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Campaign information object","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionview"}},"/api/v2/outbound/campaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Campaign information objects","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionviews"}},"/api/v2/outbound/campaigns/{campaignId}/interactions":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign interactions.","description":"","operationId":"getOutboundCampaignInteractions","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignInteractions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The specified campaignId was not found.","resource.not.found":"Resource not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignInteractions"}},"/api/v2/outbound/campaigns/{campaignId}/linedistribution":{"get":{"tags":["Outbound"],"summary":"Get line distribution information for campaigns using same Edge Group or Site as given campaign","description":"","operationId":"getOutboundCampaignLinedistribution","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"includeOnlyActiveCampaigns","in":"query","description":"If true will return only active Campaigns","required":false,"type":"boolean","default":true},{"name":"edgeGroupId","in":"query","description":"Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"siteId","in":"query","description":"Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"useWeight","in":"query","description":"Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations","required":false,"type":"boolean"},{"name":"relativeWeight","in":"query","description":"Relative weight to be used in line distribution calculations instead of current Campaign's relative weight","required":false,"type":"integer","format":"int32"},{"name":"outboundLineCount","in":"query","description":"The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignOutboundLinesDistribution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.campaign.outbound.line.count":"The outbound line count is invalid","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.campaign":"The campaign is invalid","site.has.no.active.edges":"There are no active edges in the site","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","edge.group.not.found":"The edge group could not be found","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","no.edge.group.for.site":"No edge group was found for the site","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:lineDistribution:view"]},"x-purecloud-method-name":"getOutboundCampaignLinedistribution"}},"/api/v2/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"deleteOutboundCampaignProgress"}},"/api/v2/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaign"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.update":"","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","resources.in.use":"Resources are already in use.","cannot.update.dynamic.contact.queueing.settings":"The dynamic contact queueing settings cannot be updated","invalid.update.bad.status.transition":"The status transition is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","agent.owned.column.cannot.be.changed":"The agent owned column cannot be changed.","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","invalid.update.campaign.active":"The campaign is already active","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","agent.owned.queue.cannot.be.changed":"The queue cannot be changed on a campaign configured for agent owned records.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.ani.address":"The caller id number is invalid.","name.required":"A name must be provided.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"Invalid dialing mode","site.is.empty":"There are no edges in the site","contact.list.import.in.progress":"The contact list on the camapign is still importing contacts."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","all.campaigns.black.listed":"This organization has been blacklisted from starting campaigns. Please contact support.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","campaign.black.listed":"This campaign has been blacklisted. Please contact support."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.campaign.active":"The campaign is already active.","too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"putOutboundCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","campaign.in.use":"The campaign is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundCampaign"}},"/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results":{"get":{"tags":["Outbound"],"summary":"Get a preview of how agents will be mapped to this campaign's contact list.","description":"","operationId":"getOutboundCampaignAgentownedmappingpreviewResults","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentOwnedMappingPreviewListing"}},"202":{"description":"The preview is not yet ready"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.is.not.agent.owned":"This campaign is not configured for agent-owned records.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The preview does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","routing:queue:view"]},"x-purecloud-method-name":"getOutboundCampaignAgentownedmappingpreviewResults"}},"/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview":{"post":{"tags":["Outbound"],"summary":"Initiate request for a preview of how agents will be mapped to this campaign's contact list.","description":"","operationId":"postOutboundCampaignAgentownedmappingpreview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.is.not.agent.owned":"This campaign is not configured for agent-owned records.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","directory:user:view"]},"x-purecloud-method-name":"postOutboundCampaignAgentownedmappingpreview"}},"/api/v2/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getOutboundCampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignDiagnostics"}},"/api/v2/outbound/campaignrules/{campaignRuleId}":{"get":{"tags":["Outbound"],"summary":"Get Campaign Rule","description":"","operationId":"getOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrule"},"put":{"tags":["Outbound"],"summary":"Update Campaign Rule","description":"","operationId":"putOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"Campaign rule must have an action entity.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","cannot.modify.enabled.campaign.rule":"Cannot modify a rule that is enabled.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:edit"]},"x-purecloud-method-name":"putOutboundCampaignrule"},"delete":{"tags":["Outbound"],"summary":"Delete Campaign Rule","description":"","operationId":"deleteOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","cannot.delete.enabled.campaign.rule":"Cannot delete a rule that is enabled."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:delete"]},"x-purecloud-method-name":"deleteOutboundCampaignrule"}},"/api/v2/outbound/campaignrules":{"get":{"tags":["Outbound"],"summary":"Query Campaign Rule list","description":"","operationId":"getOutboundCampaignrules","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRuleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrules"},"post":{"tags":["Outbound"],"summary":"Create Campaign Rule","description":"","operationId":"postOutboundCampaignrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","cannot.create.enabled.campaign.rule":"Cannot create a rule that is enabled.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","invalid.turn.on.campaign.action":"Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"At least one rule action entity is required.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","max.entity.count.reached":"The maximum campaign rule count has been reached.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.dialing.mode.update":"Invalid dialing mode specified.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:add"]},"x-purecloud-method-name":"postOutboundCampaignrules"}},"/api/v2/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaign"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":true,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesCampaign"}},"/api/v2/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getOutboundSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaigns"}},"/api/v2/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getOutboundCampaignStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignStats"}},"/api/v2/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postOutboundCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"postOutboundCampaignsProgress"}},"/api/v2/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getOutboundCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListIds","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 campaigns can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postOutboundCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.agent.owned.dialing.mode":"Agent owned records are only available for the Preview dialing mode.","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"Property is not allowed for external calling","max.entity.count.reached":"The maximum campaign count has been reached.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","invalid.create":"","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.ani.address":"The caller id number is invalid.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"A campaign may not be updated to or from external dialing mode to any other dialing mode.","site.is.empty":"There are no edges in the site"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:add"]},"x-purecloud-method-name":"postOutboundCampaigns"}},"/api/v2/outbound/campaigns/all/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns","description":"","operationId":"getOutboundCampaignsAllDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:search","outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsAllDivisionviews"}},"/api/v2/outbound/campaigns/all":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns by division","description":"","operationId":"getOutboundCampaignsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view","outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundCampaignsAll"}},"/api/v2/outbound/contactlists/divisionviews/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic ContactList information object","description":"This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contactlist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionview"}},"/api/v2/outbound/contactlists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified contact list objects.","description":"This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionviews"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","no.available.list.export.uri":"There is no available download URI for contact list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Export information to get","required":false,"schema":{"$ref":"#/definitions/ContactsExportRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.export.in.progress":"An export is already in progress for this contact list.","internal.error":"An internal service error occurred.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.contact.list.filter":"The contact list filter provided is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","contact.list.import.in.progress":"The contact list cannot be exported while it is being imported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"postOutboundContactlistExport"}},"/api/v2/outbound/contactlistfilters/preview":{"post":{"tags":["Outbound"],"summary":"Get a preview of the output of a contact list filter","description":"","operationId":"postOutboundContactlistfiltersPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FilterPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersPreview"}},"/api/v2/outbound/contactlistfilters/{contactListFilterId}":{"get":{"tags":["Outbound"],"summary":"Get Contact list filter","description":"","operationId":"getOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilter"},"put":{"tags":["Outbound"],"summary":"Update Contact List Filter","description":"","operationId":"putOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not update the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","filter.modification.in.progress":"Could not update the contact list filter because filter modification is in progress.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","cannot.edit.contact.list.filter.source.type":"Could not update the contact list filter because the source type can not be edited.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not update the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not update the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not update the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.predicates.exceeded":"Could not update the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not update the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:edit"]},"x-purecloud-method-name":"putOutboundContactlistfilter"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Filter","description":"","operationId":"deleteOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list filter deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistfilter"}},"/api/v2/outbound/contactlistfilters/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Retrieve multiple contact list filters","description":"","operationId":"postOutboundContactlistfiltersBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The contact list filters to retrieve","required":true,"schema":{"$ref":"#/definitions/ContactListFilterBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No body with contact list filter ids was provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersBulkRetrieve"}},"/api/v2/outbound/contactlistfilters":{"get":{"tags":["Outbound"],"summary":"Query Contact list filters","description":"","operationId":"getOutboundContactlistfilters","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilters"},"post":{"tags":["Outbound"],"summary":"Create Contact List Filter","description":"","operationId":"postOutboundContactlistfilters","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not create the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not create the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not create the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not create the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.entity.count.reached":"The maximum contact list filter count has been reached.","max.predicates.exceeded":"Could not create the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not create the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:add"]},"x-purecloud-method-name":"postOutboundContactlistfilters"}},"/api/v2/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getOutboundContactlistImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistImportstatus"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","description":"","operationId":"getOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlist"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain one or more of the specified phone number columns","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns can not be updated.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns can not be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain one or more of the specified email addresses columns","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns are not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names can not be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:edit"]},"x-purecloud-method-name":"putOutboundContactlist"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","internal.error":"An internal server error occurred.","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","contact.list.import.in.progress":"The contact list import is in progress.","contact.list.in.use":"The contact list is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlist"}},"/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview":{"get":{"tags":["Outbound"],"summary":"Preview the result of applying Automatic Time Zone Mapping to a contact list","description":"","operationId":"getOutboundContactlistTimezonemappingpreview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneMappingPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.automatic.time.zone.mapping":"This contact list is not set up for Automatic Time Zone Mapping","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The contact list could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistTimezonemappingpreview"}},"/api/v2/outbound/contactlisttemplates/{contactListTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Contact List Template","description":"","operationId":"getOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplate"},"put":{"tags":["Outbound"],"summary":"Update a contact list template.","description":"","operationId":"putOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns cannot be updated.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","contact.list.template.email.columns.not.supported":"Contact list template email columns are not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns cannot be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names cannot be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:edit"]},"x-purecloud-method-name":"putOutboundContactlisttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Template","description":"","operationId":"deleteOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplate"}},"/api/v2/outbound/contactlisttemplates":{"get":{"tags":["Outbound"],"summary":"Query a list of contact list templates","description":"","operationId":"getOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplates"},"post":{"tags":["Outbound"],"summary":"Create Contact List Template","description":"","operationId":"postOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","constraint.validation":"%s","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.list.template.email.columns.not.supported":"Contact list template email columns not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","max.entity.count.reached":"The maximum contact list template count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact list templates.","description":"","operationId":"deleteOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact list templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact list templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplates"}},"/api/v2/outbound/contactlisttemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ContactListTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contact.list.templates.added":"The number of contact list templates being added exceeds the limit","bad.request":"No contact list templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkAdd"}},"/api/v2/outbound/contactlisttemplates/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Get multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list templates to get","required":true,"schema":{"$ref":"#/definitions/ContactListTemplateBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No contact list template ids were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkRetrieve"}},"/api/v2/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getOutboundContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postOutboundContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain phone number column","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","division.not.found":"The division could not be found.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"The contact email columns are invalid.","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain email column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","max.entity.count.reached":"The maximum contact list count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:add"]},"x-purecloud-method-name":"postOutboundContactlists"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact lists.","description":"","operationId":"deleteOutboundContactlists","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact lists accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact lists in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested contact lists could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlists"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get a contact.","description":"","operationId":"getOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"getOutboundContactlistContact"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"$ref":"#/definitions/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.missing.columns":"The contact is missing columns from its contact list.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.does.not.exist":"The contact does not exist.","constraint.validation":"%s","invalid.update":"An attempt was made to update a contact in an invalid way","invalid.contact.id":"An attempt was made to update a contact with an invalid contact ID","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"putOutboundContactlistContact"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.in.use":"The contact cannot be deleted because it is currently in use.","invalid.delete":"An attempt was made to delete a contact in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","contact.not.found":"The contact could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContact"}},"/api/v2/outbound/contactlists/{contactListId}/clear":{"post":{"tags":["Outbound"],"summary":"Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.","description":"","operationId":"postOutboundContactlistClear","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contacts will be deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.is.on.running.campaign":"The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.import.in.progress":"The contacts cannot be removed from a contactlist that is currently in progress of an import.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistClear"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update":{"post":{"tags":["Outbound"],"summary":"Start an async job to bulk edit contacts.","description":"","operationId":"postOutboundContactlistContactsBulkUpdate","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact bulk edit request information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkEditRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts edit has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkUpdate"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk":{"post":{"tags":["Outbound"],"summary":"Get contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsBulk","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactIds to get.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.requested":"Only 50 contacts can be retrieved at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulk"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove":{"post":{"tags":["Outbound"],"summary":"Start an async job to delete contacts using a filter.","description":"","operationId":"postOutboundContactlistContactsBulkRemove","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact filter information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkSearchParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts deletion has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkRemove"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/search":{"post":{"tags":["Outbound"],"summary":"Query contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsSearch","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact search parameters.","required":true,"schema":{"$ref":"#/definitions/ContactListingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsSearch"}},"/api/v2/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableDialerContact"}}},{"name":"priority","in":"query","description":"Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.","required":false,"type":"boolean"},{"name":"clearSystemData","in":"query","description":"Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.","required":false,"type":"boolean"},{"name":"doNotQueue","in":"query","description":"Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"Too many contacts added, the limit is 1000 per request","uploads.black.listed":"This organization has been prohibited from uploading contacts. Please contact support.","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.columns":"The contact columns are invalid.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create contacts in an invalid way","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"An attempt was made to update contacts in an invalid way","invalid.contact.id":"The custom contactId field is not valid. It cannot contain special characters.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contacts.per.org.limit.exceeded":"The organization has reached the limit on total contacts","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal service error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:add"]},"x-purecloud-method-name":"postOutboundContactlistContacts"},"delete":{"tags":["Outbound"],"summary":"Delete contacts from a contact list.","description":"","operationId":"deleteOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactIds","in":"query","description":"ContactIds to delete.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Contacts Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"There were too many contacts in the request, the limit is 250","invalid.contact.id":"One or more of the contacts was invalidly formed with non UTF-8 characters.","invalid.delete":"An attempt was made to delete contacts in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","no.contacts.specified":"There were no contacts specified in the request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContacts"}},"/api/v2/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer. (Deprecated)","description":"This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use \"/api/v2/audits/query\" instead.","operationId":"postOutboundAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":true,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:audit:view"]},"x-purecloud-method-name":"postOutboundAudits"}},"/api/v2/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postOutboundConversationDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundConversationDnc"}},"/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns":{"delete":{"tags":["Outbound"],"summary":"Deletes all or expired custom exclusion column entries from a DNC list.","description":"This operation is only for Internal DNC lists of custom exclusion column entries","operationId":"deleteOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC custom exclusion column entries deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"Custom exclusion column entries cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal custom","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistCustomexclusioncolumns"},"patch":{"tags":["Outbound"],"summary":"Add entries to or delete entries from a DNC list.","description":"Only Internal DNC lists may be deleted from","operationId":"patchOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Custom exclusion column entries","required":true,"schema":{"$ref":"#/definitions/DncPatchCustomExclusionColumnsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add to or delete from a DNC list that is not of type Rds-custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Custom exclusion column entries must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC entries. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistCustomexclusioncolumns"}},"/api/v2/outbound/dnclists/divisionviews/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic DncList information object","description":"This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionview","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"Dnclist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionview"}},"/api/v2/outbound/dnclists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified dnc list objects.","description":"This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 dnc lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionviews"}},"/api/v2/outbound/dnclists/{dncListId}/emailaddresses":{"post":{"tags":["Outbound"],"summary":"Add email addresses to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC email addresses","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Accepted - Adding email addresses"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append emails to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistEmailaddresses"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired email addresses from a DNC list.","description":"This operation is Only for Internal DNC lists of email addresses","operationId":"deleteOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC email addresses deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The email addresses cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete emails from a DNC list that is not of Contact Method Email"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistEmailaddresses"},"patch":{"tags":["Outbound"],"summary":"Add emails to or Delete emails from a DNC list.","description":"Only Internal DNC lists may be added to or deleted from","operationId":"patchOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Emails","required":true,"schema":{"$ref":"#/definitions/DncPatchEmailsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add emails addresses to or delete email addresses from a DNC list that is not of type rds_custom\"","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Email addresses must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add emails to or delete emails from a DNC list that is not of Contact Method Email","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistEmailaddresses"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","no.available.list.export.uri":"There is no available download URI for the dnc list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The dnc list cannot be exported while it is being imported.","unexportable.dnc.list.type":"Only internal dnc lists can be exported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.export.in.progress":"An export is already in progress for this dnc list.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dnc list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"postOutboundDnclistExport"}},"/api/v2/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getOutboundDnclistImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistImportstatus"}},"/api/v2/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"expirationDateTime","in":"query","description":"Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append numbers to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","dnc.phone.numbers.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.phone.numbers.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistPhonenumbers"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired phone numbers from a DNC list.","description":"This operation is Only for Internal DNC lists of phone numbers","operationId":"deleteOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC phone numbers deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The phone numbers cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete numbers from a DNC list that is not of Contact Method Phone"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistPhonenumbers"},"patch":{"tags":["Outbound"],"summary":"Add numbers to or delete numbers from a DNC list.","description":"Only Internal DNC lists may be added to deleted from","operationId":"patchOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"$ref":"#/definitions/DncPatchPhoneNumbersRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of type rds_custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Phone numbers must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of Contact Method Phone","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistPhonenumbers"}},"/api/v2/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclist"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","cannot.update.dnc.list.type":"The Dnc source cannot be updated.","cannot.update.custom.exclusion.column":"The dnc custom exclusion column cannot be updated.","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:edit"]},"x-purecloud-method-name":"putOutboundDnclist"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.in.use":"The dialer DNC list is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:delete"]},"x-purecloud-method-name":"deleteOutboundDnclist"}},"/api/v2/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getOutboundDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postOutboundDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncListCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","dnc.list.missing.custom.exclusion.column":"A custom exclusion column must be provided for this list type.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","max.entity.count.reached":"The maximum dnc list count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:add"]},"x-purecloud-method-name":"postOutboundDnclists"}},"/api/v2/outbound/events/{eventId}":{"get":{"tags":["Outbound"],"summary":"Get Dialer Event","description":"","operationId":"getOutboundEvent","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Log ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventLog"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvent"}},"/api/v2/outbound/events":{"get":{"tags":["Outbound"],"summary":"Query Event Logs","description":"","operationId":"getOutboundEvents","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"category","in":"query","description":"Category","required":false,"type":"string"},{"name":"level","in":"query","description":"Level","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvents"}},"/api/v2/outbound/filespecificationtemplates/bulk":{"delete":{"tags":["Outbound"],"summary":"Delete multiple file specification templates.","description":"","operationId":"deleteOutboundFilespecificationtemplatesBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"File Specification template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"File specification templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many file specification templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested file specification templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplatesBulk"}},"/api/v2/outbound/filespecificationtemplates":{"get":{"tags":["Outbound"],"summary":"Query File Specification Templates","description":"","operationId":"getOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplates"},"post":{"tags":["Outbound"],"summary":"Create File Specification Template","description":"","operationId":"postOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:add"]},"x-purecloud-method-name":"postOutboundFilespecificationtemplates"}},"/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get File Specification Template","description":"","operationId":"getOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplate"},"put":{"tags":["Outbound"],"summary":"Update File Specification Template","description":"","operationId":"putOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"fileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:edit"]},"x-purecloud-method-name":"putOutboundFilespecificationtemplate"},"delete":{"tags":["Outbound"],"summary":"Delete File Specification Template","description":"","operationId":"deleteOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"File Specification template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplate"}},"/api/v2/outbound/importtemplates/{importTemplateId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get the import status for an import template.","description":"","operationId":"getOutboundImporttemplateImportstatus","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"importTemplateId","required":true,"type":"string"},{"name":"listNamePrefix","in":"query","description":"listNamePrefix","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplateImportstatus"}},"/api/v2/outbound/importtemplates/{importTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Import Template","description":"","operationId":"getOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplate"},"put":{"tags":["Outbound"],"summary":"Update Import Template","description":"","operationId":"putOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"importTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:edit"]},"x-purecloud-method-name":"putOutboundImporttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Import Template","description":"","operationId":"deleteOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","import.template.in.use":"The import template is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplate"}},"/api/v2/outbound/importtemplates":{"get":{"tags":["Outbound"],"summary":"Query Import Templates","description":"","operationId":"getOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListTemplateId","in":"query","description":"Contact List Template ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplates"},"post":{"tags":["Outbound"],"summary":"Create Import Template","description":"","operationId":"postOutboundImporttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ImportTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","max.entity.count.reached":"The maximum import template count has been reached.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple import templates.","description":"","operationId":"deleteOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"import template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Import templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many import templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.import.template":"Not all the requested import templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplates"}},"/api/v2/outbound/importtemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple import templates","description":"","operationId":"postOutboundImporttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"import template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImportTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.import.templates.added":"The number of import templates being added exceeds the limit","bad.request":"No import templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplatesBulkAdd"}},"/api/v2/outbound/messagingcampaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of messaging campaigns","description":"","operationId":"postOutboundMessagingcampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"postOutboundMessagingcampaignsProgress"}},"/api/v2/outbound/settings":{"get":{"tags":["Outbound"],"summary":"Get the outbound settings for this organization","description":"","operationId":"getOutboundSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:view"]},"x-purecloud-method-name":"getOutboundSettings"},"patch":{"tags":["Outbound"],"summary":"Update the outbound settings for this organization","description":"","operationId":"patchOutboundSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outboundSettings","required":true,"schema":{"$ref":"#/definitions/OutboundSettings"}}],"responses":{"204":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.callable.window.stop.time":"Latest callable time must not be later than 21:00","invalid.country.code":"Invalid country country provided for atzm supportedCountries","invalid.callable.window":"Earliest callable time must be before Latest callable time and only one callable time window is allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.max.calls.per.agent":"Max calls per agent must be between values 1 and 15.","missing.time.zone":"Time zone must be provided for unmapped call window","invalid.time.zone":"Invalid time zone for unmapped call window","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.abandon.seconds":"Abandon seconds must be between 1 and 300.","constraint.validation":"%s","invalid.callable.window.start.time":"Earliest callable time must not be earlier than 08:00","invalid.update":"An attempt was made to update the outbound settings in an invalid way","invalid.max.line.utilization":"Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"outbound settings version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:edit"]},"x-purecloud-method-name":"patchOutboundSettings"}},"/api/v2/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRuleset"},"put":{"tags":["Outbound"],"summary":"Update a Rule Set.","description":"","operationId":"putOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","invalid.update":"","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:edit"]},"x-purecloud-method-name":"putOutboundRuleset"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule Set.","description":"","operationId":"deleteOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:delete"]},"x-purecloud-method-name":"deleteOutboundRuleset"}},"/api/v2/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getOutboundRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Rule Set.","description":"","operationId":"postOutboundRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","max.entity.count.reached":"The maximum rule set count has been reached.","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:add"]},"x-purecloud-method-name":"postOutboundRulesets"}},"/api/v2/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequence"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","campaign.sequence.cannot.change.both.status.and.campaigns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","invalid.property":"Value [%s] is not a valid property for object [%s]","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","constraint.validation":"%s","invalid.update":"","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.update.bad.status.transition":"The status transition is invalid and failed to update.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:edit"]},"x-purecloud-method-name":"putOutboundSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.in.use":"The campaign sequence is already in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:delete"]},"x-purecloud-method-name":"deleteOutboundSequence"}},"/api/v2/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequence"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":true,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"The sequence schedule version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesSequence"}},"/api/v2/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getOutboundSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequences"}},"/api/v2/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getOutboundSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postOutboundSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.create":"","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing a campaign.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum campaign sequence count has been reached.","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:add"]},"x-purecloud-method-name":"postOutboundSequences"}},"/api/v2/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getOutboundWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:view"]},"x-purecloud-method-name":"getOutboundWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putOutboundWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":true,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a wrap up code mapping in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"Wrap up code mapping version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:edit"]},"x-purecloud-method-name":"putOutboundWrapupcodemappings"}},"/api/v2/outbound/digitalrulesets/{digitalRuleSetId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Digital Rule Set","description":"","operationId":"getOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalruleset"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Digital Rule Set","description":"","operationId":"putOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.update":"An attempt was made to update a digital rule set in an invalid way. See details","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected digital rule set version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:edit"]},"x-purecloud-method-name":"putOutboundDigitalruleset"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Digital Rule Set","description":"","operationId":"deleteOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"204":{"description":"Digital Rule Set Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a digital rule set in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:delete"]},"x-purecloud-method-name":"deleteOutboundDigitalruleset"}},"/api/v2/outbound/digitalrulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Outbound Digital Rule Sets","description":"","operationId":"getOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["name"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of digital rule set ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalrulesets"},"post":{"tags":["Outbound"],"summary":"Create an Outbound Digital Rule Set","description":"","operationId":"postOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to update a digital rule set in an invalid way. See details","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:add"]},"x-purecloud-method-name":"postOutboundDigitalrulesets"}},"/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Messaging Campaign information object","description":"This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionview"}},"/api/v2/outbound/messagingcampaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Messaging Campaign information objects","description":"This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionviews"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Messaging Campaign","description":"","operationId":"getOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Messaging Campaign","description":"","operationId":"putOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","too.many.messages.per.minute.with.data.actions.requested":"The total number of messages per minute for this organization and campaign with data actions would be exceeded by turning this campaign on (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.update":"An attempt was made to update a messaging campaign in an invalid way. See details","cannot.update.campaign.type":"The campaign type cannot be updated to a different type configuration","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions has been exceeded. See details","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","simultaneous.field.and.status.update":"A Messaging Campaign cannot have other fields changed in the same update as a status transition","invalid.status.transition":"The campaign status transition is invalid","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html","invalid.dnc.list":"One or more DNC List references are invalid","invalid.division":"A valid division must be provided","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","contact.list.in.use":"The contact list is in use by another messaging campaign","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","too.many.messages.per.minute.per.phone.number.requested":"The total number of messages per minute for this organization and phone number would be exceeded by turning this campaign on (see documentation)","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The Content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","another.campaign.starting":"There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The responseType of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.sms.content.template.contentType":"The content type of the content template must be 'text/plain'","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","sms.phone.number.in.use":"The SMS phone number is in use by another messaging campaign","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","too.many.messages.per.minute.requested":"The total number of messages per minute for this organization and campaign type would be exceeded by turning this campaign on (see documentation)","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"User doesn't have authorization to access content template","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [emailConfig, smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected messaging campaign version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit","outbound:emailCampaign:edit"]},"x-purecloud-method-name":"putOutboundMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Messaging Campaign","description":"","operationId":"deleteOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"204":{"description":"Messaging Campaign Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a messaging campaign in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.running.campaign":"A messaging campaign in status ON or STOPPING cannot be deleted"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:delete","outbound:emailCampaign:delete"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaign"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign's progress","description":"","operationId":"getOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset messaging campaign progress and recycle the messaging campaign","description":"","operationId":"deleteOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Accepted - the messaging campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit","outbound:emailCampaign:edit"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaignProgress"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign diagnostics","description":"","operationId":"getOutboundMessagingcampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignDiagnostics"}},"/api/v2/outbound/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of Messaging Campaigns","description":"","operationId":"getOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["campaignStatus","name","type"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of messaging campaign ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaigns"},"post":{"tags":["Outbound"],"summary":"Create a Messaging Campaign","description":"","operationId":"postOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.sms.content.template.contenttype":"The content type of the content template must be 'text/plain'","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html'","invalid.dnc.list":"One or more DNC List references are invalid","max.entity.count.reached":"The maximum messaging campaign count has been reached","invalid.division":"A valid division must be provided","email.from.address.domain.not.verified":"The from address domain must have a cname verification result of 'VERIFIED'","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create an invalid messaging campaign. See details","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The response type of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:add","outbound:emailCampaign:add"]},"x-purecloud-method-name":"postOutboundMessagingcampaigns"}},"/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an email campaign schedule.","description":"","operationId":"getOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaign"},"put":{"tags":["Outbound"],"summary":"Update an email campaign schedule.","description":"","operationId":"putOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EmailCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/EmailCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the email campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the email campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of a schedule must be 'emailcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesEmailcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an email campaign schedule.","description":"","operationId":"deleteOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesEmailcampaign"}},"/api/v2/outbound/schedules/emailcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of email campaign schedules.","description":"","operationId":"getOutboundSchedulesEmailcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaigns"}},"/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a messaging campaign schedule.","description":"","operationId":"getOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update a new messaging campaign schedule.","description":"","operationId":"putOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the messaging campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the messaging campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of the schedule must be 'messagingcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a messaging campaign schedule.","description":"","operationId":"deleteOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesMessagingcampaign"}},"/api/v2/outbound/schedules/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of messaging campaign schedules.","description":"","operationId":"getOutboundSchedulesMessagingcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaigns"}},"/api/v2/mobiledevices/{deviceId}":{"get":{"tags":["Mobile Devices"],"summary":"Get device","description":"","operationId":"getMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a device with that deviceId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevice"},"put":{"tags":["Mobile Devices"],"summary":"Update device","description":"","operationId":"putMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Device","required":false,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"putMobiledevice"},"delete":{"tags":["Mobile Devices"],"summary":"Delete device","description":"","operationId":"deleteMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"deleteMobiledevice"}},"/api/v2/mobiledevices":{"get":{"tags":["Mobile Devices"],"summary":"Get a list of all devices.","description":"","operationId":"getMobiledevices","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DirectoryUserDevicesListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevices"},"post":{"tags":["Mobile Devices"],"summary":"Create User device","description":"","operationId":"postMobiledevices","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Device","required":true,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"postMobiledevices"}},"/api/v2/fieldconfig":{"get":{"tags":["Users","Groups","Organization"],"summary":"Fetch field config for an entity type","description":"","operationId":"getFieldconfig","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Field type","required":true,"type":"string","enum":["person","group","org","externalContact"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FieldConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.entity.type":"The entity type is invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getFieldconfig"}},"/api/v2/groups/{groupId}/individuals":{"get":{"tags":["Groups"],"summary":"Get all individuals associated with the group","description":"","operationId":"getGroupIndividuals","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupIndividuals"}},"/api/v2/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members, includes individuals, owners, and dynamically included people","description":"","operationId":"getGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":true,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.resource.not.found":"Group members were not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict updating members."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"deleteGroupMembers"}},"/api/v2/groups/{groupId}/profile":{"get":{"tags":["Groups"],"summary":"Get group profile","description":"This api is deprecated. Use /api/v2/groups instead","operationId":"getGroupProfile","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the group profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getGroupProfile"}},"/api/v2/profiles/groups":{"get":{"tags":["Groups"],"summary":"Get group profile listing","description":"This api is deprecated. Use /api/v2/groups instead.","operationId":"getProfilesGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesGroups"}},"/api/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a group with that groupId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroup"},"put":{"tags":["Groups"],"summary":"Update group","description":"","operationId":"putGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Group","required":false,"schema":{"$ref":"#/definitions/GroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a tab configuration due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict - Unexpected version was provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroup"},"delete":{"tags":["Groups"],"summary":"Delete group","description":"","operationId":"deleteGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","group.name.in.use":"This group name is currently in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified group not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroup"}},"/api/v2/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group","required":true,"schema":{"$ref":"#/definitions/GroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add"]},"x-purecloud-method-name":"postGroups"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search groups using the q64 value returned from a previous search","description":"","operationId":"getGroupsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupsSearch"},"post":{"tags":["Groups","Search"],"summary":"Search groups","description":"","operationId":"postGroupsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupsSearch"}},"/api/v2/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})","operationId":"deleteLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteLanguage"}},"/api/v2/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages. (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages)","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postLanguages"}},"/api/v2/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Location is not found by given location id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocation"},"delete":{"tags":["Locations"],"summary":"Delete a location","description":"","operationId":"deleteLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"204":{"description":"The location was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to delete a location due to invalid request.","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:delete"]},"x-purecloud-method-name":"deleteLocation"},"patch":{"tags":["Locations"],"summary":"Update a location","description":"","operationId":"patchLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationUpdateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Unable to update a location due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:edit"]},"x-purecloud-method-name":"patchLocation"}},"/api/v2/locations/{locationId}/sublocations":{"get":{"tags":["Locations"],"summary":"Get sublocations for location ID.","description":"","operationId":"getLocationSublocations","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocationSublocations"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Unable to get a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocations"},"post":{"tags":["Locations"],"summary":"Create a location","description":"","operationId":"postLocations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationCreateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:add"]},"x-purecloud-method-name":"postLocations"}},"/api/v2/locations/search":{"get":{"tags":["Locations","Search"],"summary":"Search locations using the q64 value returned from a previous search","description":"","operationId":"getLocationsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Provides more details about a specified resource","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"getLocationsSearch"},"post":{"tags":["Locations","Search"],"summary":"Search locations","description":"","operationId":"postLocationsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"postLocationsSearch"}},"/api/v2/organizations/features/{featureName}":{"patch":{"tags":["Organization"],"summary":"Update organization","description":"","operationId":"patchOrganizationsFeature","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"Organization feature","required":true,"type":"string","enum":["realtimeCIC","purecloud","hipaa","ucEnabled","pci","purecloudVoice","xmppFederation","chat","informalPhotos","directory","contactCenter","unifiedCommunications","custserv"]},{"in":"body","name":"enabled","description":"New state of feature","required":true,"schema":{"$ref":"#/definitions/FeatureState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationFeatures"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsFeature"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getOrganizationsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsMe"},"put":{"tags":["Organization"],"summary":"Update organization.","description":"","operationId":"putOrganizationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsMe"}},"/api/v2/users/{userId}/favorites":{"get":{"tags":["Users"],"summary":"Deprecated; will be revived with new contract","description":"","operationId":"getUserFavorites","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserFavorites"}},"/api/v2/users/{userId}/adjacents":{"get":{"tags":["Users"],"summary":"Get adjacents","description":"","operationId":"getUserAdjacents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Adjacents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserAdjacents"}},"/api/v2/users/{userId}/superiors":{"get":{"tags":["Users"],"summary":"Get superiors","description":"","operationId":"getUserSuperiors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserSuperiors"}},"/api/v2/users/{userId}/directreports":{"get":{"tags":["Users"],"summary":"Get direct reports","description":"","operationId":"getUserDirectreports","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserDirectreports"}},"/api/v2/languages/translations/builtin":{"get":{"tags":["Languages"],"summary":"Get the builtin translation for a language","description":"","operationId":"getLanguagesTranslationsBuiltin","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the builtin translation to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsBuiltin"}},"/api/v2/languages/translations/organization":{"get":{"tags":["Languages"],"summary":"Get effective translation for an organization by language","description":"","operationId":"getLanguagesTranslationsOrganization","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the translation to retrieve for the organization","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsOrganization"}},"/api/v2/languages/translations":{"get":{"tags":["Languages"],"summary":"Get all available languages for translation","description":"","operationId":"getLanguagesTranslations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTranslations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslations"}},"/api/v2/languages/translations/users/{userId}":{"get":{"tags":["Languages"],"summary":"Get effective language translation for a user","description":"","operationId":"getLanguagesTranslationsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsUser"}},"/api/v2/users/{userId}/profile":{"get":{"tags":["Users"],"summary":"Get user profile","description":"This api has been deprecated. Use api/v2/users instead","operationId":"getUserProfile","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the user profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserProfile"}},"/api/v2/profiles/users":{"get":{"tags":["Users"],"summary":"Get a user profile listing","description":"This api is deprecated. User /api/v2/users","operationId":"getProfilesUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jid","in":"query","description":"jid","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesUsers"}},"/api/v2/downloads/{downloadId}":{"get":{"tags":["Downloads"],"summary":"Issues a redirect to a signed secure download URL for specified download","description":"this method will issue a redirect to the url to the content","operationId":"getDownload","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"Download ID","required":true,"type":"string"},{"name":"contentDisposition","in":"query","required":false,"type":"string"},{"name":"issueRedirect","in":"query","required":false,"type":"boolean","default":true},{"name":"redirectToAuth","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Access to download is denied.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Redirect URL is not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDownload"}},"/api/v2/employeeperformance/externalmetrics/data":{"post":{"tags":["Gamification"],"summary":"Write External Metric Data","description":"","operationId":"postEmployeeperformanceExternalmetricsData","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Data to be added","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDataWriteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDataWriteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","employee.performance.external.metric.data.input.validation.error":"There was an error parsing argument","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.data.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","employee.performance.external.metric.data.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricData:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsData"}},"/api/v2/employeeperformance/externalmetrics/definitions/{metricId}":{"get":{"tags":["Gamification"],"summary":"Get an External Metric Definition","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinition"},"delete":{"tags":["Gamification"],"summary":"Delete an External Metric Definition","description":"","operationId":"deleteEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"The External Metric Definition was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:delete"]},"x-purecloud-method-name":"deleteEmployeeperformanceExternalmetricsDefinition"},"patch":{"tags":["Gamification"],"summary":"Update External Metric Definition","description":"","operationId":"patchEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the metric definition ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The External Metric Definition parameters to be updated","required":true,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use and cannot be set to false"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:edit"]},"x-purecloud-method-name":"patchEmployeeperformanceExternalmetricsDefinition"}},"/api/v2/employeeperformance/externalmetrics/definitions":{"get":{"tags":["Gamification"],"summary":"Get a list of External Metric Definitions of an organization, sorted by name in ascending order","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinitions"},"post":{"tags":["Gamification"],"summary":"Create External Metric Definition","description":"","operationId":"postEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Definition to be created","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"201":{"description":"The External Metric Definition was successfully created","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","employee.performance.external.metric.definition.too.many.metric.definitions":"The operation failed as the maximum number of External Metric Definitions has been reached"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsDefinitions"}},"/api/v2/flows/instances/{instanceId}":{"get":{"tags":["Architect"],"summary":"Start a process (job) to prepare a download of a singular flow execution data instance by Id","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"getFlowsInstance","produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"Instance ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand various details.","required":false,"type":"string","enum":["bots","dataActions"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstance"}},"/api/v2/flows/instances/jobs/{jobId}":{"get":{"tags":["Architect"],"summary":"Get the status and/or results of an asynchronous flow execution data retrieval job","description":"","operationId":"getFlowsInstancesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstancesJob"}},"/api/v2/flows/instances/jobs":{"post":{"tags":["Architect"],"summary":"Start a process (job) that will prepare a list of execution data IDs for download.","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"postFlowsInstancesJobs","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["bots","dataActions"]},{"in":"body","name":"body","description":"Requested Flow Ids","required":true,"schema":{"$ref":"#/definitions/ExecutionDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"postFlowsInstancesJobs"}},"/api/v2/flows/instances/querycapabilities":{"get":{"tags":["Architect"],"summary":"Retrieve a list of capabilities that the org can use to query for execution data","description":"Returns the queryable parameters that can be used to build a query for execution data.","operationId":"getFlowsInstancesQuerycapabilities","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["flow","action"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowsQueryCriteriaResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"getFlowsInstancesQuerycapabilities"}},"/api/v2/flows/instances/query":{"post":{"tags":["Architect"],"summary":"Query the database of existing flow histories to look for particular flow criteria","description":"Returns a list of matching flow histories up to 200 max.","operationId":"postFlowsInstancesQuery","produces":["application/json"],"parameters":[{"name":"indexOnly","in":"query","description":"indexes only","required":false,"type":"boolean"},{"name":"pageSize","in":"query","description":"number of results to return","required":false,"type":"integer","default":50,"format":"int32"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/CriteriaQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowResultEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"postFlowsInstancesQuery"}},"/api/v2/fax/settings":{"get":{"tags":["Fax"],"summary":"Get organization config for given organization","description":"","operationId":"getFaxSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.status.not.found":"Organization config not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSettings"},"put":{"tags":["Fax"],"summary":"Update/write organization config for given organization","description":"","operationId":"putFaxSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxConfig"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted config is either null or contains a null field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putFaxSettings"}},"/api/v2/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getFaxDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocumentContent"}},"/api/v2/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a document is not permitted by given document id.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocument"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"putFaxDocument"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"deleteFaxDocument"}},"/api/v2/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getFaxDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a list of fax documents is not permitted.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocuments"}},"/api/v2/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getFaxSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSummary"}},"/api/v2/gamification/status":{"get":{"tags":["Gamification"],"summary":"Gamification activation status","description":"","operationId":"getGamificationStatus","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:profile:update","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationStatus"},"put":{"tags":["Gamification"],"summary":"Update gamification activation status","description":"","operationId":"putGamificationStatus","produces":["application/json"],"parameters":[{"in":"body","name":"status","description":"Gamification status","required":true,"schema":{"$ref":"#/definitions/GamificationStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationStatus"}},"/api/v2/gamification/leaderboard":{"get":{"tags":["Gamification"],"summary":"Leaderboard of the requesting user's division or performance profile","description":"","operationId":"getGamificationLeaderboard","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboard"}},"/api/v2/gamification/leaderboard/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points of the requesting user's current performance profile or division","description":"","operationId":"getGamificationLeaderboardBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboardBestpoints"}},"/api/v2/gamification/leaderboard/all":{"get":{"tags":["Gamification"],"summary":"Leaderboard by filter type","description":"","operationId":"getGamificationLeaderboardAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAll"}},"/api/v2/gamification/leaderboard/all/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points by division or performance profile","description":"","operationId":"getGamificationLeaderboardAllBestpoints","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAllBestpoints"}},"/api/v2/gamification/metricdefinitions/{metricDefinitionId}":{"get":{"tags":["Gamification"],"summary":"Metric definition by id","description":"","operationId":"getGamificationMetricdefinition","produces":["application/json"],"parameters":[{"name":"metricDefinitionId","in":"path","description":"metric definition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinition"}},"/api/v2/gamification/metricdefinitions":{"get":{"tags":["Gamification"],"summary":"All metric definitions","description":"Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric","operationId":"getGamificationMetricdefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricDefinitionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinitions"}},"/api/v2/gamification/templates/{templateId}":{"get":{"tags":["Gamification"],"summary":"Objective template by id","description":"","operationId":"getGamificationTemplate","produces":["application/json"],"parameters":[{"name":"templateId","in":"path","description":"template id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObjectiveTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplate"}},"/api/v2/gamification/templates":{"get":{"tags":["Gamification"],"summary":"All objective templates","description":"","operationId":"getGamificationTemplates","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetTemplatesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplates"}},"/api/v2/gamification/profiles/users/me/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for the current user","description":"","operationId":"postGamificationProfilesUsersMeQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"postGamificationProfilesUsersMeQuery"}},"/api/v2/gamification/profiles/users/{userId}/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for a user","description":"","operationId":"postGamificationProfilesUserQuery","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:agentProfileMembership:view"]},"x-purecloud-method-name":"postGamificationProfilesUserQuery"}},"/api/v2/gamification/profiles/{profileId}":{"get":{"tags":["Gamification"],"summary":"Performance profile by id","description":"","operationId":"getGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfile"},"put":{"tags":["Gamification"],"summary":"Updates a performance profile","description":"","operationId":"putGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"in":"body","name":"body","description":"performanceProfile","required":false,"schema":{"$ref":"#/definitions/PerformanceProfile"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfile"}},"/api/v2/gamification/profiles/{profileId}/activate":{"post":{"tags":["Gamification"],"summary":"Activate a performance profile","description":"","operationId":"postGamificationProfileActivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileActivate"}},"/api/v2/gamification/profiles/{profileId}/deactivate":{"post":{"tags":["Gamification"],"summary":"Deactivate a performance profile","description":"","operationId":"postGamificationProfileDeactivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileDeactivate"}},"/api/v2/gamification/profiles/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Performance profile of a user","description":"","operationId":"getGamificationProfilesUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:scorecard:viewAll","gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationProfilesUser"}},"/api/v2/gamification/profiles/users/me":{"get":{"tags":["Gamification"],"summary":"Performance profile of the requesting user","description":"","operationId":"getGamificationProfilesUsersMe","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"getGamificationProfilesUsersMe"}},"/api/v2/gamification/profiles":{"get":{"tags":["Gamification"],"summary":"All performance profiles","description":"","operationId":"getGamificationProfiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetProfilesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfiles"},"post":{"tags":["Gamification"],"summary":"Create a new custom performance profile","description":"","operationId":"postGamificationProfiles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"performanceProfile","required":true,"schema":{"$ref":"#/definitions/CreatePerformanceProfile"}},{"name":"copyMetrics","in":"query","description":"Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile.","required":false,"type":"boolean","default":true}],"responses":{"201":{"description":"Performance Profile successfully created","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfiles"}},"/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link":{"post":{"tags":["Gamification"],"summary":"Creates a linked metric","description":"","operationId":"postGamificationProfileMetricLink","produces":["application/json"],"parameters":[{"name":"sourceProfileId","in":"path","description":"Source Performance Profile Id","required":true,"type":"string"},{"name":"sourceMetricId","in":"path","description":"Source Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"linkedMetric","required":true,"schema":{"$ref":"#/definitions/TargetPerformanceProfile"}}],"responses":{"201":{"description":"Linked Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetricLink"}},"/api/v2/gamification/profiles/{profileId}/metrics/{metricId}":{"get":{"tags":["Gamification"],"summary":"Performance profile gamified metric by id","description":"","operationId":"getGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetric"},"put":{"tags":["Gamification"],"summary":"Updates a metric in performance profile","description":"","operationId":"putGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfileMetric"}},"/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails":{"get":{"tags":["Gamification"],"summary":"All metrics for a given performance profile with objective details such as order and maxPoints","description":"","operationId":"getGamificationProfileMetricsObjectivedetails","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetricsObjectivedetails"}},"/api/v2/gamification/profiles/{profileId}/metrics":{"get":{"tags":["Gamification"],"summary":"All gamified metrics for a given performance profile","description":"","operationId":"getGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"metricIds","in":"query","description":"List of metric ids to filter the response (Optional, comma-separated).","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetrics"},"post":{"tags":["Gamification"],"summary":"Creates a gamified metric with a given metric definition and metric objective under in a performance profile","description":"","operationId":"postGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"201":{"description":"Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetrics"}},"/api/v2/gamification/insights/users/{userId}/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the user","description":"","operationId":"getGamificationInsightsUserDetails","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserDetails"}},"/api/v2/gamification/insights/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the current user","description":"","operationId":"getGamificationInsightsDetails","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"The number of agent to rank over limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsDetails"}},"/api/v2/gamification/insights/members":{"get":{"tags":["Gamification"],"summary":"Query users in a profile during a period of time","description":"","operationId":"getGamificationInsightsMembers","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"startWorkday","in":"query","description":"The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsAgents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsMembers"}},"/api/v2/gamification/insights/groups/trends/all":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend","description":"","operationId":"getGamificationInsightsGroupsTrendsAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrendsAll"}},"/api/v2/gamification/insights/groups/trends":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend for the current user","description":"","operationId":"getGamificationInsightsGroupsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrends"}},"/api/v2/gamification/insights":{"get":{"tags":["Gamification"],"summary":"Get insights summary","description":"","operationId":"getGamificationInsights","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortKey","in":"query","description":"Sort key","required":false,"type":"string","enum":["percentOfGoal","percentOfGoalChange","overallPercentOfGoal","overallPercentOfGoalChange","value","valueChange"]},{"name":"sortMetricId","in":"query","description":"Sort Metric Id","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"userIds","in":"query","description":"A list of up to 100 comma-separated user Ids","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsights"}},"/api/v2/gamification/insights/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the current user","description":"","operationId":"getGamificationInsightsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsTrends"}},"/api/v2/gamification/insights/users/{userId}/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the user","description":"","operationId":"getGamificationInsightsUserTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserTrends"}},"/api/v2/gamification/profiles/{profileId}/members":{"get":{"tags":["Gamification"],"summary":"Members of a given performance profile","description":"","operationId":"getGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MemberListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationProfileMembers"},"post":{"tags":["Gamification"],"summary":"Assign members to a given performance profile","description":"","operationId":"postGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"assignUsers","required":true,"schema":{"$ref":"#/definitions/AssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembers"}},"/api/v2/gamification/profiles/{profileId}/members/validate":{"post":{"tags":["Gamification"],"summary":"Validate member assignment","description":"","operationId":"postGamificationProfileMembersValidate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"memberAssignments","required":true,"schema":{"$ref":"#/definitions/ValidateAssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignmentValidation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembersValidate"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of the requesting user","description":"","operationId":"getGamificationScorecardsProfileMetricValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, returns the values trends of the requesting user","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a division or a performance profile","description":"","operationId":"getGamificationScorecardsProfileMetricUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. Only required when filterType is Division.","required":false,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUsersValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a user","description":"","operationId":"getGamificationScorecardsProfileMetricUserValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUserValuesTrends"}},"/api/v2/gamification/scorecards/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of the requesting user","description":"","operationId":"getGamificationScorecardsBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsBestpoints"}},"/api/v2/gamification/scorecards":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics of the requesting user","description":"","operationId":"getGamificationScorecards","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecards"}},"/api/v2/gamification/scorecards/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics of the requesting user","description":"","operationId":"getGamificationScorecardsAttendance","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsAttendance"}},"/api/v2/gamification/scorecards/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points of the requesting user","description":"","operationId":"getGamificationScorecardsPointsAlltime","produces":["application/json"],"parameters":[{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAlltime"}},"/api/v2/gamification/scorecards/points/average":{"get":{"tags":["Gamification"],"summary":"Average points of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsPointsAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAverage"}},"/api/v2/gamification/scorecards/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trends of the requesting user","description":"","operationId":"getGamificationScorecardsPointsTrends","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsTrends"}},"/api/v2/gamification/scorecards/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of the requesting user or group","description":"","operationId":"getGamificationScorecardsValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, then the request is for the requesting user.","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesTrends"}},"/api/v2/gamification/scorecards/values/average":{"get":{"tags":["Gamification"],"summary":"Average values of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsValuesAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesAverage"}},"/api/v2/gamification/scorecards/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics for a user","description":"","operationId":"getGamificationScorecardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUser"}},"/api/v2/gamification/scorecards/users/{userId}/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of a user","description":"","operationId":"getGamificationScorecardsUserBestpoints","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserBestpoints"}},"/api/v2/gamification/scorecards/users/{userId}/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics for a user","description":"","operationId":"getGamificationScorecardsUserAttendance","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"The timezone ID was invalid.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserAttendance"}},"/api/v2/gamification/scorecards/users/{userId}/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trend for a user","description":"","operationId":"getGamificationScorecardsUserPointsTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsTrends"}},"/api/v2/gamification/scorecards/users/{userId}/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points for a user","description":"","operationId":"getGamificationScorecardsUserPointsAlltime","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsAlltime"}},"/api/v2/gamification/scorecards/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of a user","description":"","operationId":"getGamificationScorecardsUserValuesTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserValuesTrends"}},"/api/v2/gamification/scorecards/users/points/average":{"get":{"tags":["Gamification"],"summary":"Workday average points by target group","description":"","operationId":"getGamificationScorecardsUsersPointsAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersPointsAverage"}},"/api/v2/gamification/scorecards/users/values/average":{"get":{"tags":["Gamification"],"summary":"Workday average values by target group","description":"","operationId":"getGamificationScorecardsUsersValuesAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesAverage"}},"/api/v2/gamification/scorecards/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trend by target group","description":"","operationId":"getGamificationScorecardsUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesTrends"}},"/api/v2/gdpr/requests/{requestId}":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get an existing GDPR request","description":"","operationId":"getGdprRequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Request id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequest"}},"/api/v2/gdpr/requests":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get all GDPR requests","description":"","operationId":"getGdprRequests","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequestEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequests"},"post":{"tags":["General Data Protection Regulation"],"summary":"Submit a new GDPR request","description":"","operationId":"postGdprRequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"GDPR request","required":true,"schema":{"$ref":"#/definitions/GDPRRequest"}},{"name":"deleteConfirmed","in":"query","description":"Confirm delete","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:add"]},"x-purecloud-method-name":"postGdprRequests"}},"/api/v2/gdpr/subjects":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get GDPR subjects","description":"","operationId":"getGdprSubjects","produces":["application/json"],"parameters":[{"name":"searchType","in":"query","description":"Search Type","required":true,"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},{"name":"searchValue","in":"query","description":"Search Value","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRSubjectEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:subject:view"]},"x-purecloud-method-name":"getGdprSubjects"}},"/api/v2/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getUserGeolocation"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Geolocation","required":true,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","geolocationservice.entitypointerror":"Geolocation entity point error","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","geolocation.update.error":"Cannot update another user's Geolocation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"featuretoggleservice.featurenotenabled":"Geolocation feature toggle not enabled"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-purecloud-method-name":"patchUserGeolocation"}},"/api/v2/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getGeolocationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getGeolocationsSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchGeolocationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Geolocation settings","required":true,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["geolocation:settings:edit"]},"x-purecloud-method-name":"patchGeolocationsSettings"}},"/api/v2/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingMedia"}},"/api/v2/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreeting"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreeting"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"deleteGreeting"}},"/api/v2/groups/{groupId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a Group's ID","description":"","operationId":"getGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified Group","description":"","operationId":"putGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGroupGreetingsDefaults"}},"/api/v2/groups/{groupId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the Group's Greetings","description":"","operationId":"getGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a Group","description":"","operationId":"postGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGroupGreetings"}},"/api/v2/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getGreetingsDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putGreetingsDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreetingsDefaults"}},"/api/v2/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGreetings"}},"/api/v2/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putUserGreetingsDefaults"}},"/api/v2/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postUserGreetings"}},"/api/v2/integrations/clientapps":{"get":{"tags":["Integrations"],"summary":"List permitted client app integrations for the logged in user","description":"","operationId":"getIntegrationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsClientapps"}},"/api/v2/integrations/{integrationId}/config/current":{"get":{"tags":["Integrations"],"summary":"Get integration configuration.","description":"","operationId":"getIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationConfigCurrent"},"put":{"tags":["Integrations"],"summary":"Update integration configuration.","description":"","operationId":"putIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Configuration","required":false,"schema":{"$ref":"#/definitions/IntegrationConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Integration configuration update failed due to version conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationConfigCurrent"}},"/api/v2/integrations/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get integration.","description":"","operationId":"getIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegration"},"delete":{"tags":["Integrations"],"summary":"Delete integration.","description":"","operationId":"deleteIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:delete"]},"x-purecloud-method-name":"deleteIntegration"},"patch":{"tags":["Integrations"],"summary":"Update an integration.","description":"","operationId":"patchIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Update","required":false,"schema":{"$ref":"#/definitions/Integration"}},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"patchIntegration"}},"/api/v2/integrations/types/{typeId}/configschemas/{configType}":{"get":{"tags":["Integrations"],"summary":"Get properties config schema for an integration type.","description":"","operationId":"getIntegrationsTypeConfigschema","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"},{"name":"configType","in":"path","description":"Config schema type","required":true,"type":"string","enum":["properties","advanced"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypeConfigschema"}},"/api/v2/integrations/types/{typeId}":{"get":{"tags":["Integrations"],"summary":"Get integration type.","description":"","operationId":"getIntegrationsType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsType"}},"/api/v2/integrations/types":{"get":{"tags":["Integrations"],"summary":"List integration types","description":"","operationId":"getIntegrationsTypes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypes"}},"/api/v2/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"","operationId":"getIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrations"},"post":{"tags":["Integrations"],"summary":"Create an integration.","description":"","operationId":"postIntegrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Integration","required":false,"schema":{"$ref":"#/definitions/CreateIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.integrations.reached":"The maximum number of integrations for this type have already been created. One or more integrations must be removed before a new one can be created."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:add"]},"x-purecloud-method-name":"postIntegrations"}},"/api/v2/integrations/userapps":{"get":{"tags":["Integrations"],"summary":"List permitted user app integrations for the logged in user","description":"","operationId":"getIntegrationsUserapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"appHost","in":"query","description":"The type of UserApp to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsUserapps"}},"/api/v2/integrations/actions/categories":{"get":{"tags":["Integrations"],"summary":"Retrieves all categories of available Actions","description":"","operationId":"getIntegrationsActionsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on. Only 'name' is supported on this endpoint.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsCategories"}},"/api/v2/integrations/actions/certificates":{"get":{"tags":["Integrations"],"summary":"Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.","description":"","operationId":"getIntegrationsActionsCertificates","produces":["application/json"],"parameters":[{"name":"status","in":"query","description":"Indicates the validity of the certificate in question.","required":false,"type":"string","enum":["Current","Upcoming"]},{"name":"type","in":"query","description":"Indicates the type of the certificate.","required":false,"type":"string","enum":["Client"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionCertificateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionCertificate:view"]},"x-purecloud-method-name":"getIntegrationsActionsCertificates"}},"/api/v2/integrations/actions/{actionId}/draft":{"get":{"tags":["Integrations"],"summary":"Retrieve a Draft","description":"","operationId":"getIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraft"},"post":{"tags":["Integrations"],"summary":"Create a new Draft from existing Action","description":"","operationId":"postIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","policy.violation":"A policy violation occurred creating the new draft.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraft"},"delete":{"tags":["Integrations"],"summary":"Delete a Draft","description":"","operationId":"deleteIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsActionDraft"},"patch":{"tags":["Integrations"],"summary":"Update an existing Draft","description":"","operationId":"patchIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action Draft.","required":true,"schema":{"$ref":"#/definitions/UpdateDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsActionDraft"}},"/api/v2/integrations/actions/{actionId}/draft/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionDraftTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute"]},"x-purecloud-method-name":"postIntegrationsActionDraftTest"}},"/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftSchema"}},"/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve templates for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftTemplate"}},"/api/v2/integrations/actions/{actionId}/draft/publish":{"post":{"tags":["Integrations"],"summary":"Publish a Draft and make it the active Action configuration","description":"","operationId":"postIntegrationsActionDraftPublish","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/PublishDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftPublish"}},"/api/v2/integrations/actions/{actionId}/draft/validation":{"get":{"tags":["Integrations"],"summary":"Validate current Draft configuration.","description":"","operationId":"getIntegrationsActionDraftValidation","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftValidationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"getIntegrationsActionDraftValidation"}},"/api/v2/integrations/actions/{actionId}/execute":{"post":{"tags":["Integrations"],"summary":"Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.","description":"","operationId":"postIntegrationsActionExecute","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.results":"Too many results matched criteria.","bad.request":"The 3rd party indicated an issue with the request","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There was an issue validating the schema.","constraint.validation":"%s","invalid.substitution":"There was an issue substituting a value in one of the templates","no.results":"No results were found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.credentials":"There was an issue validating the credentials.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","bad.request":"The request is badly formed.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"method not allowed":"The request method is not allowed for this resource"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionExecute"}},"/api/v2/integrations/actions/{actionId}":{"get":{"tags":["Integrations"],"summary":"Retrieves a single Action matching id.","description":"","operationId":"getIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsAction"},"delete":{"tags":["Integrations"],"summary":"Delete an Action","description":"","operationId":"deleteIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsAction"},"patch":{"tags":["Integrations"],"summary":"Patch an Action","description":"","operationId":"patchIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/UpdateActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsAction"}},"/api/v2/integrations/actions/{actionId}/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionTest"}},"/api/v2/integrations/actions/{actionId}/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for an action based on filename.","description":"","operationId":"getIntegrationsActionSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionSchema"}},"/api/v2/integrations/actions/{actionId}/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve text of templates for an action based on filename.","description":"","operationId":"getIntegrationsActionTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionTemplate"}},"/api/v2/integrations/actions/drafts":{"get":{"tags":["Integrations"],"summary":"Retrieves all action drafts associated with the filters passed in via query param.","description":"","operationId":"getIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsDrafts"},"post":{"tags":["Integrations"],"summary":"Create a new Draft","description":"","operationId":"postIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action Draft.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActionsDrafts"}},"/api/v2/integrations/actions":{"get":{"tags":["Integrations"],"summary":"Retrieves all actions associated with filters passed in via query param.","description":"","operationId":"getIntegrationsActions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActions"},"post":{"tags":["Integrations"],"summary":"Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.","description":"","operationId":"postIntegrationsActions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There is an error preventing a file from being read","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActions"}},"/api/v2/integrations/botconnector/{integrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBots"},"put":{"tags":["Integrations"],"summary":"Set a list of botConnector bots plus versions for this integration","description":"","operationId":"putIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"botList","required":true,"schema":{"$ref":"#/definitions/BotList"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:edit"]},"x-purecloud-method-name":"putIntegrationsBotconnectorIntegrationIdBots"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a specific botConnector bot, plus versions, for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"version","in":"query","description":"Specific Version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBot"}},"/api/v2/integrations/botconnector/{integrationId}/bots/summaries":{"get":{"tags":["Integrations"],"summary":"Get a summary list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotsSummaries","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotsSummaries"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions":{"get":{"tags":["Integrations"],"summary":"Get a list of bot versions for a bot","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotVersions","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this bot group","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotVersionSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotVersions"}},"/api/v2/integrations/speech/dialogflow/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow agent","description":"","operationId":"getIntegrationsSpeechDialogflowAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgent"}},"/api/v2/integrations/speech/dialogflow/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgents"}},"/api/v2/integrations/speech/dialogflowcx/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow CX agent","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgent"}},"/api/v2/integrations/speech/dialogflowcx/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow CX agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow cx agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgents"}},"/api/v2/integrations/speech/lex/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex bot alias","description":"","operationId":"getIntegrationsSpeechLexBotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotAlias"}},"/api/v2/integrations/speech/lex/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a bot in the customer's AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["READY","FAILED","BUILDING","NOT_BUILT"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotBotIdAliases"}},"/api/v2/integrations/speech/lex/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex bots in the customers' AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBots"}},"/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex V2 bot alias","description":"","operationId":"getIntegrationsSpeechLexv2BotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The Alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotAlias"}},"/api/v2/integrations/speech/lexv2/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a Lex V2 bot","description":"","operationId":"getIntegrationsSpeechLexv2BotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The Bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["Creating","Available","Deleting","Failed"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotBotIdAliases"}},"/api/v2/integrations/speech/lexv2/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex V2 bots","description":"","operationId":"getIntegrationsSpeechLexv2Bots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2Bots"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs":{"post":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"targetChannel","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID to get","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"name":"targetChannel","in":"query","description":"targetChannel","required":false,"type":"string","enum":["digital","voice"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs":{"post":{"tags":["Integrations"],"summary":"Get a list of Nuance bots in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings":{"put":{"tags":["Integrations"],"summary":"Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration","description":"","operationId":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/NuanceBotLaunchSettings"}}],"responses":{"204":{"description":"Configuration updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate":{"post":{"tags":["Integrations"],"summary":"Try out a single credential for a Nuance bot to know if the secret is correct","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/BotExecutionConfiguration"}}],"responses":{"204":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Nuance bots available in the specified Integration","description":"If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots"}},"/api/v2/integrations/speech/stt/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a STT engine","description":"","operationId":"getIntegrationsSpeechSttEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngine"}},"/api/v2/integrations/speech/stt/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of STT engines enabled for org","description":"","operationId":"getIntegrationsSpeechSttEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngines"}},"/api/v2/integrations/speech/tts/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngine"}},"/api/v2/integrations/speech/tts/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of TTS engines enabled for org","description":"","operationId":"getIntegrationsSpeechTtsEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"},{"name":"language","in":"query","description":"Filter on supported language. If includeVoices=true then the voices are also filtered.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngines"}},"/api/v2/integrations/speech/tts/settings":{"get":{"tags":["Integrations"],"summary":"Get TTS settings for an org","description":"","operationId":"getIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsSettings"},"put":{"tags":["Integrations"],"summary":"Update TTS settings for an org","description":"","operationId":"putIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Updated TtsSettings","required":true,"schema":{"$ref":"#/definitions/TtsSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechTtsSettings"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}":{"get":{"tags":["Integrations"],"summary":"Get details about a specific voice for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoice","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"voiceId","in":"path","description":"The voice ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoice"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices":{"get":{"tags":["Integrations"],"summary":"Get a list of voices for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoices","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoices"}},"/api/v2/journey/actionmaps/{actionMapId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action map.","description":"","operationId":"getJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmap"},"delete":{"tags":["Journey"],"summary":"Delete single action map.","description":"","operationId":"deleteJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"204":{"description":"Action map deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:delete"]},"x-purecloud-method-name":"deleteJourneyActionmap"},"patch":{"tags":["Journey"],"summary":"Update single action map.","description":"","operationId":"patchJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:edit"]},"x-purecloud-method-name":"patchJourneyActionmap"}},"/api/v2/journey/actionmaps":{"get":{"tags":["Journey"],"summary":"Retrieve all action maps.","description":"","operationId":"getJourneyActionmaps","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"filterField","in":"query","description":"Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.","required":false,"type":"string"},{"name":"filterValue","in":"query","description":"Value to filter by. Requires 'filterValue' to also be set.","required":false,"type":"string"},{"name":"actionMapIds","in":"query","description":"IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Action Map field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmaps"},"post":{"tags":["Journey"],"summary":"Create an action map.","description":"","operationId":"postJourneyActionmaps","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"201":{"description":"Action map created.","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:add"]},"x-purecloud-method-name":"postJourneyActionmaps"}},"/api/v2/journey/actiontargets/{actionTargetId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action target.","description":"","operationId":"getJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontarget"},"patch":{"tags":["Journey"],"summary":"Update a single action target.","description":"","operationId":"patchJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTarget"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:edit"]},"x-purecloud-method-name":"patchJourneyActiontarget"}},"/api/v2/journey/actiontargets":{"get":{"tags":["Journey"],"summary":"Retrieve all action targets.","description":"","operationId":"getJourneyActiontargets","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTargetListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontargets"}},"/api/v2/journey/actiontemplates/{actionTemplateId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action template.","description":"","operationId":"getJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplate"},"delete":{"tags":["Journey"],"summary":"Delete a single action template.","description":"","operationId":"deleteJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"name":"hardDelete","in":"query","description":"Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.","required":false,"type":"boolean"}],"responses":{"204":{"description":"Action template deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:delete"]},"x-purecloud-method-name":"deleteJourneyActiontemplate"},"patch":{"tags":["Journey"],"summary":"Update a single action template.","description":"","operationId":"patchJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:edit"]},"x-purecloud-method-name":"patchJourneyActiontemplate"}},"/api/v2/journey/actiontemplates":{"get":{"tags":["Journey"],"summary":"Retrieve all action templates.","description":"","operationId":"getJourneyActiontemplates","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).","required":false,"type":"string"},{"name":"mediaType","in":"query","description":"Media type","required":false,"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},{"name":"state","in":"query","description":"Action template state.","required":false,"type":"string","enum":["Active","Inactive","Deleted"]},{"name":"queryFields","in":"query","description":"ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplates"},"post":{"tags":["Journey"],"summary":"Create a single action template.","description":"","operationId":"postJourneyActiontemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"201":{"description":"Action template created.","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:add"]},"x-purecloud-method-name":"postJourneyActiontemplates"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get status of job.","description":"","operationId":"getJourneyActionmapsEstimatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"202":{"description":"Accepted - Running query asynchronously","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimateJob:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJob"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get estimates from completed job.","description":"","operationId":"getJourneyActionmapsEstimatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapEstimateResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimate:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJobResults"}},"/api/v2/journey/actionmaps/estimates/jobs":{"post":{"tags":["Journey"],"summary":"Query for estimates","description":"","operationId":"postJourneyActionmapsEstimatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"audience estimator request","required":true,"schema":{"$ref":"#/definitions/ActionMapEstimateRequest"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/EstimateJobAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmapEstimateJob:add"]},"x-purecloud-method-name":"postJourneyActionmapsEstimatesJobs"}},"/api/v2/journey/flows/paths/query":{"post":{"tags":["Journey"],"summary":"Query for flow paths.","description":"","operationId":"postJourneyFlowsPathsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowPathsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowPaths"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:flowpaths:view"]},"x-purecloud-method-name":"postJourneyFlowsPathsQuery"}},"/api/v2/journey/outcomes/{outcomeId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome.","description":"","operationId":"getJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcome"},"delete":{"tags":["Journey"],"summary":"Delete an outcome.","description":"","operationId":"deleteJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"204":{"description":"Outcome deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:delete"]},"x-purecloud-method-name":"deleteJourneyOutcome"},"patch":{"tags":["Journey"],"summary":"Update an outcome.","description":"","operationId":"patchJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:edit"]},"x-purecloud-method-name":"patchJourneyOutcome"}},"/api/v2/journey/outcomes":{"get":{"tags":["Journey"],"summary":"Retrieve all outcomes.","description":"","operationId":"getJourneyOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"outcomeIds","in":"query","description":"IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Outcome field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcomes"},"post":{"tags":["Journey"],"summary":"Create an outcome.","description":"","operationId":"postJourneyOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"201":{"description":"Outcome created.","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:add"]},"x-purecloud-method-name":"postJourneyOutcomes"}},"/api/v2/journey/sessions/{sessionId}/outcomescores":{"get":{"tags":["Journey"],"summary":"Retrieve latest outcome score associated with a session for all outcomes.","description":"","operationId":"getJourneySessionOutcomescores","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeScoresResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomescores:view"]},"x-purecloud-method-name":"getJourneySessionOutcomescores"}},"/api/v2/journey/outcomes/predictors/{predictorId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome predictor.","description":"","operationId":"getJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictor"},"delete":{"tags":["Journey"],"summary":"Delete an outcome predictor.","description":"","operationId":"deleteJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"204":{"description":"Predictor deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:delete"]},"x-purecloud-method-name":"deleteJourneyOutcomesPredictor"}},"/api/v2/journey/outcomes/predictors":{"get":{"tags":["Journey"],"summary":"Retrieve all outcome predictors.","description":"","operationId":"getJourneyOutcomesPredictors","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictors"},"post":{"tags":["Journey"],"summary":"Create an outcome predictor.","description":"","operationId":"postJourneyOutcomesPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:add"]},"x-purecloud-method-name":"postJourneyOutcomesPredictors"}},"/api/v2/journey/segments/{segmentId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single segment.","description":"","operationId":"getJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegment"},"delete":{"tags":["Journey"],"summary":"Delete a segment.","description":"","operationId":"deleteJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"204":{"description":"Segment deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:delete"]},"x-purecloud-method-name":"deleteJourneySegment"},"patch":{"tags":["Journey"],"summary":"Update a segment.","description":"","operationId":"patchJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchSegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:edit"]},"x-purecloud-method-name":"patchJourneySegment"}},"/api/v2/journey/segments":{"get":{"tags":["Journey"],"summary":"Retrieve all segments.","description":"","operationId":"getJourneySegments","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"isActive","in":"query","description":"Determines whether or not to show only active segments.","required":false,"type":"boolean"},{"name":"segmentIds","in":"query","description":"IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Segment field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SegmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegments"},"post":{"tags":["Journey"],"summary":"Create a segment.","description":"","operationId":"postJourneySegments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JourneySegmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"201":{"description":"Segment created.","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:add"]},"x-purecloud-method-name":"postJourneySegments"}},"/api/v2/journey/sessions/{sessionId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single session.","description":"","operationId":"getJourneySession","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Session"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:session:view","externalContacts:session:view"]},"x-purecloud-method-name":"getJourneySession"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"201":{"description":"Category created","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Total number, maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.parent.category":"Subcategory cannot be the parent category.","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search":{"post":{"tags":["Knowledge","Search"],"summary":"Search Documents","description":"","operationId":"postKnowledgeKnowledgebaseSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum characters for the query is 5","invalid.languagecode":"Language code must be of format lang-iso2 (eg: en-US)","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeCategory"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}":{"get":{"tags":["Knowledge"],"summary":"Get import operation report","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"200":{"description":"Finished import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Pending import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocumentsImport"},"delete":{"tags":["Knowledge"],"summary":"Delete import operation","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import operation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport"},"patch":{"tags":["Knowledge"],"summary":"Start import operation","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"Import operation finished","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Import operation started","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit","knowledge:document:add"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocumentsImport"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports":{"post":{"tags":["Knowledge"],"summary":"Create import operation","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocumentsImports","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImport"}}],"responses":{"202":{"description":"Created import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocumentsImports"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"204":{"description":"Document deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocuments","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"categories","in":"query","description":"Filter by categories ids, comma separated values expected.","required":false,"type":"string"},{"name":"title","in":"query","description":"Filter by document title.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Title","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]},{"name":"documentIds","in":"query","description":"Comma-separated list of document identifiers to fetch by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","document.limitexceeded":"Document count exceeded for kbId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocuments"},"patch":{"tags":["Knowledge"],"summary":"Update documents collection","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentBulkRequest"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"Internal server error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base","description":"","operationId":"getKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebase"},"delete":{"tags":["Knowledge"],"summary":"Delete knowledge base","description":"","operationId":"deleteKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"204":{"description":"Knowledge base deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input paramaters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledgebase not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.in.use":"knowledgebase in use by bot flow"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.bot.flow.status.unknown":"Knowledgebase bot flow status unknown"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebase"},"patch":{"tags":["Knowledge"],"summary":"Update knowledge base","description":"","operationId":"patchKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebase"}},"/api/v2/knowledge/knowledgebases":{"get":{"tags":["Knowledge"],"summary":"Get knowledge bases","description":"","operationId":"getKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 100. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 100.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by Name.","required":false,"type":"string"},{"name":"coreLanguage","in":"query","description":"Filter by core language.","required":false,"type":"string","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"published","in":"query","description":"Filter by published status.","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Name","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBaseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebases"},"post":{"tags":["Knowledge"],"summary":"Create new knowledge base","description":"","operationId":"postKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"kb.limitexceeded":"Knowledge Base count exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebases"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered groups","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroups","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroups"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroups"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered group for a particular groupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered phrase group for a particular phraseGroupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"},"patch":{"tags":["Knowledge"],"summary":"Update a Knowledge base unanswered phrase group","description":"","operationId":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be updated.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be updated.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body of the update unanswered group endpoint.","required":true,"schema":{"$ref":"#/definitions/UnansweredPhraseGroupPatchRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroupUpdateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:edit","knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}":{"get":{"tags":["Knowledge"],"summary":"Get label","description":"","operationId":"getKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabel"},"delete":{"tags":["Knowledge"],"summary":"Delete label","description":"","operationId":"deleteKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"204":{"description":"Label deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLabel"},"patch":{"tags":["Knowledge"],"summary":"Update label","description":"","operationId":"patchKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with the new name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLabel"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels":{"get":{"tags":["Knowledge"],"summary":"Get labels","description":"","operationId":"getKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the labels that contains the given phrase in the name.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to label.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabels"},"post":{"tags":["Knowledge"],"summary":"Create new label","description":"","operationId":"postKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"201":{"description":"Label created","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"The limit for the number of labels has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLabels"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}":{"get":{"tags":["Knowledge"],"summary":"Get training detail","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTraining","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTraining"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote":{"post":{"tags":["Knowledge"],"summary":"Promote trained documents from draft state to active.","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainingPromote","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainingPromote"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings":{"get":{"tags":["Knowledge"],"summary":"Get all trainings information for a knowledgebase","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"knowledgeDocumentsState","in":"query","description":"Return the training with the specified state of the trained documents.","required":false,"type":"string","enum":["Draft","Active","Discarded","Archived"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrainingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTrainings"},"post":{"tags":["Knowledge"],"summary":"Trigger training","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainings"}},"/api/v2/knowledge/documentuploads":{"post":{"tags":["Knowledge","Uploads"],"summary":"Creates a presigned URL for uploading a knowledge import file with a set of documents","description":"","operationId":"postKnowledgeDocumentuploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:upload"]},"x-purecloud-method-name":"postKnowledgeDocumentuploads"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document.","description":"","operationId":"getKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"state","in":"query","description":"\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"}],"responses":{"204":{"description":"Document deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}":{"get":{"tags":["Knowledge"],"summary":"Get document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersion","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersion"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions":{"get":{"tags":["Knowledge"],"summary":"Get document versions.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersions"},"post":{"tags":["Knowledge"],"summary":"Creates or restores a document version.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVersions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ","required":false,"type":"string","format":"interval"},{"name":"documentId","in":"query","description":"Retrieves the specified documents, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSubcategories","in":"query","description":"Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.","required":false,"type":"boolean"},{"name":"includeDrafts","in":"query","description":"If includeDrafts is true, Documents in the draft state are also returned in the response.","required":false,"type":"boolean"},{"name":"labelIds","in":"query","description":"If specified, retrieves documents associated with label ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"externalIds","in":"query","description":"If specified, retrieves documents associated with external ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document.","description":"","operationId":"postKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Document already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}":{"get":{"tags":["Knowledge"],"summary":"Get a variation for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariation"},"delete":{"tags":["Knowledge"],"summary":"Delete a variation for a document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"}],"responses":{"204":{"description":"Document variation deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:delete","knowledge:document:edit"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocumentVariation"},"patch":{"tags":["Knowledge"],"summary":"Update a variation for a document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariations"},"post":{"tags":["Knowledge"],"summary":"Create a variation for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","already.exists":"Variation already exists","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:add","knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}":{"get":{"tags":["Knowledge"],"summary":"Get variation for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariation","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"variationId","in":"path","description":"Globally unique identifier for the document version variation.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentCopies","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentCopy:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentCopies"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentPresentation:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsPresentations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}":{"get":{"tags":["Knowledge"],"summary":"Get a single feedback record given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"Feedback ID.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Feedback not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback":{"get":{"tags":["Knowledge"],"summary":"Get a list of feedback records given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"onlyCommented","in":"query","description":"If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.","required":false,"type":"boolean"},{"name":"documentVersionId","in":"query","description":"Document version ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"documentVariationId","in":"query","description":"Document variation ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"appType","in":"query","description":"Application type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},{"name":"queryType","in":"query","description":"Query type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},{"name":"userId","in":"query","description":"The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"state","in":"query","description":"State to filter by. Supported only if onlyCommented=true is set. Default: Final","required":false,"type":"string","enum":["All","Draft","Final"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedback"},"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentFeedback"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}":{"get":{"tags":["Knowledge"],"summary":"Get export job report","description":"","operationId":"getKnowledgeKnowledgebaseExportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"Export job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"202":{"description":"Export job in progress","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseExportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete export job","description":"","operationId":"deleteKnowledgeKnowledgebaseExportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"Export job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Export job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseExportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs":{"post":{"tags":["Knowledge"],"summary":"Create export job","description":"","operationId":"postKnowledgeKnowledgebaseExportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"202":{"description":"Export job in progress","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.reached":"Daily or monthly limit reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseExportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}":{"get":{"tags":["Knowledge"],"summary":"Get import job report","description":"","operationId":"getKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.","required":false,"type":"array","items":{"type":"string","enum":["urls"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseImportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete import job","description":"","operationId":"deleteKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseImportJob"},"patch":{"tags":["Knowledge"],"summary":"Start import job","description":"","operationId":"patchKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseImportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs":{"post":{"tags":["Knowledge"],"summary":"Create import job","description":"","operationId":"postKnowledgeKnowledgebaseImportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseImportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search":{"post":{"tags":["Knowledge"],"summary":"Search the documents in a knowledge base.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields, if any, to expand for each document in the search result matching the query.","required":false,"type":"array","items":{"type":"string","enum":["documentVariations","documentAlternatives"]},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentSearch"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"The minimum characters for the query is 3.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:search:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum length was not reached.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentViews","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentView:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentViews"}},"/api/v2/languageunderstanding/domains/{domainId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain.","description":"","operationId":"getLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomain"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain.","description":"","operationId":"deleteLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"There was a request conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomain"},"patch":{"tags":["Language Understanding"],"summary":"Update an NLU Domain.","description":"","operationId":"patchLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:edit","dialog:bot:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingDomain"}},"/api/v2/languageunderstanding/domains":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domains.","description":"","operationId":"getLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomains"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain.","description":"","operationId":"postLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The NLU Domain to create.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"201":{"description":"","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","domain.limit":"This organization has reached limit for domains created.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomains"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}":{"get":{"tags":["Language Understanding"],"summary":"Find a Feedback","description":"","operationId":"getLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedbackFeedbackId"},"delete":{"tags":["Language Understanding"],"summary":"Delete the feedback on the NLU Domain Version.","description":"","operationId":"deleteLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"Feedback deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainFeedbackFeedbackId"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback":{"get":{"tags":["Language Understanding"],"summary":"Get all feedback in the given NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"intentName","in":"query","description":"The top intent name to retrieve feedback for.","required":false,"type":"string"},{"name":"assessment","in":"query","description":"The top assessment to retrieve feedback for.","required":false,"type":"string","enum":["Incorrect","Correct","Unknown","Disabled"]},{"name":"dateStart","in":"query","description":"Begin of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"End of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"includeDeleted","in":"query","description":"Whether to include soft-deleted items in the result.","required":false,"type":"boolean"},{"name":"language","in":"query","description":"Whether to filter response based on the language, e.g. en-us, pt-br.","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"enableCursorPagination","in":"query","description":"Enable Cursor Pagination","required":false,"type":"boolean","default":false},{"name":"includeTrainingUtterances","in":"query","description":"Include Training Utterances. By default they're included.","required":false,"type":"boolean","default":true},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true","required":false,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedback"},"post":{"tags":["Language Understanding"],"summary":"Create feedback for the NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The Feedback to create.","required":true,"schema":{"$ref":"#/definitions/NluFeedbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"201":{"description":"Feedback created successfully","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"Invalid feedback data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainFeedback"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a draft.","description":"","operationId":"getLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"name":"draftIntentId","in":"query","description":"Parameter to filter a specific intent.","required":false,"type":"string"},{"name":"draftTopicId","in":"query","description":"Parameter to filter a specific topic.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDraft"},"delete":{"tags":["Language Understanding"],"summary":"Delete a draft","description":"","operationId":"deleteLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"}],"responses":{"204":{"description":"Draft deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMinerDraft"},"patch":{"tags":["Language Understanding"],"summary":"Save information for the draft. Either topic draft or intent draft should be sent.","description":"","operationId":"patchLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DraftRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingMinerDraft"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of drafts created.","description":"","operationId":"getLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDrafts"},"post":{"tags":["Language Understanding"],"summary":"Create a new draft resource.","description":"","operationId":"postLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Details for creating draft resource","required":true,"schema":{"$ref":"#/definitions/Draft"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"201":{"description":"Draft created successfully","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:add"]},"x-purecloud-method-name":"postLanguageunderstandingMinerDrafts"}},"/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a mined intent","description":"","operationId":"getLanguageunderstandingMinerIntent","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"intentId","in":"path","description":"The ID of the intent to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerIntent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntent"}},"/api/v2/languageunderstanding/miners/{minerId}/intents":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined intents.","description":"","operationId":"getLanguageunderstandingMinerIntents","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances.","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinedIntentsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntents"}},"/api/v2/languageunderstanding/miners/{minerId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a miner.","description":"","operationId":"getLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiner"},"delete":{"tags":["Language Understanding"],"summary":"Delete a miner.","description":"","operationId":"deleteLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"204":{"description":"Miner deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMiner"}},"/api/v2/languageunderstanding/miners/{minerId}/execute":{"post":{"tags":["Language Understanding"],"summary":"Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.","description":"","operationId":"postLanguageunderstandingMinerExecute","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MinerExecuteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"202":{"description":"Processing request","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:execute"]},"x-purecloud-method-name":"postLanguageunderstandingMinerExecute"}},"/api/v2/languageunderstanding/miners":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of miners created.","description":"","operationId":"getLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"name":"minerType","in":"query","description":"Type of miner, either intent or topic","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiners"},"post":{"tags":["Language Understanding"],"summary":"Create a unique miner.","description":"","operationId":"postLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Details for creating a new miner resource.","required":true,"schema":{"$ref":"#/definitions/Miner"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"201":{"description":"Miner created successfully","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:add"]},"x-purecloud-method-name":"postLanguageunderstandingMiners"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves details of a particular topic.","description":"","operationId":"getLanguageunderstandingMinerTopic","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch phrases","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopic"}},"/api/v2/languageunderstanding/miners/{minerId}/topics":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined topics.","description":"","operationId":"getLanguageunderstandingMinerTopics","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopics"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves utterances related to a phrase in a topic.","description":"","operationId":"getLanguageunderstandingMinerTopicPhrase","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"phraseId","in":"path","description":"The ID of the phrase to be retrieved.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicPhrase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopicPhrase"}},"/api/v2/languageunderstanding/miners/{minerId}/uploads":{"post":{"tags":["Uploads"],"summary":"Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner","description":"","operationId":"postLanguageunderstandingMinerUploads","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/Empty"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:upload"]},"x-purecloud-method-name":"postLanguageunderstandingMinerUploads"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report":{"get":{"tags":["Language Understanding"],"summary":"Retrieved quality report for the specified NLU Domain Version","description":"","operationId":"getLanguageunderstandingDomainVersionReport","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"Find quality report for NLU Domain Version.","schema":{"$ref":"#/definitions/NluDomainVersionQualityReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersionReport"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Retrieved the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersion"},"put":{"tags":["Language Understanding"],"summary":"Update an NLU Domain Version.","description":"","operationId":"putLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain Version.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"Updated the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"putLanguageunderstandingDomainVersion"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain Version","description":"","operationId":"deleteLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted the specified NLU Domain Version"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.evaluation.in.progress":"The request could not be completed due to a conflict with the current state of the target resource.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:delete","dialog:botVersion:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainVersion"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish":{"post":{"tags":["Language Understanding"],"summary":"Publish the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionPublish","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Published the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","version.untrained":"The version cannot be published as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionPublish"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train":{"post":{"tags":["Language Understanding"],"summary":"Train the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionTrain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"202":{"description":"Issued training instruction for the draft NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"training error":"The service is not available.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionTrain"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect":{"post":{"tags":["Language Understanding"],"summary":"Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","description":"","operationId":"postLanguageunderstandingDomainVersionDetect","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The input data to perform detection on.","required":true,"schema":{"$ref":"#/definitions/NluDetectionRequest"}}],"responses":{"200":{"description":"Requested NLU detection for the given input using the specified NLU domain version","schema":{"$ref":"#/definitions/NluDetectionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.intent.name":"Invalid context provided: intent name is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.entity.name":"Invalid context provided: entity name is not valid.","constraint.validation":"%s","version.untrained":"The version cannot be used for detection as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionDetect"}},"/api/v2/languageunderstanding/domains/{domainId}/versions":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domain Versions for a given Domain.","description":"","operationId":"getLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersions"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The NLU Domain Version to create.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Created an NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersions"}},"/api/v2/license/definitions/{licenseId}":{"get":{"tags":["License"],"summary":"Get PureCloud license definition.","description":"","operationId":"getLicenseDefinition","produces":["application/json"],"parameters":[{"name":"licenseId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinition"}},"/api/v2/license/definitions":{"get":{"tags":["License"],"summary":"Get all PureCloud license definitions available for the organization.","description":"","operationId":"getLicenseDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseDefinition"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinitions"}},"/api/v2/license/infer":{"post":{"tags":["License"],"summary":"Get a list of licenses inferred based on a list of roleIds","description":"","operationId":"postLicenseInfer","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The roleIds to use while inferring licenses","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseInfer"}},"/api/v2/license/toggles/{featureName}":{"get":{"tags":["License"],"summary":"Deprecated - no alternative required. This operation will always return 'true' for requested toggles","description":"","operationId":"getLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseToggle"},"post":{"tags":["License"],"summary":"Deprecated. No alternative required - this endpoint has no effect","description":"","operationId":"postLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-purecloud-method-name":"postLicenseToggle"}},"/api/v2/license/organization":{"post":{"tags":["License"],"summary":"Update the organization's license assignments in a batch.","description":"","operationId":"postLicenseOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The license assignments to update.","required":false,"schema":{"$ref":"#/definitions/LicenseBatchAssignmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseUpdateStatus"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseOrganization"}},"/api/v2/license/users/{userId}":{"get":{"tags":["License"],"summary":"Get licenses for specified user.","description":"","operationId":"getLicenseUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseUser"}},"/api/v2/license/users":{"get":{"tags":["License"],"summary":"Get a page of users and their licenses","description":"Retrieve a page of users in an organization along with the licenses they possess.","operationId":"getLicenseUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicensesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseUsers"},"post":{"tags":["License"],"summary":"Fetch user licenses in a batch.","description":"","operationId":"postLicenseUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user IDs to fetch.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"postLicenseUsers"}},"/api/v2/organizations/limits/changerequests/{requestId}":{"get":{"tags":["Organization"],"summary":"Get a limit change request","description":"","operationId":"getOrganizationsLimitsChangerequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Unique id for the limit change request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitChangeRequestDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequest"}},"/api/v2/organizations/limits/changerequests":{"get":{"tags":["Organization"],"summary":"Get the available limit change requests","description":"Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction.","operationId":"getOrganizationsLimitsChangerequests","produces":["application/json"],"parameters":[{"name":"after","in":"query","description":"Timestamp indicating the date to begin after when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"before","in":"query","description":"Timestamp indicating the date to end before when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"status","in":"query","description":"Status of the request to be filtered by","required":false,"type":"string","enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},{"name":"pageSize","in":"query","description":"Page Size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["statusHistory"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitChangeRequestsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.override.requests":"Only 100 override requests can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequests"}},"/api/v2/organizations/limits/docs":{"get":{"tags":["Organization"],"summary":"Get limit documentation","description":"","operationId":"getOrganizationsLimitsDocs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitDocumentation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocs"}},"/api/v2/organizations/limits/docs/freetrial":{"get":{"tags":["Organization"],"summary":"Get free trial limit documentation","description":"","operationId":"getOrganizationsLimitsDocsFreetrial","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FreeTrialLimitDocs"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocsFreetrial"}},"/api/v2/organizations/limits/namespaces":{"get":{"tags":["Organization"],"summary":"Get the available limit namespaces","description":"","operationId":"getOrganizationsLimitsNamespaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":100,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagedNamespaceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaces"}},"/api/v2/organizations/limits/namespaces/{namespaceName}":{"get":{"tags":["Organization"],"summary":"Get the effective limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespace","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespace"}},"/api/v2/organizations/limits/namespaces/{namespaceName}/defaults":{"get":{"tags":["Organization"],"summary":"Get the default limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespaceDefaults","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch defaults limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaceDefaults"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}":{"get":{"tags":["Log Capture"],"summary":"Gets status of async download execution","description":"","operationId":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"In progress - Download execution is in progress.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"download.file.not.found":"No entries found for user; empty file not uploaded","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs":{"post":{"tags":["Log Capture"],"summary":"Creates an async download execution","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"Accepted - Download execution is accepted.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs"}},"/api/v2/diagnostics/logcapture/browser/entries/query":{"post":{"tags":["Log Capture"],"summary":"Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesQuery","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesQuery"}},"/api/v2/diagnostics/logcapture/browser/users":{"get":{"tags":["Log Capture"],"summary":"Get all log capture enabled users for an org","description":"","operationId":"getDiagnosticsLogcaptureBrowserUsers","produces":["application/json"],"parameters":[{"name":"includeExpired","in":"query","description":"Include expired users with log captures still available for search or download","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagelessEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUsers"}},"/api/v2/diagnostics/logcapture/browser/users/{userId}":{"get":{"tags":["Log Capture"],"summary":"Get log capture configuration for the user","description":"","operationId":"getDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to get browser log capture configuration","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUser"},"post":{"tags":["Log Capture"],"summary":"Enable log capture for a user or update expiration","description":"","operationId":"postDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to enable browser log capture","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserUser"},"delete":{"tags":["Log Capture"],"summary":"Disable browser log capture for the user","description":"","operationId":"deleteDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to disable browser log capture","required":true,"type":"string"}],"responses":{"204":{"description":"Browser log capture successfully disabled for the user"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:delete"]},"x-purecloud-method-name":"deleteDiagnosticsLogcaptureBrowserUser"}},"/api/v2/messaging/settings":{"get":{"tags":["Messaging"],"summary":"Get a list of messaging settings","description":"","operationId":"getMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettings"},"post":{"tags":["Messaging"],"summary":"Create a messaging setting","description":"","operationId":"postMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postMessagingSettings"}},"/api/v2/messaging/settings/default":{"get":{"tags":["Messaging"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"getMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettingsDefault"},"put":{"tags":["Messaging"],"summary":"Set the organization's default settings that may be applied to an integration when it is created.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"putMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Setting ID","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putMessagingSettingsDefault"},"delete":{"tags":["Messaging"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"deleteMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSettingsDefault"}},"/api/v2/messaging/settings/{messageSettingId}":{"get":{"tags":["Messaging"],"summary":"Get a messaging setting","description":"","operationId":"getMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSetting"},"delete":{"tags":["Messaging"],"summary":"Delete a messaging setting","description":"","operationId":"deleteMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSetting"},"patch":{"tags":["Messaging"],"summary":"Update a messaging setting","description":"","operationId":"patchMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchMessagingSetting"}},"/api/v2/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Messaging"],"summary":"Get a supported content profile","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"getMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Messaging"],"summary":"Delete a supported content profile","description":"Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"deleteMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Messaging"],"summary":"Update a supported content profile","description":"Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"patchMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchMessagingSupportedcontentSupportedContentId"}},"/api/v2/messaging/supportedcontent":{"get":{"tags":["Messaging"],"summary":"Get a list of Supported Content profiles","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"getMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontent"},"post":{"tags":["Messaging"],"summary":"Create a Supported Content profile","description":"Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"postMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postMessagingSupportedcontent"}},"/api/v2/users/{userId}/verifiers":{"get":{"tags":["Users"],"summary":"Get a list of verifiers","description":"","operationId":"getUserVerifiers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VerifierEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:view"]},"x-purecloud-method-name":"getUserVerifiers"}},"/api/v2/users/{userId}/verifiers/{verifierId}":{"put":{"tags":["Users"],"summary":"Update a verifier","description":"","operationId":"putUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Verifier Update","required":true,"schema":{"$ref":"#/definitions/UpdateVerifierRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Verifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:edit"]},"x-purecloud-method-name":"putUserVerifier"},"delete":{"tags":["Users"],"summary":"Delete a verifier","description":"","operationId":"deleteUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"}],"responses":{"204":{"description":"The verifier was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:delete"]},"x-purecloud-method-name":"deleteUserVerifier"}},"/api/v2/ipranges":{"get":{"tags":["Utilities"],"summary":"Get public ip address ranges for Genesys Cloud","description":"","operationId":"getIpranges","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressRangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getIpranges"}},"/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}":{"get":{"tags":["Web Deployments"],"summary":"Retrieves a cobrowse session","description":"","operationId":"getWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWebdeploymentsDeploymentCobrowseSessionId"},"delete":{"tags":["Web Deployments"],"summary":"Deletes a cobrowse session","description":"","operationId":"deleteWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"deleteWebdeploymentsDeploymentCobrowseSessionId"}},"/api/v2/journey/deployments/{deploymentId}/actionevent":{"post":{"tags":["Journey"],"summary":"Sends an action event, which is used for changing the state of actions that have been offered to the user.","description":"","operationId":"postJourneyDeploymentActionevent","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the beacon.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ActionEventRequest"}}],"responses":{"204":{"description":"Successfully transitioned the actions state. This does not return the action."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"There was an issue with this transition. The reason is returned in the body.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Event Collection is not enabled","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action":"The Action, Deployment, or Session was not was found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action.state":"Invalid Action state transition"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentActionevent"}},"/api/v2/journey/deployments/{deploymentId}/appevents":{"post":{"tags":["Journey"],"summary":"Send a journey app event, used for tracking customer activity on an application.","description":"","operationId":"postJourneyDeploymentAppevents","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the app event.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AppEventRequest"}}],"responses":{"200":{"description":"Request completed successfully.","schema":{"$ref":"#/definitions/AppEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"The app event on the request is older than the start date of the active session and will not be processed."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentAppevents"}},"/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping":{"get":{"tags":["Journey"],"summary":"Send a ping.","description":"","operationId":"getJourneyDeploymentCustomerPing","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the ping.","required":true,"type":"string"},{"name":"customerCookieId","in":"path","description":"ID of the customer associated with the ping.","required":true,"type":"string"},{"name":"dl","in":"query","description":"Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.","required":false,"type":"string"},{"name":"dt","in":"query","description":"Document Title. A human readable name for the page or screen","required":false,"type":"string"},{"name":"appNamespace","in":"query","description":"Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session","required":false,"type":"string"},{"name":"sinceLastBeaconMilliseconds","in":"query","description":"How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeploymentPing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unauthorized to send ping request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","server.unavailable":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getJourneyDeploymentCustomerPing"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback":{"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeGuestSessionDocumentFeedback","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentFeedback"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get a knowledge document by ID.","description":"","operationId":"getKnowledgeGuestSessionDocument","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocument"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeGuestSessionDocuments","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocuments"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view event for a document.","description":"","operationId":"postKnowledgeGuestSessionDocumentViews","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentViews"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentCopies","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentCopies"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsPresentations"}},"/api/v2/knowledge/guest/sessions/{sessionId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeGuestSessionCategories","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GuestCategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionCategories"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search":{"post":{"tags":["Knowledge"],"summary":"Search the documents in a guest session.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearch","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields, if any, to expand for each document in the search result matching the query.","required":false,"type":"array","items":{"type":"string","enum":["documentVariations","documentAlternatives"]},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentGuestSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentGuestSearch"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"The minimum characters for the query is 3.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearch"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearchSuggestions"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeGuestSessionDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid document Id.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Search not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"patchKnowledgeGuestSessionDocumentsSearchSearchId"}},"/api/v2/knowledge/guest/sessions":{"post":{"tags":["Knowledge"],"summary":"Create guest session","description":"","operationId":"postKnowledgeGuestSessions","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeGuestSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"support.center.knowledge.base.id.not.set":"Knowledge base id is not set in support center configuration (when app.type is SupportCenter).","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","messenger.knowledge.base.not.enabled":"The knowledge base app is not enabled in the messenger deployment (when app.type is MessengerKnowledgeApp).","invalid.context.specified":"The context not found in the knowledgebase.","messenger.knowledge.base.id.not.set":"The knowledge base id is not set in the messenger deployment (when app.type is MessengerKnowledgeApp).","constraint.validation":"%s","app.not.found":"The app not found by deploymentId.","knowledge.base.not.found":"The knowledge base specified in the deployment configuration was not found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","support.center.not.enabled":"Support center is not enabled in the deployment (when app.type is SupportCenter)."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessions"}},"/api/v2/quality/surveys/scorable":{"get":{"tags":["Quality"],"summary":"Get a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"getQualitySurveysScorable","produces":["application/json"],"parameters":[{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.form.context.doesnt.have.valid.published.version":"All published versions of this survey form have been disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getQualitySurveysScorable"},"put":{"tags":["Quality"],"summary":"Update a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"putQualitySurveysScorable","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"survey","required":true,"schema":{"$ref":"#/definitions/ScorableSurvey"}},{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.unauthenticated.already.finished":"The survey is already finished.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"putQualitySurveysScorable"}},"/api/v2/documentation/search":{"get":{"tags":["Search"],"summary":"Search documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationSearch"},"post":{"tags":["Search"],"summary":"Search documentation","description":"","operationId":"postDocumentationSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationSearch"}},"/api/v2/documentation/gkn/search":{"get":{"tags":["Search"],"summary":"Search gkn documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationGknSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationGknSearch"},"post":{"tags":["Search"],"summary":"Search gkn documentation","description":"","operationId":"postDocumentationGknSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GKNDocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationGknSearch"}},"/api/v2/webchat/guest/conversations":{"post":{"tags":["WebChat"],"summary":"Create an ACD chat conversation from an external customer.","description":"This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.\n The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted.\n The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","operationId":"postWebchatGuestConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateConversationRequest","required":true,"schema":{"$ref":"#/definitions/CreateWebChatConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateWebChatConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.journeycontext.customer":"The customer may not be null.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapversion":"The actionmapversion property may not be null.","chat.error.invalid.queue":"The specified queue is not valid.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionid":"The actionid property may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","chat.error.notnull.createconversationrequest.journeycontext.customer.customerid":"The customerid property may not be null.","constraint.validation":"%s","chat.error.notnull.createconversationrequest.memberinfo.displayname":"The displayname property may not be null.","chat.error.notnull.createconversationrequest.routingtarget":"The routingtarget property may not be null.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","chat.error.notnull.createconversationrequest.journeycontext.customer.customeridtype":"The customeridtype property may not be null.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","chat.deployment.require.auth":"The deployment requires the customer member to be authenticated.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionid":"The sessionid property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionidtype":"The sessionidtype property may not be null.","chat.deployment.bad.auth":"The customer member authentication has failed.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapid":"The actionmapid property may not be null.","chat.error.createconversationrequest.routingtarget":"The routing target is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.deployment.disabled":"The web chat deployment is currently disabled.","chat.error.pattern.createconversationrequest.deploymentid":"The deploymentid property may not be null.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.invalid.flow":"Invalid chat flow","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.bad.request":"Error occurred due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"origin.not.allowed":"Not allowed to create an ACD chat conversation from an external customer.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"caht.error":"Error performing chat conversation operation.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.service.timeout":"Chat service timeout error.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebchatGuestConversations"}},"/api/v2/webdeployments/token/refresh":{"post":{"tags":["Web Deployments"],"summary":"Refresh a JWT.","description":"","operationId":"postWebdeploymentsTokenRefresh","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WebDeploymentsRefreshJWTRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenRefresh"}},"/api/v2/webdeployments/token/oauthcodegrantjwtexchange":{"post":{"tags":["Web Deployments"],"summary":"Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.","description":"","operationId":"postWebdeploymentsTokenOauthcodegrantjwtexchange","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webDeploymentsOAuthExchangeRequest","required":true,"schema":{"$ref":"#/definitions/WebDeploymentsOAuthExchangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentsAuthorizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenOauthcodegrantjwtexchange"}},"/api/v2/workforcemanagement/calendar/data/ics":{"get":{"tags":["Workforce Management"],"summary":"Get ics formatted calendar based on shareable link","description":"","operationId":"getWorkforcemanagementCalendarDataIcs","produces":["text/calendar"],"parameters":[{"name":"calendarId","in":"query","description":"The id of the ics-formatted calendar","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Query parameter did not pass validation","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden form getting calendar","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Calendar ICS not found","not.found":"The requested entity was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWorkforcemanagementCalendarDataIcs"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getNotificationsAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","enforced","schema","visibility","transports","publicApiTemplateUriPaths","requiresPermissions","permissionDetails","topicParameters"]},"collectionFormat":"multi"},{"name":"includePreview","in":"query","description":"Whether or not to include Preview topics","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsAvailabletopics"}},"/api/v2/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getNotificationsChannels","produces":["application/json"],"parameters":[{"name":"includechannels","in":"query","description":"Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence.","required":false,"type":"string","default":"token","enum":["token","oauthclient"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.","operationId":"postNotificationsChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannels"}},"/api/v2/notifications/channels/{channelId}":{"head":{"tags":["Notifications"],"summary":"Verify a channel still exists and is valid","description":"Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't","operationId":"headNotificationsChannel","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"headNotificationsChannel"}},"/api/v2/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannelSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}},{"name":"ignoreErrors","in":"query","description":"Optionally prevent throwing of errors for failed permissions checks.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions","notification.transport.not.allowed":"unable to subscribe, transport type not permitted.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","notification.unable.to.get.channel.id":"Unable to get channel Id.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannelSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}},{"name":"ignoreErrors","in":"query","description":"Optionally prevent throwing of errors for failed permissions checks.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","notification.unable.to.get.channel.id":"Unable to get channel id.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","notification.forbidden.topic":"Topic is forbidden","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"putNotificationsChannelSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"deleteNotificationsChannelSubscriptions"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putIdentityprovidersAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersAdfs"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putIdentityprovidersCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersCic"}},"/api/v2/identityproviders/gsuite":{"get":{"tags":["Identity Provider"],"summary":"Get G Suite Identity Provider","description":"","operationId":"getIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GSuite"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGsuite"},"put":{"tags":["Identity Provider"],"summary":"Update/Create G Suite Identity Provider","description":"","operationId":"putIdentityprovidersGsuite","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GSuite"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGsuite"},"delete":{"tags":["Identity Provider"],"summary":"Delete G Suite Identity Provider","description":"","operationId":"deleteIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGsuite"}},"/api/v2/identityproviders/generic":{"get":{"tags":["Identity Provider"],"summary":"Get Generic SAML Identity Provider","description":"","operationId":"getIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenericSAML"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGeneric"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Generic SAML Identity Provider","description":"","operationId":"putIdentityprovidersGeneric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GenericSAML"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a generic SAML provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGeneric"},"delete":{"tags":["Identity Provider"],"summary":"Delete Generic SAML Identity Provider","description":"","operationId":"deleteIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGeneric"}},"/api/v2/identityproviders/identitynow":{"get":{"tags":["Identity Provider"],"summary":"Get IdentityNow Provider","description":"","operationId":"getIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersIdentitynow"},"put":{"tags":["Identity Provider"],"summary":"Update/Create IdentityNow Provider","description":"","operationId":"putIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/IdentityNow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersIdentitynow"},"delete":{"tags":["Identity Provider"],"summary":"Delete IdentityNow Provider","description":"","operationId":"deleteIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersIdentitynow"}},"/api/v2/identityproviders/{providerId}":{"get":{"tags":["Identity Provider"],"summary":"Get Identity Provider","description":"","operationId":"getIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovider"},"put":{"tags":["Identity Provider"],"summary":"Update Identity Provider","description":"","operationId":"putIdentityprovider","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}},{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovider"},"delete":{"tags":["Identity Provider"],"summary":"Delete Identity Provider","description":"","operationId":"deleteIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"204":{"description":"The provider has been deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovider"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityproviders"},"post":{"tags":["Identity Provider"],"summary":"Create Identity Provider","description":"","operationId":"postIdentityproviders","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add"]},"x-purecloud-method-name":"postIdentityproviders"}},"/api/v2/oauth/authorizations/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get a client that is authorized by the resource owner","description":"","operationId":"getOauthAuthorization","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"},{"name":"clientId","in":"path","description":"The ID of client","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorization"}},"/api/v2/oauth/authorizations":{"get":{"tags":["OAuth"],"summary":"List clients that have been authorized, requested, or revoked by the resource owner","description":"","operationId":"getOauthAuthorizations","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorizations"}},"/api/v2/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClient"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"Client is disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"putOauthClient"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.client":"Clients must be marked as inactive to be eligible for deletion."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:delete"]},"x-purecloud-method-name":"deleteOauthClient"}},"/api/v2/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postOauthClientSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"postOauthClientSecret"}},"/api/v2/oauth/clients/{clientId}/usage/query":{"post":{"tags":["OAuth","Usage"],"summary":"Query for OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postOauthClientUsageQuery","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageClientQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"postOauthClientUsageQuery"}},"/api/v2/oauth/clients/{clientId}/usage/summary":{"get":{"tags":["OAuth","Usage"],"summary":"Get a summary of OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"getOauthClientUsageSummary","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"name":"days","in":"query","description":"Previous number of days to query","required":false,"type":"string","default":"7"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageSummary"}},"/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}":{"get":{"tags":["OAuth","Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getOauthClientUsageQueryResult","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"},{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageQueryResult"}},"/api/v2/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getOauthClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postOauthClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"New clients can only have an active state","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","auth.invalid.scope":"Client has invalid scope","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","auth.too.many.clients":"Too many clients exist in this organization.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:add"]},"x-purecloud-method-name":"postOauthClients"}},"/api/v2/oauth/scopes/{scopeId}":{"get":{"tags":["OAuth"],"summary":"An OAuth scope","description":"","operationId":"getOauthScope","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"Scope ID","required":true,"type":"string"},{"name":"Accept-Language","in":"header","description":"The language with which to display the scope description.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScope"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScope"}},"/api/v2/oauth/scopes":{"get":{"tags":["OAuth"],"summary":"The list of OAuth scopes","description":"","operationId":"getOauthScopes","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language with which to display the scope descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScopeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScopes"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"summary":"Get Okta Identity Provider","description":"","operationId":"getIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOkta"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putIdentityprovidersOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOkta"},"delete":{"tags":["Identity Provider"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOkta"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOnelogin"},"put":{"tags":["Identity Provider"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putIdentityprovidersOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOnelogin"},"delete":{"tags":["Identity Provider"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOnelogin"}},"/api/v2/identityproviders/ping":{"get":{"tags":["Identity Provider"],"summary":"Get Ping Identity Provider","description":"","operationId":"getIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PingIdentity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPing"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Ping Identity Provider","description":"","operationId":"putIdentityprovidersPing","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PingIdentity"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPing"},"delete":{"tags":["Identity Provider"],"summary":"Delete Ping Identity Provider","description":"","operationId":"deleteIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPing"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPurecloud"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putIdentityprovidersPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPurecloud"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deleteIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPurecloud"}},"/api/v2/identityproviders/pureengage":{"get":{"tags":["Identity Provider"],"summary":"Get PureEngage Identity Provider","description":"","operationId":"getIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureEngage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPureengage"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureEngage Identity Provider","description":"","operationId":"putIdentityprovidersPureengage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureEngage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPureengage"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureEngage Identity Provider","description":"","operationId":"deleteIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPureengage"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersSalesforce"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putIdentityprovidersSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersSalesforce"},"delete":{"tags":["Identity Provider"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersSalesforce"}},"/api/v2/usage/events/definitions":{"get":{"tags":["Operational Events"],"summary":"Get all operational event definitions","description":"","operationId":"getUsageEventsDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinitions"}},"/api/v2/usage/events/definitions/{eventDefinitionId}":{"get":{"tags":["Operational Events"],"summary":"Get an operational event definition by its id","description":"","operationId":"getUsageEventsDefinition","produces":["application/json"],"parameters":[{"name":"eventDefinitionId","in":"path","description":"EventDefinition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Event definition not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinition"}},"/api/v2/organizations/embeddedintegration":{"get":{"tags":["Organization"],"summary":"Get the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsEmbeddedintegration"},"put":{"tags":["Organization"],"summary":"Update the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/EmbeddedIntegration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsEmbeddedintegration"}},"/api/v2/organizations/ipaddressauthentication":{"get":{"tags":["Organization"],"summary":"Get organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsIpaddressauthentication"},"put":{"tags":["Organization"],"summary":"Update organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"IP address Whitelist settings","required":true,"schema":{"$ref":"#/definitions/IpAddressAuthentication"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.issuing.ip.address":"IP address whitelisting cannot be configured with a token that was issued outside of the allowed ranges.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.ip.address":"IP address whitelisting cannot be configured from outside of the allowed ranges.","invalid.host.address":"IP address whitelisting cannot be configured via requests made to this host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsIpaddressauthentication"}},"/api/v2/organizations/whitelist":{"get":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"getOrganizationsWhitelist","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsWhitelist"},"put":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"putOrganizationsWhitelist","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/OrgWhitelistSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsWhitelist"}},"/api/v2/organizations/authentication/settings":{"get":{"tags":["Organization"],"summary":"Gets the organization's settings","description":"","operationId":"getOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsAuthenticationSettings"},"patch":{"tags":["Organization"],"summary":"Update the organization's settings","description":"","operationId":"patchOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Org settings","required":true,"schema":{"$ref":"#/definitions/OrgAuthSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsAuthenticationSettings"}},"/api/v2/orgauthorization/trustees/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustee Audits","description":"","operationId":"postOrgauthorizationTrusteesAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrusteeAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Cloned User","description":"","operationId":"getOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorCloneduser"},"put":{"tags":["Organization Authorization"],"summary":"Creates a clone of the trustee user in the trustor org.","description":"","operationId":"putOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorCloneduser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Cloned User","description":"","operationId":"deleteOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorCloneduser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users in the trustor organization (i.e. users with a native user record).","description":"","operationId":"getOrgauthorizationTrustorClonedusers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorClonedusers"}},"/api/v2/orgauthorization/trustees/default":{"get":{"tags":["Organization Authorization"],"summary":"Get organization authorization trust with Customer Care, if one exists.","description":"","operationId":"getOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteesDefault"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.","description":"","operationId":"postOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[{"name":"assignDefaultRole","in":"query","description":"Assign Admin role to default pairing with Customer Care","required":false,"type":"boolean"},{"name":"autoExpire","in":"query","description":"Automatically expire pairing after 30 days","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.fields.validation.error":"One or more required properties are missing","self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesDefault"}},"/api/v2/orgauthorization/pairings/{pairingId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Pairing Info","description":"","operationId":"getOrgauthorizationPairing","produces":["application/json"],"parameters":[{"name":"pairingId","in":"path","description":"Pairing Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationPairing"}},"/api/v2/orgauthorization/pairings":{"post":{"tags":["Organization Authorization"],"summary":"A pairing id is created by the trustee and given to the trustor to create a trust.","description":"","operationId":"postOrgauthorizationPairings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Pairing Info","required":true,"schema":{"$ref":"#/definitions/TrustRequestCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:add"]},"x-purecloud-method-name":"postOrgauthorizationPairings"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroup"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group Roles","description":"","operationId":"getOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroupRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group Roles","description":"","operationId":"deleteOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroupRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee groups for this organization (i.e. groups granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroups"},"post":{"tags":["Organization Authorization"],"summary":"Add a group to the trust.","description":"","operationId":"postOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeGroups"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustee"},"put":{"tags":["Organization Authorization"],"summary":"Update Org Trust","description":"","operationId":"putOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/TrustUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrustee"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustee"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUser"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User Roles","description":"","operationId":"getOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUserRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User Roles","description":"","operationId":"deleteOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUserRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee users for this organization (i.e. users granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUsers"},"post":{"tags":["Organization Authorization"],"summary":"Add a user to the trust.","description":"","operationId":"postOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","trustee.user.not.found":"Trustee user not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeUsers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users from the trustee organization (i.e. users with a native user record).","description":"There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged","operationId":"getOrgauthorizationTrusteeClonedusers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeClonedusers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}":{"delete":{"tags":["Organization Authorization"],"summary":"Deletes cloned user","description":"","operationId":"deleteOrgauthorizationTrusteeCloneduser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Id of the cloned user to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Cloned user successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeCloneduser"}},"/api/v2/orgauthorization/trustor/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustor Audits","description":"","operationId":"postOrgauthorizationTrustorAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrustorAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrustorAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroup"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee Group to the trust.","description":"","operationId":"putOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorGroup"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of groups in the trustor organization (i.e. groups granted access).","description":"","operationId":"getOrgauthorizationTrustorGroups","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroups"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustor"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustor"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUser"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee user to the trust.","description":"","operationId":"putOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorUser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of users in the trustor organization (i.e. users granted access).","description":"","operationId":"getOrgauthorizationTrustorUsers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUsers"}},"/api/v2/orgauthorization/trustors":{"get":{"tags":["Organization Authorization"],"summary":"The list of organizations that have authorized/trusted your organization.","description":"","operationId":"getOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustors"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustors","description":"","operationId":"deleteOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustor ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustors deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"min.trustor.ids":"Minimum of 1 Trustor Org Id required.","max.trustor.ids":"Only 25 Trustors can be deleted at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustors","x-genesys-preview":true}},"/api/v2/orgauthorization/trustees":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustees for this organization (i.e. organizations granted access to this organization).","description":"","operationId":"getOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustees"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust. This is required to grant other organizations access to your organization.","description":"","operationId":"postOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","pairing.id.required":"A valid pairingId is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","trustee.user.required":"At least one trustee user is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrustees"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustees","description":"","operationId":"deleteOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustee ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustees deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","min.trustee.ids":"Minimum of 1 Trustee Org Id required.","max.trustee.ids":"Only 25 Trustees can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustees","x-genesys-preview":true}},"/api/v2/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"User was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated OutOffOffice","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserOutofoffice"}},"/api/v2/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueEstimatedwaittime"}},"/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueMediatypeEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"mediaType","in":"path","description":"mediaType","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueMediatypeEstimatedwaittime"}},"/api/v2/users/presences/purecloud/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source","description":"","operationId":"getUsersPresencesPurecloudBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresencesPurecloudBulk"}},"/api/v2/users/presences/{sourceId}/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a single presence source","description":"","operationId":"getUsersPresenceBulk","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"The requested presence source ID.","required":true,"type":"string"},{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresenceBulk"}},"/api/v2/users/presences/bulk":{"put":{"tags":["Presence"],"summary":"Update bulk user Presences","description":"","operationId":"putUsersPresencesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MutableUserPresence"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be updated at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","endpoint.does.not.support.on.queue":"The endpoint does not support updating to the ON_QUEUE presence"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:edit"]},"x-purecloud-method-name":"putUsersPresencesBulk"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"getPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresencedefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)","description":"","operationId":"putPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresencedefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"deletePresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:delete"]},"x-purecloud-method-name":"deletePresencedefinition"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted query can be TRUE, FALSE or ALL","required":false,"type":"string","default":"false"},{"name":"localeCode","in":"query","description":"The locale code to fetch for each presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresencedefinitions"}},"/api/v2/presence/definitions/{definitionId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","description":"","operationId":"getPresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","description":"","operationId":"putPresenceDefinition","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Definition","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresenceDefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","description":"","operationId":"deletePresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence Definition successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:presenceDefinition:delete","presence:presenceDefinition:edit"]},"x-purecloud-method-name":"deletePresenceDefinition"}},"/api/v2/presence/definitions":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Definitions","description":"","operationId":"getPresenceDefinitions","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"},{"name":"divisionId","in":"query","description":"One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinitionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresenceDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresenceDefinitions"}},"/api/v2/presence/settings":{"get":{"tags":["Presence"],"summary":"Get the presence settings","description":"","operationId":"getPresenceSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:view"]},"x-purecloud-method-name":"getPresenceSettings"},"put":{"tags":["Presence"],"summary":"Update the presence settings","description":"","operationId":"putPresenceSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Presence Settings","required":true,"schema":{"$ref":"#/definitions/PresenceSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationconfiguration.invalidrestoretimemilliseconds":"Restore time value out of bounds","presenceservice.organizationconfiguration.restorepresenceconfigurationnotprovided":"A restore configuration object must be provided"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:edit"]},"x-purecloud-method-name":"putPresenceSettings"}},"/api/v2/presence/sources/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Source","description":"","operationId":"getPresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSource"},"put":{"tags":["Presence"],"summary":"Update a Presence Source","description":"","operationId":"putPresenceSource","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Source","required":true,"schema":{"$ref":"#/definitions/Source"}},{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.systemsourcescannotbeupdated":"A source of type 'system' cannot be updated","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:edit"]},"x-purecloud-method-name":"putPresenceSource"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Source","description":"","operationId":"deletePresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence source successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:source:delete","presence:source:edit"]},"x-purecloud-method-name":"deletePresenceSource"}},"/api/v2/presence/sources":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Sources","description":"","operationId":"getPresenceSources","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SourceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSources"},"post":{"tags":["Presence"],"summary":"Create a Presence Source","description":"","operationId":"postPresenceSources","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Source to create","required":true,"schema":{"$ref":"#/definitions/Source"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:add"]},"x-purecloud-method-name":"postPresenceSources"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SystemPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getSystempresences"}},"/api/v2/users/{userId}/presences/purecloud":{"get":{"tags":["Presence"],"summary":"Get a user's Genesys Cloud presence.","description":"Get the default Genesys Cloud user presence source PURECLOUD","operationId":"getUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresencesPurecloud"},"patch":{"tags":["Presence"],"summary":"Patch a Genesys Cloud user's presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresencesPurecloud"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.","operationId":"getUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresence"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresence"}},"/api/v2/presence/users/{userId}/primarysource":{"get":{"tags":["Presence"],"summary":"Get a user's Primary Presence Source","description":"","operationId":"getPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:view"]},"x-purecloud-method-name":"getPresenceUserPrimarysource"},"put":{"tags":["Presence"],"summary":"Update a user's Primary Presence Source","description":"","operationId":"putPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Primary Source","required":true,"schema":{"$ref":"#/definitions/UserPrimarySource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:edit"]},"x-purecloud-method-name":"putPresenceUserPrimarysource"}},"/api/v2/processautomation/triggers/topics/{topicName}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of all organization Triggers on given topic using provided event body","description":"","operationId":"postProcessautomationTriggersTopicTest","produces":["application/json"],"parameters":[{"name":"topicName","in":"path","description":"topicName","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeEventResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggersTopicTest"}},"/api/v2/processautomation/triggers/topics":{"get":{"tags":["Process Automation"],"summary":"Get topics available for organization","description":"","operationId":"getProcessautomationTriggersTopics","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggersTopics"}},"/api/v2/processautomation/triggers/{triggerId}":{"get":{"tags":["Process Automation"],"summary":"Retrieve a single Trigger matching id","description":"","operationId":"getProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTrigger"},"put":{"tags":["Process Automation"],"summary":"Update a Trigger","description":"","operationId":"putProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)","required":true,"schema":{"$ref":"#/definitions/UpdateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit"]},"x-purecloud-method-name":"putProcessautomationTrigger"},"delete":{"tags":["Process Automation"],"summary":"Delete a Trigger","description":"","operationId":"deleteProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:delete"]},"x-purecloud-method-name":"deleteProcessautomationTrigger"}},"/api/v2/processautomation/triggers/{triggerId}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of a Trigger based on provided event body","description":"","operationId":"postProcessautomationTriggerTest","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggerTest"}},"/api/v2/processautomation/triggers":{"get":{"tags":["Process Automation"],"summary":"Retrieves all triggers, optionally filtered by query parameters.","description":"","operationId":"getProcessautomationTriggers","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"topicName","in":"query","description":"Topic name(s). Separated by commas","required":false,"type":"string"},{"name":"enabled","in":"query","description":"Boolean indicating desired enabled state of triggers","required":false,"type":"boolean"},{"name":"hasDelayBy","in":"query","description":"Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TriggerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggers"},"post":{"tags":["Process Automation"],"summary":"Create a Trigger","description":"","operationId":"postProcessautomationTriggers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create a Trigger.","required":true,"schema":{"$ref":"#/definitions/CreateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:add"]},"x-purecloud-method-name":"postProcessautomationTriggers"}},"/api/v2/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users","operationId":"getQualityAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents requested","required":false,"type":"string"},{"name":"formContextId","in":"query","description":"shared id between form versions","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityAgentsActivity"}},"/api/v2/recording/batchrequests/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status and results for a batch request job, only the user that submitted the job may retrieve results","description":"","operationId":"getRecordingBatchrequest","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobStatusResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","batch.download.permission.denied":"Only user that initiated the job can request results","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","batch.download.job.not.found":"The requested job is unknown"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"getRecordingBatchrequest"}},"/api/v2/recording/batchrequests":{"post":{"tags":["Recording"],"summary":"Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.","description":"","operationId":"postRecordingBatchrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job submission criteria","required":true,"schema":{"$ref":"#/definitions/BatchDownloadJobSubmission"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobSubmissionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.too.many.items":"Too many items requested, max 100 allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","batch.download.bad.request":"Request list is required and must not be empty","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"postRecordingBatchrequests"}},"/api/v2/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id. Requires either calibrator id or conversation id","description":"","operationId":"getQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","quality.calibration.view.permission.check.failed":"calibration view permission check failed","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibration"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":true,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.already.exists":"evaluation already exists","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.update.permission.check.failed":"calibration update permission check failed","quality.calibration.scoring.index.conversation.mismatch":"calibration scoring index did not match the expected value.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:edit"]},"x-purecloud-method-name":"putQualityCalibration"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.calibration.delete.permission.check.failed":"calibration delete permission check failed"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:delete"]},"x-purecloud-method-name":"deleteQualityCalibration"}},"/api/v2/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.","operationId":"getQualityCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postQualityCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":true,"schema":{"$ref":"#/definitions/CalibrationCreate"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.no.evaluation.form.or.context.id":"evaluation form or context id missing","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.calibration.create.error.no.evaluators":"Failed to create calibration because the specified evaluators do not exist.","quality.evaluation.agent.doesnt.have.participate.permission":"Agent does not have evaluation participate permission","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.form.context.doesnt.exist":"Evaluation form context doesn't exist","quality.calibration.scoring.index.evaluator.must.match.calibrator.or.expert.evaluator":"scoring index evaluator must be a calibrator or expert evaluator","qm.calibration.create.error.no.agent":"Failed to create calibration because the conversation has no agent user","constraint.validation":"%s","quality.calibration.existing.evaluation.not.finished":"Existing evaluation is not finished for calibration","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","quality.calibration.no.existing.evaluation.for.evaluationid":"no evaluation found for existing evaluation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.contextid.doesnt.match.evaluation.contextid":"Calibration contextId doesn't match the evaluation contextId","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.conversation.doesnt.exist":"unable to find specified conversation","qm.calibration.create.error.no.conversation":"Failed to create calibration because the specified conversation does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.calibration.create.permission.check.failed":"Calibration create permission check failed","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:add"]},"x-purecloud-method-name":"postQualityCalibrations"}},"/api/v2/quality/conversations/audits/query/{transactionId}":{"get":{"tags":["Quality"],"summary":"Get status of audit query execution","description":"","operationId":"getQualityConversationsAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"Query execution completed.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionId"}},"/api/v2/quality/conversations/audits/query/{transactionId}/results":{"get":{"tags":["Quality"],"summary":"Get results of audit query","description":"","operationId":"getQualityConversationsAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionIdResults"}},"/api/v2/quality/conversations/audits/query":{"post":{"tags":["Quality"],"summary":"Create audit query execution","description":"","operationId":"postQualityConversationsAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QMAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"postQualityConversationsAuditsQuery"}},"/api/v2/recordings/deletionprotection":{"post":{"tags":["Recording"],"summary":"Get a list of conversations with protected recordings","description":"","operationId":"postRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"conversationIds","required":true,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.id.not.uuid":"Request needs recording conversation ID not UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings:readonly"]}],"x-purecloud-method-name":"postRecordingsDeletionprotection"},"put":{"tags":["Recording"],"summary":"Apply or revoke recording protection for conversations","description":"","operationId":"putRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"name":"protect","in":"query","description":"Check for apply, uncheck for revoke (each action requires the respective permission)","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.empty.payload":"Recording payload was empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:deletionProtection:apply","recording:deletionProtection:revoke"]},"x-purecloud-method-name":"putRecordingsDeletionprotection"}},"/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, assignee, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view","quality:evaluation:assign","quality:evaluation:release"]},"x-purecloud-method-name":"getQualityConversationEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.","operationId":"putQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm, assignee, evaluator","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","quality.evaluation.cannot.change.evaluation.form":"Cannot change evaluation form","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.cannot.change.evaluationid":"Cannot change evaluationId","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have participate permission.","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.invalid.state.non.pending.to.pending":"Invalid state, non pending to pending","quality.evaluation.agent.doesnt.exist":"Agent doesn't exist","quality.evaluation.cannot.have.different.assignee.and.evaluator":"Evaluation has an invalid combination of evaluator & assignee ids","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.no.answers.for.state":"No answers were found for state.","quality.evaluation.cannot.change.conversation":"Cannot change conversation","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.assignee.not.provided":"Evaluation has missing assignee user","quality.evaluation.cannot.assign.released.evaluation":"Evaluation cannot be assigned in completed & released state.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.calibration.and.release.date.both.set":"Calibration and release date both set","quality.evaluation.cannot.change.calibration":"Cannot change calibration","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.evaluation.required.answers.for.state":"Answers are required for state","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.too.old.to.score":"Evaluation is too old to score"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","quality.evaluation.update.permission.check.failed":"Missing evaluation update permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.cannot.change.assignee":"User has insufficient permissions to update assignee","quality.evaluation.assignee.permission.check.failed":"Assignee has insufficient permissions","quality.evaluation.cannot.update.private.comments":"User has insufficient permissions to update private comments"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.no.answer.for.state":"No answers for state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:edit","quality:evaluation:editScore","quality:evaluation:editAgentSignoff"]},"x-purecloud-method-name":"putQualityConversationEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.delete.permission.check.failed":"Failed evaluation deletion permission check","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:delete"]},"x-purecloud-method-name":"deleteQualityConversationEvaluation"}},"/api/v2/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postQualityConversationEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/EvaluationCreateBody"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have required permission to participate","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.answers.for.pending.state":"Evaluation answers for pending state.","quality.evaluation.agent.doesnt.exist":"Agent user does not exist","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.already.exists":"An evaluation for this conversation already exists","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.for.pending.state":"Answers required for pending state","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.no.answers.for.finished.state":"No answers for finished state","quality.evaluation.create.limit.exceeded.for.agent":"Evaluation creation limit exceeded for agent","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","qm.evaluation.create.error.no.evaluator":"Submitted evaluation missing evaluator","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.conversation.doesnt.exist":"Quality conversation does not exist.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.form.not.published":"Evaluation form is not published"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.create.permission.check.failed":"Failed evaluation creation permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:add"]},"x-purecloud-method-name":"postQualityConversationEvaluations"}},"/api/v2/quality/conversations/{conversationId}/surveys":{"get":{"tags":["Quality"],"summary":"Get the surveys for a conversation","description":"","operationId":"getQualityConversationSurveys","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Survey"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Query conversation was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualityConversationSurveys"}},"/api/v2/quality/evaluations/aggregates/query/me":{"post":{"tags":["Quality"],"summary":"Query for evaluation aggregates for the current user","description":"","operationId":"postQualityEvaluationsAggregatesQueryMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQueryMe"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postQualityEvaluationsAggregatesQueryMe"}},"/api/v2/quality/forms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityFormsEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsEvaluation"}},"/api/v2/quality/forms/evaluations/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormsEvaluationVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationVersions"}},"/api/v2/quality/forms/evaluations/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest published evaluation form versions by context ids","description":"","operationId":"getQualityFormsEvaluationsBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid evaluation form context ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EvaluationFormResponse"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.no.ids.bulk.fetch":"You must specify at least 1 id","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","evaluation.too.many.ids.bulk.fetch":"You may only specify 100 or less ids","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationsBulkContexts"}},"/api/v2/quality/forms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.\nIn addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.","operationId":"getQualityFormsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluations"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityFormsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityFormsEvaluations"}},"/api/v2/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.","operationId":"getQualityEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"NOTE: Does not work when querying evaluations","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"NOTE: Does not work when querying evaluations","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"assigneeUserId","in":"query","description":"assignee user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"formContextId","in":"query","description":"shared id between form versions","required":false,"type":"string"},{"name":"evaluationState","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"the maximum number of results to return","required":false,"type":"integer","format":"int32"},{"name":"sortOrder","in":"query","description":"NOTE: Does not work when conversationId is supplied.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.query.invalid.user":"User does not exist","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation":"Quality query needs one agent, evaluator, or assignee, or conversation.","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation.or.team":"Quality query needs one agent, evaluator, assignee, conversation, agent team.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.backend.service.timeout":"Backend service timeout","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluationsQuery"}},"/api/v2/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postQualityEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":true,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","general.bad.request":"Request is badly formed.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualityEvaluationsScoring"}},"/api/v2/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getQualityEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents to be considered","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qmevaluatoractivity.search.too.many.results":"Too many results in evaluator activity query; user needs to enter more characters for name search","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","qmevaluatoractivity.pagenum.too.big":"Page number too large in evaluator activity query","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","qmevaluatoractivity.pagenum.too.small":"Page number too small in evaluator activity query; cannot be < 1"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluatorsActivity"}},"/api/v2/orphanrecordings/{orphanId}/media":{"get":{"tags":["Recording"],"summary":"Gets the media of a single orphan recording","description":"A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.","operationId":"getOrphanrecordingMedia","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"202":{"description":"Accepted - Transcoding orphan media"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordingMedia"}},"/api/v2/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecording"},"put":{"tags":["Recording"],"summary":"Updates an orphan recording to a regular recording with retention values","description":"If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.","operationId":"putOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrphanUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.orphan.retention.data.invalid":"The provided dates in the payload were invalid.","recording.orphan.unknown.conversation":"The provided conversation in the payload doesn't exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.recording.analytics.retention.violation":"The provided delete date exceeds the limit imposed by the analytics retention settings.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.orphan.edit.permission.check.failed":"Requesting user lacks permission to perform this api operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:edit"]},"x-purecloud-method-name":"putOrphanrecording"},"delete":{"tags":["Recording"],"summary":"Deletes a single orphan recording","description":"","operationId":"deleteOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:delete"]},"x-purecloud-method-name":"deleteOrphanrecording"}},"/api/v2/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"hasConversation","in":"query","description":"Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.","required":false,"type":"boolean","default":false},{"name":"media","in":"query","description":"Filter resulting orphans based on their media type","required":false,"type":"string","enum":["Call","Screen"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.view.permission.check.failed":"Failed to verify recording view permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordings"}},"/api/v2/quality/publishedforms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of an evaluation form.","description":"","operationId":"getQualityPublishedformsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluation"}},"/api/v2/quality/publishedforms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluations"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsEvaluations"}},"/api/v2/quality/publishedforms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of a survey form.","description":"","operationId":"getQualityPublishedformsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurvey"}},"/api/v2/quality/publishedforms/surveys":{"get":{"tags":["Quality"],"summary":"Get the published survey forms.","description":"","operationId":"getQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestEnabledPerContext","in":"query","description":"onlyLatestEnabledPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurveys"},"post":{"tags":["Quality"],"summary":"Publish a survey form.","description":"","operationId":"postQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsSurveys"}},"/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}":{"get":{"tags":["Recording"],"summary":"Get metadata for a specific recording. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadataRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.recording.not.found":"Recording with recordingId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadataRecordingId"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording. Valid values:EML,NONE","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording. Valid values:ZIP,NONE ","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording. Valid values:ZIP,NONE","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording. Valid values:true,false","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"202":{"description":"Success - recording is transcoding","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"The conversation query was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecording"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","operationId":"putConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}},{"name":"clearExport","in":"query","description":"Whether to clear the pending export for the recording","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.not.archivable":"Recording has been deleted or is still uploading","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Recording request contains invalid JSON","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","recording.recording.edit.retention.permission.check.failed":"Failed to verify recording edit retention permission.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recording.restore.permission.check.failed":"improper permissions found when attempting to restore recordings"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.not.archivable":"Recording is not achievable","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putConversationRecording"}},"/api/v2/conversations/{conversationId}/recordingmetadata":{"get":{"tags":["Recording"],"summary":"Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.","description":"","operationId":"getConversationRecordingmetadata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RecordingMetadata"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Request forbidden due to recording view permissions check failing.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Request forbidden due to recording segment view permissions check failing."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"Conversation with specified conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadata"}},"/api/v2/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.","required":false,"type":"integer","default":5000,"format":"int32"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"202":{"description":"Success - recording is transcoding"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"The recording:recordingSegment:view permission is required."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"A conversation for the provided conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordings"}},"/api/v2/recordings/retention/query":{"get":{"tags":["Recording"],"summary":"Query for recording retention data","description":"","operationId":"getRecordingsRetentionQuery","produces":["application/json"],"parameters":[{"name":"retentionThresholdDays","in":"query","description":"Fetch retention data for recordings retained for more days than the provided value.","required":true,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 500.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingRetentionCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getRecordingsRetentionQuery"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","recording.annotation.view.permission.check.failed":"Failed to verify view annotation permission","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.annotation.not.found":"The recording annotation was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotation"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.update.permission.check.failed":"Failed to verify recording update permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:edit","recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"putConversationRecordingAnnotation"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","recording.annotation.cant.delete.for.another.user":"Can't delete a recording annotation for another user.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.annotation.delete.permission.check.failed":"Failed to verify recording delete permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:delete"]},"x-purecloud-method-name":"deleteConversationRecordingAnnotation"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:add"]},"x-purecloud-method-name":"postConversationRecordingAnnotations"}},"/api/v2/recording/jobs/{jobId}/failedrecordings":{"get":{"tags":["Recording"],"summary":"Get IDs of recordings that the bulk job failed for","description":"","operationId":"getRecordingJobFailedrecordings","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FailedRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobFailedrecordings"}},"/api/v2/recording/jobs/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status of the job associated with the job id.","description":"","operationId":"getRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJob"},"put":{"tags":["Recording"],"summary":"Execute the recording bulk job.","description":"A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","operationId":"putRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ExecuteRecordingJobsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:edit","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putRecordingJob"},"delete":{"tags":["Recording"],"summary":"Delete the recording bulk job","description":"","operationId":"deleteRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:delete"]},"x-purecloud-method-name":"deleteRecordingJob"}},"/api/v2/recording/jobs":{"get":{"tags":["Recording"],"summary":"Get the status of all jobs within the user's organization","description":"","operationId":"getRecordingJobs","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"userId","enum":["userId","dateCreated"]},{"name":"state","in":"query","description":"Filter by state","required":false,"type":"string","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"]},{"name":"showOnlyMyJobs","in":"query","description":"Show only my jobs","required":false,"type":"boolean"},{"name":"jobType","in":"query","description":"Job Type (Can be left empty for both)","required":false,"type":"string","enum":["ARCHIVE","DELETE","EXPORT"]},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobs"},"post":{"tags":["Recording"],"summary":"Create a recording bulk job.","description":"Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.","operationId":"postRecordingJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RecordingJobsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for actionAge and screen recording parameters"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:add"]},"x-purecloud-method-name":"postRecordingJobs"}},"/api/v2/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getRecordingSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting recording settings","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view","recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"getRecordingSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putRecordingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Recording settings","required":true,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.org.settings.request.invalid":"invalid recording setting","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"putRecordingSettings"}},"/api/v2/recording/uploads/reports/{reportId}":{"get":{"tags":["Recording"],"summary":"Get the status of a recording upload status report","description":"","operationId":"getRecordingUploadsReport","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"reportId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:view"]},"x-purecloud-method-name":"getRecordingUploadsReport"}},"/api/v2/recording/uploads/reports":{"post":{"tags":["Recording"],"summary":"Creates a recording upload status report","description":"","operationId":"postRecordingUploadsReports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Report parameters","required":true,"schema":{"$ref":"#/definitions/RecordingUploadReportRequest"}}],"responses":{"202":{"description":"Accepted - preparing report.","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:add"]},"x-purecloud-method-name":"postRecordingUploadsReports"}},"/api/v2/recordings/screensessions/metadata":{"post":{"tags":["Recording"],"summary":"Provide meta-data a screen recording.","description":"","operationId":"postRecordingsScreensessionsMetadata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ScreenRecordingMetaDataRequest","required":true,"schema":{"$ref":"#/definitions/ScreenRecordingMetaDataRequest"}}],"responses":{"204":{"description":"Meta-data supplied to screen recording."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsMetadata"}},"/api/v2/recordings/screensessions":{"get":{"tags":["Recording"],"summary":"Retrieves a paged listing of screen recording sessions","description":"Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details","operationId":"getRecordingsScreensessions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingSessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessions"}},"/api/v2/recordings/screensessions/details":{"get":{"tags":["Recording"],"summary":"Retrieves an object containing the total number of concurrent active screen recordings","description":"","operationId":"getRecordingsScreensessionsDetails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingActiveSessions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessionsDetails"}},"/api/v2/recordings/screensessions/{recordingSessionId}":{"patch":{"tags":["Recording"],"summary":"Update a screen recording session","description":"","operationId":"patchRecordingsScreensession","produces":["application/json"],"parameters":[{"name":"recordingSessionId","in":"path","description":"Screen recording session ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingSessionRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","qm.screen.recording.state.required":"Can only update a screen recording session's state to stopped.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.stop.permission.check.failed":"Failed to check required stop permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:stop"]},"x-purecloud-method-name":"patchRecordingsScreensession"}},"/api/v2/recordings/screensessions/acknowledge":{"post":{"tags":["Recording"],"summary":"Acknowledge a screen recording.","description":"","operationId":"postRecordingsScreensessionsAcknowledge","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AcknowledgeScreenRecordingRequest","required":true,"schema":{"$ref":"#/definitions/AcknowledgeScreenRecordingRequest"}}],"responses":{"204":{"description":"Recording acknowledged"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsAcknowledge"}},"/api/v2/quality/forms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get a survey form","description":"","operationId":"getQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.not.found":"Survey formId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurvey"},"put":{"tags":["Quality"],"summary":"Update a survey form.","description":"","operationId":"putQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:edit"]},"x-purecloud-method-name":"putQualityFormsSurvey"},"delete":{"tags":["Quality"],"summary":"Delete a survey form.","description":"","operationId":"deleteQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.cannot.be.deleted":"Cannot delete survey because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsSurvey"},"patch":{"tags":["Quality"],"summary":"Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.","description":"","operationId":"patchQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:disable"]},"x-purecloud-method-name":"patchQualityFormsSurvey"}},"/api/v2/quality/forms/surveys/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific survey.","description":"","operationId":"getQualityFormsSurveyVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveyVersions"}},"/api/v2/quality/forms/surveys/bulk":{"get":{"tags":["Quality"],"summary":"Retrieve a list of survey forms by their ids","description":"","operationId":"getQualityFormsSurveysBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma-delimited list of valid survey form ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulk"}},"/api/v2/quality/forms/surveys/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest form versions by context ids","description":"","operationId":"getQualityFormsSurveysBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"published","in":"query","description":"If true, the latest published version will be included. If false, only the unpublished version will be included.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulkContexts"}},"/api/v2/quality/forms/surveys":{"get":{"tags":["Quality"],"summary":"Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.","description":"","operationId":"getQualityFormsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveys"},"post":{"tags":["Quality"],"summary":"Create a survey form.","description":"","operationId":"postQualityFormsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityFormsSurveys"}},"/api/v2/quality/surveys/{surveyId}":{"get":{"tags":["Quality"],"summary":"Get a survey for a conversation","description":"","operationId":"getQualitySurvey","produces":["application/json"],"parameters":[{"name":"surveyId","in":"path","description":"surveyId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Survey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.view.permission.check.failed":"Failed to check required view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualitySurvey"}},"/api/v2/quality/surveys/scoring":{"post":{"tags":["Quality"],"summary":"Score survey","description":"","operationId":"postQualitySurveysScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"surveyAndScoringSet","required":true,"schema":{"$ref":"#/definitions/SurveyFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualitySurveysScoring"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForm"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityForm"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityForm"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormVersions"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.","description":"","operationId":"getQualityForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForms"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityForms"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedform","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Requested formId not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedform"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedforms"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.already.published":"Evaluation has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedforms"}},"/api/v2/alerting/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an alert","description":"","operationId":"getAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingAlert"},"put":{"tags":["Alerting"],"summary":"Update an alert read status","description":"","operationId":"putAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertingUnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an alert","description":"","operationId":"deleteAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingAlert"},"patch":{"tags":["Alerting"],"summary":"Allows an entity to mute/snooze an alert or update the unread status of the alert.","description":"Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.","operationId":"patchAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlert"}},"/api/v2/alerting/alerts/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk alert updates","description":"","operationId":"patchAlertingAlertsBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonAlertBulkUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlertsBulk"}},"/api/v2/alerting/alerts/query":{"post":{"tags":["Alerting"],"summary":"Gets a paged list of alerts. The max page size is 50","description":"","operationId":"postAlertingAlertsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetAlertQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlertListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"postAlertingAlertsQuery"}},"/api/v2/alerting/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get a rule.","description":"","operationId":"getAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingRule"},"put":{"tags":["Alerting"],"summary":"Update a rule","description":"","operationId":"putAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"},{"in":"body","name":"body","description":"rule to be updated","required":true,"schema":{"$ref":"#/definitions/ModifiableRuleProperties"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingRule"},"delete":{"tags":["Alerting"],"summary":"Delete a rule.","description":"","operationId":"deleteAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"204":{"description":"Rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingRule"}},"/api/v2/alerting/rules/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk update of notification lists","description":"","operationId":"patchAlertingRulesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkUpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"patchAlertingRulesBulk"}},"/api/v2/alerting/rules/bulk/remove":{"post":{"tags":["Alerting"],"summary":"Bulk remove rules","description":"","operationId":"postAlertingRulesBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkDeleteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"postAlertingRulesBulkRemove"}},"/api/v2/alerting/rules/query":{"post":{"tags":["Alerting"],"summary":"Get a paged list of rules. The max size of the page is 50 items.","description":"","operationId":"postAlertingRulesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetRulesQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"postAlertingRulesQuery"}},"/api/v2/alerting/rules":{"post":{"tags":["Alerting"],"summary":"Create a Rule.","description":"","operationId":"postAlertingRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"rule to be created","required":true,"schema":{"$ref":"#/definitions/CommonRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"201":{"description":"Rule created.","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingRules"}},"/api/v2/responsemanagement/libraries/bulk":{"post":{"tags":["Response Management"],"summary":"Get response libraries.","description":"","operationId":"postResponsemanagementLibrariesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"LibraryIDs (max allowed 50)","required":true,"schema":{"$ref":"#/definitions/LibraryBatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.exceeds.maximum.library.batch.size":"Exceeds maximum batch size limit.","rms.missing.field":"Missing Field.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"postResponsemanagementLibrariesBulk"}},"/api/v2/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getResponsemanagementLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"messagingTemplateFilter","in":"query","description":"Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel","required":false,"type":"string","enum":["whatsapp"]},{"name":"libraryPrefix","in":"query","description":"Returns a list of libraries that contain the prefix provided","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postResponsemanagementLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:add"]},"x-purecloud-method-name":"postResponsemanagementLibraries"}},"/api/v2/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.library.not.found":"The response library could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibrary"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:edit"]},"x-purecloud-method-name":"putResponsemanagementLibrary"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:delete"]},"x-purecloud-method-name":"deleteResponsemanagementLibrary"}},"/api/v2/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsemanagementResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","rms.field.unexpected.value":"One or more fields in the payload contained unexpected values."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.internal.server.error":"The request failed due to an internal server error.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"postResponsemanagementResponsesQuery"}},"/api/v2/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","rms.response.not.found":"The response could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponse"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:edit"]},"x-purecloud-method-name":"putResponsemanagementResponse"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponse"}},"/api/v2/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponsemanagementResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponsemanagementResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.not.a.user":"Unable to find user","rms.exceeds.asset.maximum.file.size":"Response asset file size exceeds limit.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","rms.exceeds.maximum.mms.response.assets":"Too many response assets","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.precondition":"Response precondition not met."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:add"]},"x-purecloud-method-name":"postResponsemanagementResponses"}},"/api/v2/responsemanagement/responseassets/{responseAssetId}":{"get":{"tags":["Response Management"],"summary":"Get response asset information","description":"","operationId":"getResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseasset"},"put":{"tags":["Response Management"],"summary":"Update response asset","description":"","operationId":"putResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:edit"]},"x-purecloud-method-name":"putResponsemanagementResponseasset"},"delete":{"tags":["Response Management"],"summary":"Delete response asset","description":"","operationId":"deleteResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"204":{"description":"Response asset is deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponseasset"}},"/api/v2/responsemanagement/responseassets/status/{statusId}":{"get":{"tags":["Response Management"],"summary":"Get response asset upload status","description":"","operationId":"getResponsemanagementResponseassetsStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseassetsStatusStatusId"}},"/api/v2/responsemanagement/responseassets/uploads":{"post":{"tags":["Response Management"],"summary":"Creates pre-signed url for uploading response asset","description":"","operationId":"postResponsemanagementResponseassetsUploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateResponseAssetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.content.md5":"Invalid Content","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:add"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsUploads"}},"/api/v2/responsemanagement/responseassets/search":{"post":{"tags":["Response Management"],"summary":"Search response assets","description":"","operationId":"postResponsemanagementResponseassetsSearch","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user","division"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetSearchResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsSearch"}},"/api/v2/routing/availablemediatypes":{"get":{"tags":["Routing"],"summary":"Get available media types","description":"","operationId":"getRoutingAvailablemediatypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableMediaTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingAvailablemediatypes"}},"/api/v2/routing/languages/{languageId}":{"get":{"tags":["Routing"],"summary":"Get a routing language","description":"","operationId":"getRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguage"},"delete":{"tags":["Routing"],"summary":"Delete a routing language","description":"","operationId":"deleteRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingLanguage"}},"/api/v2/routing/languages":{"get":{"tags":["Routing"],"summary":"Get the list of supported languages.","description":"","operationId":"getRoutingLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguages"},"post":{"tags":["Routing"],"summary":"Create Language","description":"","operationId":"postRoutingLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingLanguages"}},"/api/v2/routing/queues/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","description":"","operationId":"getRoutingQueuesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number [max value is 5]","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"Queue ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting paged listing of queue objects."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviews"}},"/api/v2/routing/queues/divisionviews/all":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.","description":"","operationId":"getRoutingQueuesDivisionviewsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 500]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviewsAll"}},"/api/v2/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueue"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/QueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","queue.ring.has.members":"One or more bullseye rings cannot be removed, due to having assigned members.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A referenced resource, such as a division, was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","invalid.media.subtype":"Invalid media subtype specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"putRoutingQueue"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"forceDelete","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field.","active.queue":"Queue contains active conversations."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:delete"]},"x-purecloud-method-name":"deleteRoutingQueue"}},"/api/v2/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of wrapup codes","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapUpCodeReference"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of wrapup codes.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified queue was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"postRoutingQueueWrapupcodes"}},"/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteRoutingQueueWrapupcode","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingQueueWrapupcode"}},"/api/v2/routing/queues/me":{"get":{"tags":["Routing"],"summary":"Get a paged listing of queues the user is a member of.","description":"","operationId":"getRoutingQueuesMe","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"joined","in":"query","description":"Filter by joined status.","required":false,"type":"boolean","enum":["true","false"]},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingQueuesMe"}},"/api/v2/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getRoutingQueues","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Include only queues with the given name (leading and trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Include only queues with the specified ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Include only queues in the specified division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"peerId","in":"query","description":"Include only queues with the specified peer ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"cannedResponseLibraryId","in":"query","description":"Include only queues explicitly associated with the specified canned response library ID","required":false,"type":"string"},{"name":"hasPeer","in":"query","description":"Include only queues with a peer ID","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting queue listing."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueues"},"post":{"tags":["Routing"],"summary":"Create a queue","description":"","operationId":"postRoutingQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/CreateQueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","invalid.phone.numbers":"Invalid phone numbers specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","queue.limit.exceeded":"Adding the requested queue would exceed the queue limit.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A resource (e.g., a skill) referenced in the queue configuration was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A required resource (e.g., the source queue) was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:add"]},"x-purecloud-method-name":"postRoutingQueues"}},"/api/v2/routing/settings/transcription":{"get":{"tags":["Routing"],"summary":"Get Transcription Settings","description":"","operationId":"getRoutingSettingsTranscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Requested feature is forbidden","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:view"]},"x-purecloud-method-name":"getRoutingSettingsTranscription"},"put":{"tags":["Routing"],"summary":"Update Transcription Settings","description":"","operationId":"putRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"putRoutingSettingsTranscription"},"patch":{"tags":["Routing"],"summary":"Patch Transcription Settings","description":"","operationId":"patchRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsTranscription"}},"/api/v2/routing/settings/contactcenter":{"get":{"tags":["Routing"],"summary":"Get Contact Center Settings","description":"","operationId":"getRoutingSettingsContactcenter","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCenterSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettingsContactcenter"},"patch":{"tags":["Routing"],"summary":"Update Contact Center Settings","description":"","operationId":"patchRoutingSettingsContactcenter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact Center Settings","required":true,"schema":{"$ref":"#/definitions/ContactCenterSettings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsContactcenter"}},"/api/v2/routing/settings":{"get":{"tags":["Routing"],"summary":"Get an organization's routing settings","description":"","operationId":"getRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettings"},"put":{"tags":["Routing"],"summary":"Update an organization's routing settings","description":"","operationId":"putRoutingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/RoutingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"putRoutingSettings"},"delete":{"tags":["Routing"],"summary":"Delete an organization's routing settings","description":"","operationId":"deleteRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"deleteRoutingSettings"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkill"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingSkill"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing skills.","description":"","operationId":"getRoutingSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Filter for results that start with this value","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postRoutingSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingSkills"}},"/api/v2/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the organization-wide max utilization settings.","description":"","operationId":"getRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilization"},"put":{"tags":["Routing"],"summary":"Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.media.capacity":"Value too large or too small for media type.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilization"},"delete":{"tags":["Routing"],"summary":"Delete the organization-wide max utilization settings and revert to the system default.","description":"","operationId":"deleteRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilization"}},"/api/v2/routing/assessments/{assessmentId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessment.","description":"","operationId":"getRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessment.not.found":"Benefit Assessment not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessment"},"delete":{"tags":["Routing"],"summary":"Delete single benefit assessment.","description":"","operationId":"deleteRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:delete"]},"x-purecloud-method-name":"deleteRoutingAssessment"}},"/api/v2/routing/assessments":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessments.","description":"","operationId":"getRoutingAssessments","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID(s) to filter assessments by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessments"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment.","description":"","operationId":"postRoutingAssessments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"201":{"description":"Benefit Assessment created.","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:assessment:add","routing:queue:view"]},"x-purecloud-method-name":"postRoutingAssessments"}},"/api/v2/routing/assessments/jobs/{jobId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessments job.","description":"","operationId":"getRoutingAssessmentsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Benefit Assessment Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"The benefit assessment job is finished.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"The benefit assessment job is created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessments.job.not.found":"Benefit Assessments Job not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJob"}},"/api/v2/routing/assessments/jobs":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessment jobs.","description":"","operationId":"getRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"Division ID(s) to filter assessment jobs by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJobs"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment job.","description":"","operationId":"postRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"Benefit Assessment Job created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:add"]},"x-purecloud-method-name":"postRoutingAssessmentsJobs"}},"/api/v2/routing/conversations/{conversationId}":{"patch":{"tags":["Routing"],"summary":"Update attributes of an in-queue conversation","description":"Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.","operationId":"patchRoutingConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Attributes","required":true,"schema":{"$ref":"#/definitions/RoutingConversationAttributesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingConversationAttributesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A null or invalid attribute ID was specified.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","resource.not.found":"A specified skill or language does not exist."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified conversation does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:conversation:edit"]},"x-purecloud-method-name":"patchRoutingConversation"}},"/api/v2/routing/email/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomain"},"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomain"},"patch":{"tags":["Routing"],"summary":"Update domain settings","description":"","operationId":"patchRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomain"}},"/api/v2/routing/email/domains/{domainId}/validate":{"patch":{"tags":["Routing"],"summary":"Validate domain settings","description":"","operationId":"patchRoutingEmailDomainValidate","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomainValidate"}},"/api/v2/routing/email/domains/{domainId}/testconnection":{"post":{"tags":["Routing"],"summary":"Tests the custom SMTP server integration connection set on this domain","description":"The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","operationId":"postRoutingEmailDomainTestconnection","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TestMessage","required":false,"schema":{"$ref":"#/definitions/TestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainTestconnection"}},"/api/v2/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getRoutingEmailDomains","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeStatus","in":"query","description":"Exclude MX record data","required":false,"type":"boolean","default":false},{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","postino.domain.exists":"The inbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomains"}},"/api/v2/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getRoutingEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailSetup"}},"/api/v2/routing/email/outbound/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomain"},"delete":{"tags":["Routing"],"summary":"Delete an outbound domain","description":"","operationId":"deleteRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailOutboundDomain"}},"/api/v2/routing/email/outbound/domains/{domainId}/search":{"get":{"tags":["Routing"],"summary":"Search a domain across organizations","description":"","operationId":"getRoutingEmailOutboundDomainSearch","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainSearch"}},"/api/v2/routing/email/outbound/domains/{domainId}/activation":{"get":{"tags":["Routing"],"summary":"Get activation status (cname + dkim) of an outbound domain","description":"","operationId":"getRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainActivation"},"put":{"tags":["Routing"],"summary":"Request an activation status (cname + dkim) update of an outbound domain","description":"","operationId":"putRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailOutboundDomainActivation"}},"/api/v2/routing/email/outbound/domains":{"get":{"tags":["Routing"],"summary":"Get outbound domains","description":"","operationId":"getRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomains"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoute"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailDomainRoute"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The inbound route delete request timed out.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.route.conflict":"The inbound route is a reply route in one or more other inbound routes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomainRoute"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pattern","in":"query","description":"Filter routes by the route's pattern property","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.max.routes.exceeded":"The maximum number of routes for the domain has been exceeded.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.not.found":"The resource could not be found.","constraint.validation":"%s","postino.domain.exists":"The inbound domain already exists.","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.route.pattern.exists":"A route already exists for this domain with the specified pattern.","postino.error.queue.required":"A queue id or flow id is required.","postino.route.not.found":"The route could not be found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainRoutes"}},"/api/v2/routing/email/outbound/domains/simulated":{"post":{"tags":["Routing"],"summary":"Create a simulated domain","description":"","operationId":"postRoutingEmailOutboundDomainsSimulated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomainsSimulated"}},"/api/v2/routing/message/recipients/{recipientId}":{"get":{"tags":["Routing"],"summary":"Get a recipient","description":"","operationId":"getRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipient"},"put":{"tags":["Routing"],"summary":"Update a recipient","description":"","operationId":"putRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recipient","required":true,"schema":{"$ref":"#/definitions/RecipientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The flow was invalid.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"putRoutingMessageRecipient"}},"/api/v2/routing/message/recipients":{"get":{"tags":["Routing"],"summary":"Get recipients","description":"","operationId":"getRoutingMessageRecipients","produces":["application/json"],"parameters":[{"name":"messengerType","in":"query","description":"Messenger Type","required":false,"type":"string","enum":["sms","facebook","twitter","line","whatsapp","open","instagram"]},{"name":"name","in":"query","description":"Recipient Name","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecipientListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipients"}},"/api/v2/routing/sms/addresses/{addressId}":{"get":{"tags":["Routing"],"summary":"Get an Address by Id for SMS","description":"","operationId":"getRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddress"},"delete":{"tags":["Routing"],"summary":"Delete an Address by Id for SMS","description":"","operationId":"deleteRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsAddress"}},"/api/v2/routing/sms/addresses":{"get":{"tags":["Routing"],"summary":"Get a list of Addresses for SMS","description":"","operationId":"getRoutingSmsAddresses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddressEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddresses"},"post":{"tags":["Routing"],"summary":"Provision an Address for SMS","description":"","operationId":"postRoutingSmsAddresses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsAddress","required":true,"schema":{"$ref":"#/definitions/SmsAddressProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.address":"The address you have provided cannot be validated. This may be due to spelling error or that the address is not available in a third-party data source for validation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsAddresses"}},"/api/v2/routing/sms/availablephonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of available phone numbers for SMS provisioning.","description":"This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.","operationId":"getRoutingSmsAvailablephonenumbers","produces":["application/json"],"parameters":[{"name":"countryCode","in":"query","description":"The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned","required":true,"type":"string"},{"name":"region","in":"query","description":"Region/province/state that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"city","in":"query","description":"City that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"areaCode","in":"query","description":"Area code that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Type of available phone numbers searched","required":true,"type":"string","enum":["local","mobile","tollfree"]},{"name":"pattern","in":"query","description":"A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.","required":false,"type":"string"},{"name":"addressRequirement","in":"query","description":"This indicates whether the phone number requires to have an Address registered.","required":false,"type":"string","enum":["none","any","local","foreign"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SMSAvailablePhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"getRoutingSmsAvailablephonenumbers"}},"/api/v2/routing/sms/phonenumbers/import":{"post":{"tags":["Routing"],"summary":"Imports a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbersImport","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberImport"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number imported is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"Bad request provisioning phone number for SMS","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","compliance.not.configurable":"Compliance is not configurable for current phone type.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number address is not in E.164 phone format.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:byoImport"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbersImport"}},"/api/v2/routing/sms/phonenumbers/{addressId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand response with additional information","required":false,"type":"string","enum":["compliance"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumber"},"put":{"tags":["Routing"],"summary":"Update a phone number provisioned for SMS.","description":"","operationId":"putRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumber"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - The phone number update is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Update operation not allowed for phone number of type shortcode.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:edit"]},"x-purecloud-method-name":"putRoutingSmsPhonenumber"},"delete":{"tags":["Routing"],"summary":"Delete a phone number provisioned for SMS.","description":"","operationId":"deleteRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted -The phone number delete is in progress."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Delete operation not allowed for phone number of type shortcode.","recipient.has.flow":"Phone number cannot be deleted with an existing flow associated to it. Remove associated flow before deleting phone number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsPhonenumber"}},"/api/v2/routing/sms/phonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of provisioned phone numbers.","description":"","operationId":"getRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Filter on phone number type","required":false,"type":"array","items":{"type":"string","enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"collectionFormat":"multi"},{"name":"phoneNumberStatus","in":"query","description":"Filter on phone number status","required":false,"type":"array","items":{"type":"string","enum":["active","invalid","initiated","porting","pending","pending-cancellation"]},"collectionFormat":"multi"},{"name":"countryCode","in":"query","description":"Filter on country code","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Optional field to sort results","required":false,"type":"string","enum":["phoneNumber","countryCode","country","dateCreated","dateModified","phoneNumberStatus","phoneNumberType","purchaseDate","supportsMms","supportsSms","supportsVoice"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]},{"name":"language","in":"query","description":"A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations","required":false,"type":"string","default":"en-US","x-example":"en-US"},{"name":"integration.id","in":"query","description":"Filter on the Genesys Cloud integration id to which the phone number belongs to","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumbers"},"post":{"tags":["Routing"],"summary":"Provision a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number create is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"The request could not be understood by the server due to malformed syntax.","requires.an.address":"The country associated with this phone number requires an address on file. To provision this number you must have an Address on your account.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","requires.verified.identity.document":"This phone number requires a verified identity document, which is not supported.","requires.local.address":"Phone number associated with the country code requires a local address. To provision this number you must have an Address on your account which satisfies the local address requirements.","invalid.short.code.operation":"Phone number Provision operation not allowed for phone number of type shortcode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phone.number.requires.a.bundle":"This phone number cannot be provisioned without an identity document, which is not supported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbers"}},"/api/v2/routing/predictors/{predictorId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single predictor.","description":"","operationId":"getRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view"]},"x-purecloud-method-name":"getRoutingPredictor"},"delete":{"tags":["Routing"],"summary":"Delete single predictor.","description":"","operationId":"deleteRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:delete","routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingPredictor"},"patch":{"tags":["Routing"],"summary":"Update single predictor.","description":"","operationId":"patchRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchPredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:edit","routing:queue:edit"]},"x-purecloud-method-name":"patchRoutingPredictor"}},"/api/v2/routing/predictors":{"get":{"tags":["Routing"],"summary":"Retrieve all predictors.","description":"","operationId":"getRoutingPredictors","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Comma-separated list of queue Ids to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingPredictors"},"post":{"tags":["Routing"],"summary":"Create a predictor.","description":"","operationId":"postRoutingPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreatePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.predictors":"Number of predictors exceeds the allowed limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:add","routing:queue:edit"]},"x-purecloud-method-name":"postRoutingPredictors"}},"/api/v2/routing/predictors/keyperformanceindicators":{"get":{"tags":["Routing"],"summary":"Get a list of Key Performance Indicators","description":"","operationId":"getRoutingPredictorsKeyperformanceindicators","produces":["application/json"],"parameters":[{"name":"kpiGroup","in":"query","description":"The Group of Key Performance Indicators to return","required":false,"type":"string","enum":["Standard","Custom"]},{"name":"expand","in":"query","description":"Parameter to request additional data to return in KPI payload","required":false,"type":"array","items":{"type":"string","enum":["queues"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/KeyPerformanceIndicator"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:keyPerformanceIndicator:view"]},"x-purecloud-method-name":"getRoutingPredictorsKeyperformanceindicators"}},"/api/v2/routing/predictors/{predictorId}/models/{modelId}/features":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Model Features.","description":"","operationId":"getRoutingPredictorModelFeatures","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"name":"modelId","in":"path","description":"Model ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModelFeatureListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Predictor Model was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModelFeature:view"]},"x-purecloud-method-name":"getRoutingPredictorModelFeatures"}},"/api/v2/routing/predictors/{predictorId}/models":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Models and Top Features.","description":"","operationId":"getRoutingPredictorModels","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModels"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModel:view"]},"x-purecloud-method-name":"getRoutingPredictorModels"}},"/api/v2/routing/queues/{queueId}/members/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete a queue member.","description":"","operationId":"deleteRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueMember"},"patch":{"tags":["Routing"],"summary":"Update the ring number OR joined status for a queue member.","description":"","operationId":"patchRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMember"}},"/api/v2/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get the members of this queue.","description":"","operationId":"getRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by queue member name (contains-style search)","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"memberBy","in":"query","description":"Filter by member type","required":false,"type":"string","enum":["user","group"]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:edit","routing:queue:readonly","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueMembers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueMembers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMembers"}},"/api/v2/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.","description":"","operationId":"deleteRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueUser"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.","description":"","operationId":"patchRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUser"}},"/api/v2/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.","description":"","operationId":"getRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueUsers"},"post":{"tags":["Routing"],"summary":"DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.","description":"","operationId":"postRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueUsers"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.","description":"","operationId":"patchRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUsers"}},"/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}":{"get":{"tags":["Routing"],"summary":"Get a Comparison Period.","description":"","operationId":"getRoutingQueueComparisonperiod","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"},{"name":"comparisonPeriodId","in":"path","description":"ComparisonPeriod id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriod"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"comparisonperiod.not.found":"Comparison Period not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiod"}},"/api/v2/routing/queues/{queueId}/comparisonperiods":{"get":{"tags":["Routing"],"summary":"Get list of comparison periods","description":"","operationId":"getRoutingQueueComparisonperiods","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriodListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiods"}},"/api/v2/routing/skillgroups/{skillGroupId}/members/divisions":{"get":{"tags":["Routing"],"summary":"Get list of member divisions for this skill group.","description":"","operationId":"getRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberDivisionList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembersDivisions"},"post":{"tags":["Routing"],"summary":"Add or remove member divisions for this skill group.","description":"","operationId":"postRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SkillGroupMemberDivisions"}}],"responses":{"204":{"description":"Success, skill group member division(s) were added and/or removed."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroupMembersDivisions"}},"/api/v2/routing/skillgroups/{skillGroupId}":{"get":{"tags":["Routing"],"summary":"Get skill group","description":"","operationId":"getRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroup"},"delete":{"tags":["Routing"],"summary":"Remove skill group definition","description":"","operationId":"deleteRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, skill group was removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:delete"]},"x-purecloud-method-name":"deleteRoutingSkillgroup"},"patch":{"tags":["Routing"],"summary":"Update skill group definition","description":"","operationId":"patchRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update skill groups","required":true,"schema":{"$ref":"#/definitions/SkillGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Provided request is not valid","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:edit"]},"x-purecloud-method-name":"patchRoutingSkillgroup"}},"/api/v2/routing/skillgroups/{skillGroupId}/members":{"get":{"tags":["Routing"],"summary":"Get skill group members","description":"","operationId":"getRoutingSkillgroupMembers","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembers"}},"/api/v2/routing/skillgroups":{"get":{"tags":["Routing"],"summary":"Get skill group listing","description":"","operationId":"getRoutingSkillgroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only skill group names whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroups"},"post":{"tags":["Routing"],"summary":"Create a skill group","description":"","operationId":"postRoutingSkillgroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create skill group","required":true,"schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Skill Group with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroups"}},"/api/v2/routing/users/{userId}/utilization":{"get":{"tags":["Routing","Users"],"summary":"Get the user's max utilization settings. If not configured, the organization-wide default is returned.","description":"","operationId":"getRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentMaxUtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUserUtilization"},"put":{"tags":["Routing","Users"],"summary":"Update the user's max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentMaxUtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.media.capacity":"Maximum capacity must be between 1 and 50.","invalid.id":"A non-UUID value was specified for an ID field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUserUtilization"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's max utilization settings and revert to the organization-wide default.","description":"","operationId":"deleteRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The user was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUserUtilization"}},"/api/v2/routing/wrapupcodes/divisionviews/{codeId}":{"get":{"tags":["Routing"],"summary":"Get a simplified wrap-up code.","description":"","operationId":"getRoutingWrapupcodesDivisionview","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionview"}},"/api/v2/routing/wrapupcodes/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).","description":"Specifying both name and ID parameters is not supported.","operationId":"getRoutingWrapupcodesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name (trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeState","in":"query","description":"Wrapup code state(s) to include","required":false,"type":"string","enum":["Active","Deleted","ActiveAndDeleted"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","name.and.id.specified":"Both name and ID were specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionviews"}},"/api/v2/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcode"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:edit"]},"x-purecloud-method-name":"putRoutingWrapupcode"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:delete"]},"x-purecloud-method-name":"deleteRoutingWrapupcode"}},"/api/v2/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getRoutingWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Wrapup code's name ('Sort by' param is ignored unless this field is provided)","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Filter by division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postRoutingWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A referenced resource, such as a division, was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:add"]},"x-purecloud-method-name":"postRoutingWrapupcodes"}},"/api/v2/scim/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimResourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetype"}},"/api/v2/scim/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimResourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetypes"}},"/api/v2/scim/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimSchema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchema"}},"/api/v2/scim/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimSchemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchemas"}},"/api/v2/scim/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimGroups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroups"}},"/api/v2/scim/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroup"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimGroup"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimGroup"}},"/api/v2/scim/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimServiceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimServiceproviderconfig"}},"/api/v2/scim/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUsers"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimUsers"}},"/api/v2/scim/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"A conflict occurred when getting a SCIM user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The SCIM user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUser"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimUser"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimUser"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimUser"}},"/api/v2/scim/v2/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimV2Resourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetype"}},"/api/v2/scim/v2/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimV2Resourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetypes"}},"/api/v2/scim/v2/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimV2Schema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schema"}},"/api/v2/scim/v2/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimV2Schemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schemas"}},"/api/v2/scim/v2/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimV2Groups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":true,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Groups"}},"/api/v2/scim/v2/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Group"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimV2Group"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","org.disabled":"Unable to modify group due to the organization being disabled.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimV2Group"}},"/api/v2/scim/v2/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimV2Serviceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Serviceproviderconfig"}},"/api/v2/scim/v2/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Users"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimV2Users"}},"/api/v2/scim/v2/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"Conflict with existing user ID."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2User"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimV2User"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimV2User"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimV2User"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using the q64 value returned from a previous search.","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","images","addressVerificationDetails"]},"collectionFormat":"multi"},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search resources.","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","user.not.in.organization":"User is not in organization.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","jid.not.found":"Unable to determine the JID for user."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearch"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest resources using the q64 value returned from a previous suggest query.","description":"","operationId":"getSearchSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","images","addressVerificationDetails"]},"collectionFormat":"multi"},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearchSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest resources.","description":"","operationId":"postSearchSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearchSuggest"}},"/api/v2/analytics/conversations/transcripts/query":{"post":{"tags":["Search","Analytics"],"summary":"Search resources.","description":"","operationId":"postAnalyticsConversationsTranscriptsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptConversationDetailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsTranscriptsQuery"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech and Text Analytics for a specific conversation","description":"","operationId":"getSpeechandtextanalyticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving Speech and Text Analytics.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Speech and Text Analytics Not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversation"}},"/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics dictionary feedback by id","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics dictionary feedback by id","description":"","operationId":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.update.not.allowed":"The term cannot be updated","dialect.update.not.allowed":"The dialect of term cannot be updated"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics DictionaryFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"}},"/api/v2/speechandtextanalytics/dictionaryfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics dictionary feedbacks","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"},{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":500,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics DictionaryFeedback","description":"","operationId":"postSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The DictionaryFeedback to create","required":true,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.length.exceeded":"30 characters in a term limit exceeded","example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.limit.exceeded":"500 term quota exceeded for dialect in this Org","term.already.exists":"The term for the dialect already exists in this Org"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsDictionaryfeedback"}},"/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}":{"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics SentimentFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId","produces":["application/json"],"parameters":[{"name":"sentimentFeedbackId","in":"path","description":"The Id of the SentimentFeedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId"}},"/api/v2/speechandtextanalytics/sentimentfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics SentimentFeedback","description":"","operationId":"getSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SentimentFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics SentimentFeedback","description":"","operationId":"postSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The SentimentFeedback to create","required":true,"schema":{"$ref":"#/definitions/SentimentFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/SentimentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrase.logograph.length.required":"The phrase should contain minimum 1 char & maximum 40 chars","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phrase.maximum.words.exceeded":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","invalid.feedbackValue":"The feedbackValue & initialValue cannot be same","phrase.length.exceeded":"500 characters in a phrase limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phrase.minimum.words.required":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","phrase.logograph.length.exceeded":"The phrase should contain minimum 1 char & maximum 40 chars","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.limit.exceeded":"2000 feedback quota exceeded in this Org","phrase.already.exists":"Feedback with same phrase for the dialect already exists in this Org."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsSentimentfeedback"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete All Speech & Text Analytics SentimentFeedback","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedback"}},"/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get transcription engine settings of a program","description":"","operationId":"getSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramTranscriptionengines"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update transcription engine settings of a program","description":"","operationId":"putSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"Program transcription engine setting","required":true,"schema":{"$ref":"#/definitions/TranscriptionEnginesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"transcriptionengine.limit.exceeded":"Exceeded maximum number of transcription engines quota","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dialect.duplicate":"Duplicated dialects","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Invalid Value"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramTranscriptionengines"}},"/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get supported dialects for each transcription engine","description":"","operationId":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedDialectsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects"}},"/api/v2/speechandtextanalytics/sentiment/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics sentiment supported dialects","description":"","operationId":"getSpeechandtextanalyticsSentimentDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentDialects"}},"/api/v2/speechandtextanalytics/settings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech And Text Analytics Settings","description":"","operationId":"getSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"settings.not.found":"The organization does not have SpeechAndTextAnalytics settings","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSettings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update Speech And Text Analytics Settings","description":"","operationId":"putSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsSettings"},"patch":{"tags":["Speech & Text Analytics"],"summary":"Patch Speech And Text Analytics Settings","description":"","operationId":"patchSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"patchSpeechandtextanalyticsSettings"}},"/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics general program job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsGeneralJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsGeneralJob"}},"/api/v2/speechandtextanalytics/programs/general/jobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics general program job","description":"","operationId":"postSpeechandtextanalyticsProgramsGeneralJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The general programs job to create","required":true,"schema":{"$ref":"#/definitions/GeneralProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"500 topics quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.program.job.already.running":"A General Program Job is already running"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsGeneralJobs"}},"/api/v2/speechandtextanalytics/topics/general":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the Speech & Text Analytics general topics for a given dialect","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneral","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralTopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneral"}},"/api/v2/speechandtextanalytics/programs/{programId}/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech & Text Analytics program mappings to queues and flows by id","description":"","operationId":"getSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramMappings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Set Speech & Text Analytics program mappings to queues and flows","description":"","operationId":"putSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to set mappings for","required":true,"schema":{"$ref":"#/definitions/ProgramMappingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.limit.exceeded":"500 flows limit exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","program.mappings.limit.exceeded":"20000 program mappings limit exceeded","constraint.validation":"%s","queues.limit.exceeded":"500 queues limit exceeded","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Queue / Flow with id {id} is already mapped to another program"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramMappings"}},"/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish programs job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsPublishjob"}},"/api/v2/speechandtextanalytics/programs/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish programs job","description":"","operationId":"postSpeechandtextanalyticsProgramsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish programs job to create","required":true,"schema":{"$ref":"#/definitions/ProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","programs.limit.exceeded":"Limit of 10 programs to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","program.not.provided":"At least one Program Id should be provided","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsPublishjobs"}},"/api/v2/speechandtextanalytics/programs/{programId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics program by id","description":"","operationId":"getSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgram"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics program","description":"","operationId":"putSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to update","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgram"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics program by id","description":"","operationId":"deleteSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"204":{"description":"The program was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","deleting.default.program.is.forbidden":"Default program deletion is not allowed"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsProgram"}},"/api/v2/speechandtextanalytics/programs/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs mappings to queues and flows","description":"","operationId":"getSpeechandtextanalyticsProgramsMappings","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsMappingsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsMappings"}},"/api/v2/speechandtextanalytics/programs":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs","description":"","operationId":"getSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Program state. Defaults to Latest","required":false,"type":"string","enum":["Latest","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsPrograms"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics program","description":"","operationId":"postSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The program to create","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsPrograms"}},"/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish topics job by id","description":"","operationId":"getSpeechandtextanalyticsTopicsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish topics job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsPublishjob"}},"/api/v2/speechandtextanalytics/topics/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish topics job","description":"","operationId":"postSpeechandtextanalyticsTopicsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish topics job to create","required":true,"schema":{"$ref":"#/definitions/TopicJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"Limit of 50 topics to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","topic.not.provided":"At least one Topic Id should be provided","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopicsPublishjobs"}},"/api/v2/speechandtextanalytics/topics/{topicId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics topic by id","description":"","operationId":"getSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopic"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics topic","description":"","operationId":"putSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"},{"in":"body","name":"body","description":"The topic to update","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","updating.dialect.is.forbidden":"Updating dialect is forbidden","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsTopic"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics topic by id","description":"","operationId":"deleteSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"204":{"description":"The topic was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"deleting.topic.used.in.category.is.forbidden":"The topic cannot be deleted. There are categories associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsTopic"}},"/api/v2/speechandtextanalytics/topics/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get list of supported Speech & Text Analytics topics dialects","description":"","operationId":"getSpeechandtextanalyticsTopicsDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsDialects"}},"/api/v2/speechandtextanalytics/topics":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics topics","description":"","operationId":"getSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 500.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Topic state. Defaults to latest","required":false,"type":"string","enum":["latest","published"]},{"name":"name","in":"query","description":"Case insensitive partial name to filter by","required":false,"type":"string"},{"name":"ids","in":"query","description":"Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dialects","in":"query","description":"Comma separated dialect strings to filter by. Maximum of 15 dialects allowed.","required":false,"type":"array","items":{"type":"string","enum":["en-US","es-US","en-AU","en-GB","en-ZA","es-ES","en-IN","fr-FR","fr-CA","it-IT","de-DE","pt-BR","pl-PL","pt-PT","nl-NL","ko-KR"]},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort results by. Defaults to name","required":false,"type":"string","enum":["name"]},{"name":"sortOrder","in":"query","description":"Sort order. Defaults to asc","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopics"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics topic","description":"","operationId":"postSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The topic to create","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopics"}},"/api/v2/speechandtextanalytics/topics/general/status":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of general topics from the org and the system with their current status","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneralStatus","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedGeneralTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneralStatus"}},"/api/v2/speechandtextanalytics/programs/unpublished":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics unpublished programs","description":"","operationId":"getSpeechandtextanalyticsProgramsUnpublished","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnpublishedProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsUnpublished"}},"/api/v2/speechandtextanalytics/transcripts/search":{"post":{"tags":["Search","Speech & Text Analytics"],"summary":"Search resources.","description":"","operationId":"postSpeechandtextanalyticsTranscriptsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly","speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","recording:recording:view"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTranscriptsSearch"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the pre-signed S3 URL for the transcript of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturl","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrl"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript url.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturl"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturls","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrls"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript urls.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturls"}},"/api/v2/teams/{teamId}/members":{"get":{"tags":["Teams"],"summary":"Get team membership","description":"","operationId":"getTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeamMembers"},"post":{"tags":["Teams"],"summary":"Add team members","description":"","operationId":"postTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TeamMembers","required":true,"schema":{"$ref":"#/definitions/TeamMembers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberAddListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"postTeamMembers"},"delete":{"tags":["Teams"],"summary":"Delete team members","description":"","operationId":"deleteTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of member ids to remove","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team members are removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","max.user.ids":"Only 25 members can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"deleteTeamMembers"}},"/api/v2/teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get team","description":"","operationId":"getTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeam"},"delete":{"tags":["Teams"],"summary":"Delete team","description":"","operationId":"deleteTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team was deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:delete"]},"x-purecloud-method-name":"deleteTeam"},"patch":{"tags":["Teams"],"summary":"Update team","description":"","operationId":"patchTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:edit"]},"x-purecloud-method-name":"patchTeam"}},"/api/v2/teams":{"get":{"tags":["Teams"],"summary":"Get Team listing","description":"","operationId":"getTeams","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only teams whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities.division"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeams"},"post":{"tags":["Teams"],"summary":"Create a team","description":"","operationId":"postTeams","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:add"]},"x-purecloud-method-name":"postTeams"}},"/api/v2/teams/search":{"post":{"tags":["Teams","Search"],"summary":"Search resources.","description":"","operationId":"postTeamsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TeamSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"postTeamsSearch"}},"/api/v2/telephony/mediaregions":{"get":{"tags":["Telephony"],"summary":"Retrieve the list of AWS regions media can stream through.","description":"","operationId":"getTelephonyMediaregions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaRegions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyMediaregions"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStation","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified station resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStation"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-purecloud-method-name":"deleteStationAssociateduser"}},"/api/v2/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"userSelectable","in":"query","description":"True for stations that the user can select otherwise false","required":false,"type":"string"},{"name":"webRtcUserId","in":"query","description":"Filter for the webRtc station of the webRtcUserId","required":false,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of stationIds","required":false,"type":"string"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Collaborate organizations do not have permission to work with stations","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting station listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting station listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStations"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}/headers":{"get":{"tags":["Telephony"],"summary":"Get SIP headers.","description":"Get parsed SIP headers. Returns specific headers if key query parameters are added.","operationId":"getTelephonySipmessagesConversationHeaders","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"},{"name":"keys","in":"query","description":"comma-separated list of header identifiers to query. e.g. ruri,to,from","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callheader"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversationHeaders"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}":{"get":{"tags":["Telephony"],"summary":"Get a SIP message.","description":"Get the raw form of the SIP message","operationId":"getTelephonySipmessagesConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callmessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversation"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postTelephonyProvidersEdgesAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Address","required":true,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgesAddressvalidation"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesCertificateauthorities"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthority"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Certificate authority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesCertificateauthority"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesCertificateauthority"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticPing"},"post":{"tags":["Telephony Providers Edge"],"summary":"Ping Request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticPing"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticTracepath"},"post":{"tags":["Telephony Providers Edge"],"summary":"Tracepath request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticTracepath"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticNslookup"},"post":{"tags":["Telephony Providers Edge"],"summary":"Nslookup request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticNslookup"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticRoute"},"post":{"tags":["Telephony Providers Edge"],"summary":"Route request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticRoute"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postTelephonyProvidersEdgeReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Parameters for the edge reboot","required":false,"schema":{"$ref":"#/definitions/EdgeRebootParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeReboot"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["site"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdge"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","fingerprint.too.early":"Fingerprint sent before awaiting fingerprint verification","cant.modify.edge.group":"Edge group cannot be modified when edge is in service.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.required":"The site field is missing a value.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","incorrect.fingerprint":"The provided edge fingerprint was not correct.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","editing.managed.property.not.allowed":"Editing managed properties is not allowed.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to modify a managed edge."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdge"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdge"}},"/api/v2/telephony/providers/edges/{edgeId}/statuscode":{"post":{"tags":["Telephony Providers Edge"],"summary":"Take an Edge in or out of service","description":"","operationId":"postTelephonyProvidersEdgeStatuscode","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge Service State","required":false,"schema":{"$ref":"#/definitions/EdgeServiceStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The active Edge(s) assigned to a Site must all be assigned to the same Edge Group.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified edgeId not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeStatuscode"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Software update request","required":true,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgeSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"deleteTelephonyProvidersEdgeSoftwareupdate"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDtoEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareversions"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getTelephonyProvidersEdgesTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesTimezones"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postTelephonyProvidersEdgeUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"edge.offline":"Cannot unpair an edge that is offline.","site.has.enabled.connections":"Cannot remove a site from an edge that has enabled site connection.","conflict":"The Edge must have an inactive state to complete this operation."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeUnpair"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getTelephonyProvidersEdgesEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgeversionreport"}},"/api/v2/telephony/providers/edges/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLogicalinterfaces"}},"/api/v2/telephony/providers/edges/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get physical interfaces for edges.","description":"Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhysicalinterfaces"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"showCloudMedia","in":"query","description":"True to show the cloud media devices in the result.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting edge listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error while getting edge listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge.","description":"","operationId":"postTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","duplicate.edge.name":"The edge name is already in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdges"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterface"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Information was missing or malformed in the request","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Logical interface cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLogicalinterface"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgeLogicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getTelephonyProvidersEdgePhysicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getTelephonyProvidersEdgePhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterfaces"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDidpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesDidpool"}},"/api/v2/telephony/providers/edges/didpools/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of unassigned and/or assigned numbers in a set of DID Pools.","description":"","operationId":"getTelephonyProvidersEdgesDidpoolsDids","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"The type of numbers to return.","required":true,"type":"string","enum":["ASSIGNED_AND_UNASSIGNED","UNASSIGNED"]},{"name":"id","in":"query","description":"Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"numberMatch","in":"query","description":"A number to filter the results by.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpoolsDids"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesDidpools"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDid"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getTelephonyProvidersEdgesDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"},{"name":"owner.id","in":"query","description":"Filter by the owner of a phone number","required":false,"type":"string"},{"name":"didPool.id","in":"query","description":"Filter by the DID Pool assignment","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting DID listings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDids"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["phoneTrunkBases","edgeTrunkBaseAssignment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroup"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to update managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroup"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesEdgegroup"}},"/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets the edge trunk base associated with the edge group","description":"","operationId":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the edge trunk base associated with the edge group","description":"","operationId":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeTrunkBase","required":true,"schema":{"$ref":"#/definitions/EdgeTrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge groups not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesEdgegroups"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:edit"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtensionpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:delete"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesExtensionpool"}},"/api/v2/telephony/providers/edges/extensionpools/divisionviews":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a pageable list of basic extension pool objects filterable by query parameters.","description":"This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the Extension Pools to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the Extension Pools to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:search"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"number","in":"query","description":"Deprecated, filtering by number not supported","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:add"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesExtensionpools"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtension"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getTelephonyProvidersEdgesExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensions"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesLinebasesetting","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesetting"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getTelephonyProvidersEdgesLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesettings"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getTelephonyProvidersEdgesLine","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLine"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getTelephonyProvidersEdgesLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated. The edgeGroup value is deprecated.","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLines"}},"/api/v2/telephony/providers/edges/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getTelephonyProvidersEdgesLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinesTemplate"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getTelephonyProvidersEdgeLogsJob","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the Edge logs job by given Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogsJob"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Log upload request","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job. Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find resource by given id(s).","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobUpload"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed. The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobs"}},"/api/v2/telephony/providers/edges/{edgeId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge metrics.","description":"","operationId":"getTelephonyProvidersEdgeMetrics","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find edge metrics by given id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeMetrics"}},"/api/v2/telephony/providers/edges/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of edges.","description":"","operationId":"getTelephonyProvidersEdgesMetrics","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EdgeMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMetrics"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplansClassifications"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplan","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","general.resource.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplan"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site. Only fetches the first 200 records.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans. A user can update maximum 200 number plans at a time.","description":"","operationId":"putTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of number plans","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"number.plan.in.use":"The number plan is in use by one or more outbound route.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.number.plan.name":"Number Plan names must be unique.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteNumberplans"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"Filter by externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroutes"}},"/api/v2/telephony/providers/edges/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id.","general.resource.not.found":"Unable to find a Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.expand.properties":"Server error, unable to expand base setting properties.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id","general.resource.not.found":"Unable to find a phone with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone base were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhonebasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Phone template cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhonebasesetting"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","lines"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Organization type is invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Phone base not found.","general.resource.not.found":"Phone base not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting phone base settings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtc user is required.","base.settings.required":"A base setting is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonebasesettings"}},"/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getTelephonyProvidersEdgesPhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonesTemplate"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the phone with that Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error find phone with that Id."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhone"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtcUser is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to update Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhone"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhone"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.","description":"","operationId":"getTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["name","status.operationalStatus","secondaryStatus.operationalStatus"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.id","required":false,"type":"string"},{"name":"lines.defaultForUser.id","in":"query","description":"Filter by lines.defaultForUser.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"lines.id","in":"query","description":"Filter by lines.id","required":false,"type":"string"},{"name":"lines.name","in":"query","description":"Filter by lines.name","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the Phone to filter by, comma-separated","required":false,"type":"string"},{"name":"status.operationalStatus","in":"query","description":"The primary status to filter by","required":false,"type":"string"},{"name":"secondaryStatus.operationalStatus","in":"query","description":"The secondary status to filter by","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser","lines.defaultForUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","lines.required":"A phone cannot be created without a line.","invalid.property":"Value [%s] is not a valid property for object [%s]","base.settings.required":"A base setting must be assigned to create a phone.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error posting phone instance."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhones"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postTelephonyProvidersEdgesPhoneReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhoneReboot"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postTelephonyProvidersEdgesPhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phones","required":true,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/expired":{"get":{"tags":["Telephony Providers Edge"],"summary":"List of edges more than 4 edge versions behind the latest software.","description":"","operationId":"getTelephonyProvidersEdgesExpired","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExpiredEdgeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","internal:edge:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExpired"}},"/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get site connections for a site.","description":"","operationId":"getTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteSiteconnections"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update site connections for a site.","description":"","operationId":"putTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/SiteConnections"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteSiteconnections"},"patch":{"tags":["Telephony Providers Edge"],"summary":"Disable site connections for a site.","description":"","operationId":"patchTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/DisableSiteConnectionsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"patchTelephonyProvidersEdgesSiteSiteconnections"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSite"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"The request could not be understood by the server due to malformed syntax.","managed.property.not.allowed":"Not allowed to update managed property","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"NEEDED"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the site were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSite"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to delete a managed site."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.referenced.by.another":"The site is referenced by another resource.","general.conflict":"The site is being referenced or is set as the default site."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSite"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["edges","location","primarySites","secondarySites"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"Unable to find entity that matches the key.","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSites"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an outbound route","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Dependent entities exist."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSiteOutboundroute"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound route","description":"","operationId":"postTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","address.classification.type.does.not.exist\t":"The address classification does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteOutboundroutes"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the trunk metrics.","description":"","operationId":"getTelephonyProvidersEdgesTrunkMetrics","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the trunk metrics with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkMetrics"}},"/api/v2/telephony/providers/edges/trunks/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of trunks.","description":"","operationId":"getTelephonyProvidersEdgesTrunksMetrics","produces":["application/json"],"parameters":[{"name":"trunkIds","in":"query","description":"Comma separated list of Trunk Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TrunkMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunksMetrics"}},"/api/v2/telephony/providers/edges/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to find the trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","validation.error":"Error validating the data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesTrunkbasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"delete.referenced.entity":"The trunk is being referenced.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to delete trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesTrunkbasesetting"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the TrunkBase to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Trunk base settings not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","trunk.metabase.required":"A metabase is required for this function.","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesTrunkbasesettings"}},"/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getTelephonyProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view","telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkswithrecording"}},"/api/v2/telephony/providers/edges/{edgeId}/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks for the given Edge.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgeTrunks","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Specified edgeId not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeTrunks"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getTelephonyProvidersEdgesTrunk","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Trunk ID not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunk"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgesTrunks","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Available Trunk resources not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/{edgeId}/setuppackage":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.","description":"","operationId":"getTelephonyProvidersEdgeSetuppackage","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VmPairingInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeSetuppackage"}},"/api/v2/telephony/siptraces":{"get":{"tags":["Telephony"],"summary":"Fetch SIP metadata","description":"Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","operationId":"getTelephonySiptraces","produces":["application/json"],"parameters":[{"name":"callId","in":"query","description":"unique identification of the placed call","required":false,"type":"string"},{"name":"toUser","in":"query","description":"User to who the call was placed","required":false,"type":"string"},{"name":"fromUser","in":"query","description":"user who placed the call","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"Unique identification of the conversation","required":false,"type":"string"},{"name":"dateStart","in":"query","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"dateEnd","in":"query","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptraces"}},"/api/v2/telephony/siptraces/download":{"post":{"tags":["Telephony"],"summary":"Request a download of a pcap file to S3","description":"","operationId":"postTelephonySiptracesDownload","produces":["application/json"],"parameters":[{"in":"body","name":"SIPSearchPublicRequest","required":true,"schema":{"$ref":"#/definitions/SIPSearchPublicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipDownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:add"]},"x-purecloud-method-name":"postTelephonySiptracesDownload"}},"/api/v2/telephony/siptraces/download/{downloadId}":{"get":{"tags":["Telephony"],"summary":"Get signed S3 URL for a pcap download","description":"","operationId":"getTelephonySiptracesDownloadDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"unique id for the downloaded file in S3","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"202":{"description":"Request to download pcap file has been accepted","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptracesDownloadDownloadId"}},"/api/v2/infrastructureascode/accelerators/{acceleratorId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get information about an accelerator","description":"Get the complete metadata specification for an accelerator, including requirements and parameters.","operationId":"getInfrastructureascodeAccelerator","produces":["application/json"],"parameters":[{"name":"acceleratorId","in":"path","description":"Accelerator ID","required":true,"type":"string"},{"name":"preferredLanguage","in":"query","description":"Preferred Language","required":false,"type":"string","default":"en-US","enum":["ar","cs","da","de","en-US","es","fi","fr","it","iw","ko","ja","nl","no","pl","pt-BR","pt-PT","sv","th","tr","zh-CN","zh-TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorSpecification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerator"}},"/api/v2/infrastructureascode/accelerators":{"get":{"tags":["Infrastructure as Code"],"summary":"Get a list of available accelerators","description":"Search for accelerators that can be run.","operationId":"getInfrastructureascodeAccelerators","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Filter by name","required":false,"type":"string"},{"name":"description","in":"query","description":"Filter by description","required":false,"type":"string"},{"name":"origin","in":"query","description":"Filter by origin","required":false,"type":"string","enum":["community","partner","genesys"]},{"name":"type","in":"query","description":"Filter by type","required":false,"type":"string","enum":["module","accelerator","blueprint"]},{"name":"classification","in":"query","description":"Filter by classification","required":false,"type":"string"},{"name":"tags","in":"query","description":"Filter by tags","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerators"}},"/api/v2/infrastructureascode/jobs/{jobId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job status and results","description":"Get the execution status of a submitted job, optionally including results and error details.","operationId":"getInfrastructureascodeJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"name":"details","in":"query","description":"Include details of execution, including job results or error information","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"202":{"description":"Job in progress.","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["infrastructureascode:job:view"]},"x-purecloud-method-name":"getInfrastructureascodeJob"}},"/api/v2/infrastructureascode/jobs":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job history","description":"Get a history of submitted jobs, optionally including error messages.","operationId":"getInfrastructureascodeJobs","produces":["application/json"],"parameters":[{"name":"maxResults","in":"query","description":"Number of jobs to show","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeErrors","in":"query","description":"Include error messages","required":false,"type":"boolean","default":false},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"dateSubmitted","enum":["id","dateSubmitted","submittedBy","acceleratorId","status"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc","enum":["asc","desc"]},{"name":"acceleratorId","in":"query","description":"Find only jobs associated with this accelerator","required":false,"type":"string"},{"name":"submittedBy","in":"query","description":"Find only jobs submitted by this user","required":false,"type":"string"},{"name":"status","in":"query","description":"Find only jobs in this state","required":false,"type":"string","enum":["Created","Queued","Running","Complete","Failed","Incomplete"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:job:view"]},"x-purecloud-method-name":"getInfrastructureascodeJobs"},"post":{"tags":["Infrastructure as Code"],"summary":"Create a Job","description":"Create and submit a job for remote execution or see job planning results.","operationId":"postInfrastructureascodeJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/AcceleratorInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"202":{"description":"Job submitted for execution.","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:job:add"]},"x-purecloud-method-name":"postInfrastructureascodeJobs"}},"/api/v2/textbots/botflows/sessions/{sessionId}/turns":{"post":{"tags":["Textbots"],"summary":"Issue a bot flow turn event","description":"Send a turn event to an executing bot flow and produce the next action to take.","operationId":"postTextbotsBotflowsSessionTurns","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'","required":true,"type":"string"},{"in":"body","name":"turnRequest","required":true,"schema":{"$ref":"#/definitions/TextBotFlowTurnRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextBotFlowTurnResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.already.closed":"The bot session is closed","mismatched.turn.id":"The turn provided is not expected","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","too.many.queued.user.input.events":"Too many queued user input events have been submitted","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","unexpected.input.event":"An unexpected input event has been submitted","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","flow.blocked":"Flow ID %s has been temporarily blocked.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:botFlowSession:execute"]},"x-purecloud-method-name":"postTextbotsBotflowsSessionTurns"}},"/api/v2/textbots/botflows/sessions":{"post":{"tags":["Textbots"],"summary":"Create an execution instance of a bot flow definition.","description":"The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.","operationId":"postTextbotsBotflowsSessions","produces":["application/json"],"parameters":[{"in":"body","name":"launchRequest","required":true,"schema":{"$ref":"#/definitions/TextBotFlowLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextBotFlowLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flow.version.not.published":"The flow version is not published","invalid.input.variables":"One or more of your input variables are invalid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","flow.blocked":"Flow ID %s has been temporarily blocked.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:botFlowSession:execute"]},"x-purecloud-method-name":"postTextbotsBotflowsSessions"}},"/api/v2/textbots/bots/execute":{"post":{"tags":["Textbots"],"summary":"Send an intent to a bot to start a dialog/interact with it via text","description":"This will either start a bot with the given id or relay a communication to an existing bot session.","operationId":"postTextbotsBotsExecute","produces":["application/json"],"parameters":[{"in":"body","name":"postTextRequest","required":true,"schema":{"$ref":"#/definitions/PostTextRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PostTextResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.invalid.bot.product":"The bot product type is unrecognized","bots.invalid.bot.argument":"An argument passed on to the bot was declared invalid by the bot service","bad.request":"The request could not be understood by the server due to malformed syntax.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","bots.bot.circuit.open":"The bot service is non responsive and we're in a back-off state until the service is restored.","bots.invalid.bot.vendor":"The bot vendor type is unrecognized","constraint.validation":"%s","bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.bot.session.closed":"The bot session is already closed and cannot be reused","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","bots.unsupported.language":"The language code is unsupported or not recognized","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bots.invalid.bot.session.outcome":"The bot outcome is not recognized","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:session:execute"]},"x-purecloud-method-name":"postTextbotsBotsExecute"}},"/api/v2/textbots/bots/search":{"get":{"tags":["Textbots"],"summary":"Find bots using the currently configured friendly name or ID.","description":"The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100","operationId":"getTextbotsBotsSearch","produces":["application/json"],"parameters":[{"name":"botType","in":"query","description":"Bot types","required":false,"type":"array","items":{"type":"string","enum":["GenesysBotConnector","GenesysDialogEngine","AmazonLex","GoogleDialogFlowES","GoogleDialogFlowCX","NuanceDlg","GenesysBotFlow"]},"collectionFormat":"multi"},{"name":"botName","in":"query","description":"Bot name","required":false,"type":"string"},{"name":"botId","in":"query","description":"Bot IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"The maximum results to return","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotSearchResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getTextbotsBotsSearch"}},"/api/v2/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getTimezones"}},"/api/v2/tokens/timeout":{"get":{"tags":["Tokens"],"summary":"Get the current Idle Token Timeout Value","description":"","operationId":"getTokensTimeout","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdleTokenTimeout"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getTokensTimeout"},"put":{"tags":["Tokens"],"summary":"Update or Enable/Disable the Idle Token Timeout","description":"","operationId":"putTokensTimeout","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IdleTokenTimeout"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdleTokenTimeout"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"token.timeout.exceeded":"When HIPAA is not enabled timeout must be between 300 and 28800 seconds","token.timeout.exceeded.hipaa":"When HIPAA is enabled timeout must be between 300 and 900 seconds","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","max.idle.token.timeout.exceeded":"When HIPAA is disabled timeout must be between 5 minutes and 8 hours.","invalid.property":"Value [%s] is not a valid property for object [%s]","max.idle.hipaa.token.timeout.exceeded":"When HIPAA is enabled timeout must be 15 minutes or less","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putTokensTimeout"}},"/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}":{"get":{"tags":["Integrations"],"summary":"UC integration client application configuration.","description":"This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.","operationId":"getIntegrationsUnifiedcommunicationsClientapp","produces":["application/json"],"parameters":[{"name":"ucIntegrationId","in":"path","description":"3rd Party Service Type","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedCommunicationsIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not available","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Integration could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsUnifiedcommunicationsClientapp"}},"/api/v2/integrations/unifiedcommunications/clientapps":{"get":{"tags":["Integrations"],"summary":"List UC integration client application configurations.","description":"This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.","operationId":"getIntegrationsUnifiedcommunicationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedCommunicationsIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not enabled for your organization","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsUnifiedcommunicationsClientapps"}},"/api/v2/integrations/clientapps/unifiedcommunications":{"get":{"tags":["Integrations"],"summary":"UC integration client application configuration.","description":"Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.","operationId":"getIntegrationsClientappsUnifiedcommunications","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UCIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not enabled for your organization","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsClientappsUnifiedcommunications"}},"/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences":{"put":{"tags":["Integrations"],"summary":"Bulk integration presence ingestion","description":"This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.","operationId":"putIntegrationsUnifiedcommunicationThirdpartypresences","produces":["application/json"],"parameters":[{"name":"ucIntegrationId","in":"path","description":"UC Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UCThirdPartyPresence"}}}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 25 user presences can be updated at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","no.user.presences":"No users matched integration presence lookup.","integration.not.found":"Integration ID not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:presence:edit"]},"x-purecloud-method-name":"putIntegrationsUnifiedcommunicationThirdpartypresences"}},"/api/v2/usage/query":{"post":{"tags":["Usage"],"summary":"Query organization API Usage - ","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postUsageQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageOrganizationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:organization:view"]},"x-purecloud-method-name":"postUsageQuery"}},"/api/v2/usage/query/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getUsageQueryExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:organization:view"]},"x-purecloud-method-name":"getUsageQueryExecutionIdResults"}},"/api/v2/usage/simplesearch":{"post":{"tags":["Usage"],"summary":"Search organization API Usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results","operationId":"postUsageSimplesearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SimpleSearch","required":true,"schema":{"$ref":"#/definitions/ApiUsageSimpleSearch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:simpleSearch:view"]},"x-purecloud-method-name":"postUsageSimplesearch"}},"/api/v2/usage/simplesearch/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage search. Number of records to be returned is limited to 20,000 results.","description":"","operationId":"getUsageSimplesearchExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the search execution","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The max number of entities to be returned per request. Maximum page size of 1000","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.response.size.reached":"The results data is greater than the 5MB limit. Try again with a smaller date interval or include more filters.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","query.error":"There was a problem running the query"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:simpleSearch:view"]},"x-purecloud-method-name":"getUsageSimplesearchExecutionIdResults"}},"/api/v2/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"async","in":"query","description":"When set to true, api will return 202 response until the recording is ready for download","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Recording is queued for transcoding","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingMedia"}},"/api/v2/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecording"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":true,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"putUserrecording"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"deleteUserrecording"}},"/api/v2/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getUserrecordingsSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingsSummary"}},"/api/v2/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You are not permitted to get a list of user recordings.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordings"}},"/api/v2/users/{userId}/externalid":{"post":{"tags":["Users"],"summary":"Create mapping between external identifier and user. Limit 100 per entity.","description":"Authority Name and External key are case sensitive.","operationId":"postUserExternalid","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/UserExternalIdentifier"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserExternalIdentifier"}}},"201":{"description":"External Identifier Created","schema":{"type":"array","items":{"$ref":"#/definitions/UserExternalIdentifier"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"The external identifier already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"postUserExternalid"}},"/api/v2/users/me/password":{"post":{"tags":["Users"],"summary":"Change your password","description":"","operationId":"postUsersMePassword","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangeMyPasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"password.compromised":"The new password is a compromised, frequently used password","password.too.young":"The new password cannot be changed yet","bad.request":"The request could not be understood by the server due to malformed syntax.","password.empty":"The new password cannot be empty","password.not.enough.digits":"The new password does not have enough numbers","password.not.enough.specials":"The new password does not have enough special characters","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.old.password":"The old password is incorrect.","constraint.validation":"%s","invalid.new.password":"The new password does not meet policy requirements.","invalid.password":"The new password does not meet policy requirements or the old password is incorrect.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","password.not.enough.letters":"The new password does not have enough letters","password.not.enough.lowercase":"The new password does not have enough lower case letters","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","password.reused":"The new password has been used too recently","password.not.enough.uppercase":"The new password does not have enough upper case letters","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","password.too.short":"The new password is too short"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"postUsersMePassword"}},"/api/v2/users/me":{"get":{"tags":["Users"],"summary":"Get current user details.","description":"This request is not valid when using the Client Credentials OAuth grant.","operationId":"getUsersMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","date","geolocationsettings","organization","presencedefinitions","divisionedpresencedefinitions","locationdefinitions","orgauthorization","orgproducts","favorites","superiors","directreports","adjacents","routingskills","routinglanguages","fieldconfigs","token","trustors","logCapture"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested userID could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getUsersMe"}},"/api/v2/users/{userId}/password":{"post":{"tags":["Users"],"summary":"Change a users password","description":"","operationId":"postUserPassword","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangePasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"password.compromised":"The new password is a compromised, frequently used password","password.too.young":"The new password cannot be changed yet","bad.request":"The request could not be understood by the server due to malformed syntax.","password.empty":"The new password cannot be empty","password.not.enough.digits":"The new password does not have enough numbers","password.not.enough.specials":"The new password does not have enough special characters","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.new.password":"The new password does not meet policy requirements","invalid.password":"The new password does not meet policy requirements","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","password.not.enough.letters":"The new password does not have enough letters","password.not.enough.lowercase":"The new password does not have enough lower case letters","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","password.reused":"The new password has been used too recently","password.not.enough.uppercase":"The new password does not have enough upper case letters","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","password.too.short":"The new password is too short"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:setPassword"]},"x-purecloud-method-name":"postUserPassword"}},"/api/v2/users/{userId}/profileskills":{"get":{"tags":["Users"],"summary":"List profile skills for a user","description":"","operationId":"getUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:view"]},"x-purecloud-method-name":"getUserProfileskills"},"put":{"tags":["Users"],"summary":"Update profile skills for a user","description":"","operationId":"putUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skills","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:edit"]},"x-purecloud-method-name":"putUserProfileskills"}},"/api/v2/users/{userId}/queues/{queueId}":{"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueue"}},"/api/v2/users/{userId}/queues":{"get":{"tags":["Routing","Users"],"summary":"Get queues for user","description":"","operationId":"getUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"joined","in":"query","description":"Is joined to the queue","required":false,"type":"boolean","default":true},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"getUserQueues"},"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueues"}},"/api/v2/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},{"name":"state","in":"query","description":"Search for a user with this state","required":false,"type":"string","default":"active","enum":["active","deleted"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUser"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Conflict deleting specified userId."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId. ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete","directory:organization:admin"]},"x-purecloud-method-name":"deleteUser"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UpdateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The version supplied does not match the current version of the user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","insufficient.permissions":"Insufficient permissions to update a user","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:organization:admin"]},"x-purecloud-method-name":"patchUser"}},"/api/v2/users/{userId}/invite":{"post":{"tags":["Users"],"summary":"Send an activation email to the user","description":"","operationId":"postUserInvite","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Resend the invitation even if one is already outstanding","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Invitation Sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","insufficient.permissions":"Insufficient permissions for sending an activation email.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","directory:userPassword:edit"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Users","Routing"],"summary":"Remove routing language from user","description":"","operationId":"deleteUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"}],"responses":{"204":{"description":"Language removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Routing language was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"deleteUserRoutinglanguage"},"patch":{"tags":["Users","Routing"],"summary":"Update routing language proficiency or state.","description":"","operationId":"patchUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguage"}},"/api/v2/users/{userId}/routinglanguages":{"get":{"tags":["Users","Routing"],"summary":"List routing language for user","description":"","operationId":"getUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutinglanguages"},"post":{"tags":["Users","Routing"],"summary":"Add routing language to user","description":"","operationId":"postUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguagePost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict adding route language to user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postUserRoutinglanguages"}},"/api/v2/users/{userId}/routinglanguages/bulk":{"patch":{"tags":["Users","Routing"],"summary":"Add bulk routing language to user. Max limit 50 languages","description":"","operationId":"patchUserRoutinglanguagesBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguagePost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguagesBulk"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Users","Routing"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskill"},"delete":{"tags":["Users","Routing"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"deleteUserRoutingskill"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Users","Routing"],"summary":"List routing skills for user","description":"","operationId":"getUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingskills"},"post":{"tags":["Users","Routing"],"summary":"Add routing skill to user","description":"","operationId":"postUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkillPost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Error adding route skill to user, bad request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict found adding route skill to user."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"postUserRoutingskills"}},"/api/v2/users/{userId}/routingskills/bulk":{"put":{"tags":["Users","Routing"],"summary":"Replace all routing skills assigned to a user","description":"","operationId":"putUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflicts found replacing routing skills for user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"One or more route skill(s) not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskillsBulk"},"patch":{"tags":["Users","Routing"],"summary":"Bulk add routing skills to user","description":"","operationId":"patchUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"patchUserRoutingskillsBulk"}},"/api/v2/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":true,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"An invalid routing status transition was attempted.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserRoutingstatus"}},"/api/v2/users/{userId}/skillgroups":{"get":{"tags":["Routing","Users"],"summary":"Get skill groups for a user","description":"","operationId":"getUserSkillgroups","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"after","in":"query","description":"The cursor that points to the next page","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getUserSkillgroups"}},"/api/v2/users/{userId}/state":{"get":{"tags":["Users"],"summary":"Get user state information.","description":"","operationId":"getUserState","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserState"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userStateChange:view"]},"x-purecloud-method-name":"getUserState"},"put":{"tags":["Users"],"summary":"Update user state information.","description":"","operationId":"putUserState","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UserState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserState"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"putUserState"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserStation"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to create a tab configuration due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"edgeconfiguser.userdoesnotexist":"The requested user was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"deleteUserStationAssociatedstation"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.stationalreadyhasdefaultuser":"Station is already associated","general.conflict":"2 or more users attempted to set the station as their default at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"putUserStationDefaultstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"deleteUserStationDefaultstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","userservice.station.notfound":"Station is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.station.providerlocationmissing":"The location of the station could not be found","userservice.stationalreadyassociated":"Station is already associated","general.conflict":"2 or more users attempted to associate with the station at the same time.","userservice.station.nothomed":"The station is incorrectly or not assigned"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserStationAssociatedstationStationId"}},"/api/v2/users/{userId}/trustors":{"get":{"tags":["Users"],"summary":"List the organizations that have authorized/trusted the user.","description":"","operationId":"getUserTrustors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getUserTrustors"}},"/api/v2/users/bulk":{"patch":{"tags":["Users"],"summary":"Update bulk acd autoanswer on users. Max 50 users can be updated at a time.","description":"","operationId":"patchUsersBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PatchUser"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max user ids":"Only 50 users can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","max.directory.users":"Only 50 users can be requested at a time","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:organization:admin"]},"x-purecloud-method-name":"patchUsersBulk"}},"/api/v2/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","default":"active","enum":["active","inactive","deleted","any"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested user(s) could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.password":"The user was created successfully but the provided password does not meet the password policy requirements","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.set.password":"The user was created successfully but password configuration failed","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUsers"}},"/api/v2/users/search":{"get":{"tags":["Users","Search"],"summary":"Search users using the q64 value returned from a previous search","description":"","operationId":"getUsersSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"integrationPresenceSource","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getUsersSearch"},"post":{"tags":["Users","Search"],"summary":"Search users","description":"","operationId":"postUsersSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postUsersSearch"}},"/api/v2/users/search/teams/assign":{"post":{"tags":["Users","Search"],"summary":"Search users assigned to teams","description":"","operationId":"postUsersSearchTeamsAssign","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"postUsersSearchTeamsAssign"}},"/api/v2/voicemail/groups/{groupId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailGroupMessages","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"Not authorized to access voicemail messages","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMessages"}},"/api/v2/voicemail/queues/{queueId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailQueueMessages","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["voicemail:acdvoicemail:view"]},"x-purecloud-method-name":"getVoicemailQueueMessages"}},"/api/v2/voicemail/me/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMeMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMessages"}},"/api/v2/voicemail/groups/{groupId}/policy":{"get":{"tags":["Voicemail"],"summary":"Get a group's voicemail policy","description":"","operationId":"getVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.groupnotfound":"The voicemail policy was not found","general.resource.not.found":"The voicemail policy was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"getVoicemailGroupPolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a group's voicemail policy","description":"","operationId":"patchVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The group's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"patchVoicemailGroupPolicy"}},"/api/v2/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMailbox"}},"/api/v2/voicemail/me/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMeMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMailbox"}},"/api/v2/voicemail/groups/{groupId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the group's mailbox information","description":"","operationId":"getVoicemailGroupMailbox","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMailbox"}},"/api/v2/voicemail/me/policy":{"get":{"tags":["Voicemail"],"summary":"Get the current user's voicemail policy","description":"","operationId":"getVoicemailMePolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMePolicy"},"patch":{"tags":["Voicemail"],"summary":"Update the current user's voicemail policy","description":"","operationId":"patchVoicemailMePolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMePolicy"}},"/api/v2/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get a voicemail message","description":"","operationId":"getVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessage"},"put":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"putVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","constraint.validation":"%s","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"putVoicemailMessage"},"delete":{"tags":["Voicemail"],"summary":"Delete a voicemail message.","description":"A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.","operationId":"deleteVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessage"},"patch":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"patchVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","constraint.validation":"%s","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.toomanyrequests":"Too many requests have been made in the given time","voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMessage"}},"/api/v2/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this voicemail message","description":"","operationId":"getVoicemailMessageMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessageMedia"}},"/api/v2/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMessages","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"An optional comma separated list of VoicemailMessage ids","required":false,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access a voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessages"},"post":{"tags":["Voicemail"],"summary":"Copy a voicemail message to a user or group","description":"","operationId":"postVoicemailMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CopyVoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","voicemail.copy.missing.voicemail.message.id":"The request requires a voicemailMessageId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.copy.missing.target":"The request requires a userId or groupId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.copy.group.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the group because they do not have voicemail enabled","voicemail.copy.user.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the user because they do not have voicemail enabled"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"postVoicemailMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteVoicemailMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessages"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailPolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getVoicemailPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailPolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.alerttimeouttoolarge":"AlertTimeoutTooLarge","voicemailservice.orgvoicemailconfig.maxpinlengthtoosmall":"MaxPinLengthTooSmall","voicemailservice.orgvoicemailconfig.iterationstoolarge":"IterationsTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaysmissing":"UserVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypemissing":"GroupVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimegreaterthanmax":"MinRecordingTimeGreaterThanMax","voicemailservice.orgvoicemailconfig.organizationnotfound":"OrganizationNotFound","voicemailservice.orgvoicemailconfig.saltlengthtoolarge":"SaltLengthTooLarge","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaysmissing":"GroupVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoolarge":"GroupVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypemissing":"UserVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypeunknown":"QueueVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoosmall":"GroupVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthtoosmall":"MinPinLengthTooSmall","voicemailservice.orgvoicemailconfig.maxrecordingtimetoolarge":"MaxRecordingTimeTooLarge","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoolarge":"QueueVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypeunknown":"UserVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.alerttimeouttoosmall":"AlertTimeoutTooSmall","voicemailservice.orgvoicemailconfig.iterationstoosmall":"IterationsTooSmall","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoolarge":"UserVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.invalidalgorithm":"InvalidAlgorithm","voicemailservice.orgvoicemailconfig.keylengthtoosmall":"KeyLengthTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoosmall":"QueueVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypemissing":"QueueVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimetoosmall":"MinRecordingTimeTooSmall","voicemailservice.orgvoicemailconfig.hipaaenabledorganizationcannotsendemailnotifications":"HipaaEnabledOrganizationCannotSendEmailNotifications","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaysmissing":"QueueVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypeunknown":"GroupVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoosmall":"UserVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.keylengthtoolarge":"KeyLengthTooLarge","voicemailservice.orgvoicemailconfig.saltlengthtoosmall":"SaltLengthTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthgreaterthanmax":"MinPinLengthGreaterThanMax"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.unabletoverifyorganizationhipaaenabledflag":"UnableToVerifyOrganizationHipaaEnabledFlag"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailPolicy"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.user.usernotfound":"The specified voicemail user not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailUserpolicy"},"put":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"putVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailUserpolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailUserpolicy"}},"/api/v2/voicemail/search":{"get":{"tags":["Voicemail","Search"],"summary":"Search voicemails using the q64 value returned from a previous search","description":"","operationId":"getVoicemailSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailSearch"},"post":{"tags":["Voicemail","Search"],"summary":"Search voicemails","description":"","operationId":"postVoicemailSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/VoicemailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"postVoicemailSearch"}},"/api/v2/flows/jobs":{"post":{"tags":["Architect"],"summary":"Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.","description":"","operationId":"postFlowsJobs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RegisterArchitectJobResponse"}},"202":{"description":"Architect Job registered.","schema":{"$ref":"#/definitions/RegisterArchitectJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:job:create"]},"x-purecloud-method-name":"postFlowsJobs"}},"/api/v2/flows/jobs/{jobId}":{"get":{"tags":["Architect"],"summary":"Fetch Architect Job Status","description":"","operationId":"getFlowsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ArchitectJobStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a job with that jobId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:job:view"]},"x-purecloud-method-name":"getFlowsJob"}},"/api/v2/architect/dependencytracking/consumedresources":{"get":{"tags":["Architect"],"summary":"Get resources that are consumed by a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumedresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consuming object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Consuming object version","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consuming object type. Only versioned types are allowed here.","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"resourceType","in":"query","description":"Types of consumed resources to show","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumedResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.dependency.object.version.not.specified":"A version was not specified for the dependency object.","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumedresources"}},"/api/v2/architect/dependencytracking/consumingresources":{"get":{"tags":["Architect"],"summary":"Get resources that consume a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumingresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consumed object ID","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consumed object type","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"resourceType","in":"query","description":"Types of consuming resources to show. Only versioned types are allowed here.","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumingResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumingresources"}},"/api/v2/architect/dependencytracking/deletedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that consume deleted resources","description":"","operationId":"getArchitectDependencytrackingDeletedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.filter":"An invalid filter was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingDeletedresourceconsumers"}},"/api/v2/architect/dependencytracking/build":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking build status for an organization","description":"","operationId":"getArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingBuild"},"post":{"tags":["Architect"],"summary":"Rebuild Dependency Tracking data for an organization","description":"Asynchronous. Notification topic: v2.architect.dependencytracking.build","operationId":"postArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - the rebuild has begun."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependencies.build.in.progress":"A build of dependency information is already in progress."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:rebuild"]},"x-purecloud-method-name":"postArchitectDependencytrackingBuild"}},"/api/v2/architect/dependencytracking/object":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingObject","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type","required":false,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"consumedResources","in":"query","description":"Include resources this item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume this item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResourceRequest","in":"query","description":"Indicate that this is going to look up a consumed resource object","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObject"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","architect.dependency.object.not.versioned":"A version was provided for a non-versioned dependency object type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingObject"}},"/api/v2/architect/dependencytracking":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that have a given display name","description":"","operationId":"getArchitectDependencytracking","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Object name to search for","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResources","in":"query","description":"Include resources each result item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume each result item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the organization's data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.dependency.object.name.not.specified":"A name was not specified for the dependency object search.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytracking"}},"/api/v2/architect/dependencytracking/types/{typeId}":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking type.","description":"","operationId":"getArchitectDependencytrackingType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Type ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.type":"An invalid dependency type was specified.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.unavailable.type":"Dependency Tracking type is unavailable."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingType"}},"/api/v2/architect/dependencytracking/types":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking types.","description":"","operationId":"getArchitectDependencytrackingTypes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingTypes"}},"/api/v2/architect/emergencygroups/{emergencyGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a emergency group by ID","description":"","operationId":"getArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroup"},"put":{"tags":["Architect"],"summary":"Updates a emergency group by ID","description":"","operationId":"putArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the emergency group were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:edit"]},"x-purecloud-method-name":"putArchitectEmergencygroup"},"delete":{"tags":["Architect"],"summary":"Deletes a emergency group by ID","description":"","operationId":"deleteArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"could not find the requested emergency group","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:delete"]},"x-purecloud-method-name":"deleteArchitectEmergencygroup"}},"/api/v2/architect/emergencygroups/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic emergency group objects filterable by query parameters.","description":"This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getArchitectEmergencygroupsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the Emergency Groups to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:search"]},"x-purecloud-method-name":"getArchitectEmergencygroupsDivisionviews"}},"/api/v2/architect/emergencygroups":{"get":{"tags":["Architect"],"summary":"Get a list of emergency groups.","description":"","operationId":"getArchitectEmergencygroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroups"},"post":{"tags":["Architect"],"summary":"Creates a new emergency group","description":"","operationId":"postArchitectEmergencygroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:add"]},"x-purecloud-method-name":"postArchitectEmergencygroups"}},"/api/v2/flows/actions/unlock":{"post":{"tags":["Architect"],"summary":"Unlock flow","description":"Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.","operationId":"postFlowsActionsUnlock","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsUnlock"}},"/api/v2/flows/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsPublish","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"202":{"description":"Accepted - the publish has begun"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.auth.token.missing":"This operation cannot be performed without an authorization token.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.flow.cannot.publish.default":"Cannot publish default version of flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.publish.missing.dependencies":"Flow version cannot be published due to having one or more missing dependencies.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.flow.locked.by.user":"Flow is locked by another user.","architect.flow.cannot.checkin.missing.config":"Flow cannot be checked in because there is no saved configuration.","architect.operation.already.in.progress":"An operation is already in progress on the object.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.variable.missing":"Flow cannot be published because one or more variables are missing.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unknown error occurred.","architect.external.publish.error":"A backend service error occurred while publishing the flow.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock","architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsPublish"}},"/api/v2/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit","architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsCheckin"}},"/api/v2/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postFlowsActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.locked.by.user":"Flow is locked by another user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsCheckout"}},"/api/v2/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postFlowsActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.default.voicemail.flow.cannot.deactivate":"Cannot deactivate the default voicemail flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.default.flow.cannot.deactivate":"Cannot deactivate the default in-queue flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.deactivate.used.in.emergency.groups":"The flow cannot be deactivated because it's being used by one or more emergency groups.","architect.flow.cannot.deactivate.used.in.pe.action.maps":"The flow cannot be deactivated because it's being used by one or more predictive engagement action maps.","architect.flow.cannot.deactivate.used.in.queues":"The flow cannot be deactivated because it's being used by one or more queues.","architect.flow.cannot.deactivate.used.in.email.routes":"The flow cannot be deactivated because it's being used by one or more email routes.","architect.flow.cannot.deactivate.used.by.message.addresses":"The flow cannot be deactivated because it's being used by one or more message addresses.","architect.flow.cannot.deactivate.used.in.widgets":"The flow cannot be deactivated because it's being used by one or more widgets.","architect.flow.cannot.deactivate.used.in.ivr.configs":"The flow cannot be deactivated because it's being used by one or more IVR configurations.","architect.flow.cannot.deactivate.used.in.recording.policies":"The flow cannot be deactivated because it's being used by one or more recording policies.","architect.flow.cannot.deactivate.used.in.composer.scripts":"The flow cannot be deactivated because it's being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsDeactivate"}},"/api/v2/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postFlowsActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsRevert"}},"/api/v2/flows/executions/{flowExecutionId}":{"get":{"tags":["Architect"],"summary":"Get a flow execution's details. Flow execution details are available for several days after the flow is started.","description":"","operationId":"getFlowsExecution","produces":["application/json"],"parameters":[{"name":"flowExecutionId","in":"path","description":"flow execution ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowRuntimeExecution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Specifiec flow execution not found.","architect.execution.flow.not.found":"Could not find flow execution with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowExecution:view"]},"x-purecloud-method-name":"getFlowsExecution"}},"/api/v2/flows/executions":{"post":{"tags":["Architect"],"summary":"Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.","description":"The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.","operationId":"postFlowsExecutions","produces":["application/json"],"parameters":[{"in":"body","name":"flowLaunchRequest","required":true,"schema":{"$ref":"#/definitions/FlowExecutionLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flow.config.not.published":"Flow definition has not been published","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","flow.definition.missing":"Flow definition file cannot be loaded","architect.object.validate.failed":"Failed to validate object.","variable.value.not.allowed":"The variable value is not a legal value","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.var.not.marked.in.flow.def":"Input variable in the Variable Manifest List from the flow launch request object has not been marked as an Input to flow within the Architect flow definition","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","flow.invalid.state":"Flow definition is in an invalid state"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.not.found":"An item could not be found","not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Could not find flow execution with specified ID.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:launch"]},"x-purecloud-method-name":"postFlowsExecutions"}},"/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health":{"get":{"tags":["Architect"],"summary":"Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.","description":"","operationId":"getFlowVersionIntentHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"intentId","in":"path","description":"Intent ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":true,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealthIntent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionIntentHealth"}},"/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health":{"get":{"tags":["Architect"],"summary":"Get health metrics associated with a specific utterance of an intent.","description":"","operationId":"getFlowVersionIntentUtteranceHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"intentId","in":"path","description":"Intent ID.","required":true,"type":"string"},{"name":"utteranceId","in":"path","description":"Utterance ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":true,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealthUtterance"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionIntentUtteranceHealth"}},"/api/v2/flows/{flowId}/versions/{versionId}/health":{"get":{"tags":["Architect"],"summary":"Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.","description":"","operationId":"getFlowVersionHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":false,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealth"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionHealth"}},"/api/v2/flows/milestones/{milestoneId}":{"get":{"tags":["Architect"],"summary":"Get a flow milestone","description":"Returns a specified flow milestone","operationId":"getFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Specified flow milestone not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestone"},"put":{"tags":["Architect"],"summary":"Updates a flow milestone","description":"","operationId":"putFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:edit"]},"x-purecloud-method-name":"putFlowsMilestone"},"delete":{"tags":["Architect"],"summary":"Delete a flow milestone.","description":"","operationId":"deleteFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:delete"]},"x-purecloud-method-name":"deleteFlowsMilestone"}},"/api/v2/flows/milestones/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow milestone information objects filterable by query parameters.","description":"This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsMilestonesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:search"]},"x-purecloud-method-name":"getFlowsMilestonesDivisionviews"}},"/api/v2/flows/milestones":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow milestones, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.","operationId":"getFlowsMilestones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestones"},"post":{"tags":["Architect"],"summary":"Create a flow milestone","description":"","operationId":"postFlowsMilestones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.exceeded.max.amount":"Could not create flow milestone since the maximum number of milestones already exist.","architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:add"]},"x-purecloud-method-name":"postFlowsMilestones"}},"/api/v2/flows/outcomes/{flowOutcomeId}":{"get":{"tags":["Architect"],"summary":"Get a flow outcome","description":"Returns a specified flow outcome","operationId":"getFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Specified flow outcome not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcome"},"put":{"tags":["Architect"],"summary":"Updates a flow outcome","description":"Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}","operationId":"putFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find the specified flow outcome.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:edit"]},"x-purecloud-method-name":"putFlowsOutcome"}},"/api/v2/flows/outcomes/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow outcome information objects filterable by query parameters.","description":"This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsOutcomesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:search"]},"x-purecloud-method-name":"getFlowsOutcomesDivisionviews"}},"/api/v2/flows/outcomes":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow outcomes, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.","operationId":"getFlowsOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find resource with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcomes"},"post":{"tags":["Architect"],"summary":"Create a flow outcome","description":"Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}","operationId":"postFlowsOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.validate.failed":"Failed to validate flow outcome.","architect.flow.outcome.validate.failed.missing.name":"Failed to validate flow outcome due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","architect.flow.outcome.exceeded.max.amount":"Could not create flow outcome since the maximum number of outcomes already exist."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:add"]},"x-purecloud-method-name":"postFlowsOutcomes"}},"/api/v2/flows/{flowId}/history":{"post":{"tags":["Architect"],"summary":"Generate flow history","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowHistory","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"postFlowHistory"}},"/api/v2/flows/{flowId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated flow history","description":"","operationId":"getFlowHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowHistoryHistoryId"}},"/api/v2/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow","description":"","operationId":"getFlowLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flow.no.config.available":"Flow has no saved or checked-in configuration."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowLatestconfiguration"}},"/api/v2/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow","description":"","operationId":"getFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","Inbound.Email.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound email flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","Outbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an outbound call flow.","Inbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound call flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","Inqueue.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inqueue call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey invite flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlow"},"put":{"tags":["Architect"],"summary":"Update flow","description":"","operationId":"putFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.system.flow.name.or.description.error":"System flow names and descriptions cannot be changed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"putFlow"},"delete":{"tags":["Architect"],"summary":"Delete flow","description":"","operationId":"deleteFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.default.flow.cannot.delete":"Cannot delete the default in-queue flow.","architect.flow.cannot.delete.user.does.not.have.lock":"Flow cannot be deleted because it is locked by another user.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.default.voicemail.flow.cannot.delete":"Cannot delete the default voicemail flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.pe.action.maps":"Flow cannot be deleted due to being used by one or more predictive engagement action maps.","architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.flow.cannot.delete.used.in.widgets":"Flow cannot be deleted due to being used by one or more widgets.","architect.flow.cannot.delete.used.by.message.addresses":"Flow cannot be deleted due to being used by one or more message addresses.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.cannot.delete.used.in.recording.policies":"Flow cannot be deleted due to being used by one or more recording policies.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts.","architect.flow.cannot.delete.used.in.emergency.groups":"Flow cannot be deleted due to being used by one or more emergency groups."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlow"}},"/api/v2/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowVersion","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersion"}},"/api/v2/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowVersionConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionConfiguration"}},"/api/v2/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Include Deleted flows","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.data.missing":"Flow version data content is missing.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.version.validate.failed.configuration.version":"Flow version object configuration version is missing or invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.flow.serialize.failed":"Could not serialize flow data.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowVersions"}},"/api/v2/flows/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow information objects filterable by query parameters.","description":"This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsDivisionviews","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","inqueueemail","inqueueshortmessage","speech","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flow:search"]},"x-purecloud-method-name":"getFlowsDivisionviews"}},"/api/v2/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","inqueueemail","inqueueshortmessage","speech","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"lockedByClientId","in":"query","description":"Locked by client ID","required":false,"type":"string"},{"name":"secure","in":"query","description":"Secure","required":false,"type":"string","enum":["any","checkedin","published"]},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}},{"name":"language","in":"query","description":"Language","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.cannot.create.unsupported.language.provided":"Failed to create flow. An unsupported language was specified.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.cannot.create.invalid.language.provided":"Failed to create flow. An invalid language was specified.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.system.flow.cannot.create":"Users cannot create system flows.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey flow.","architect.flow.cannot.create.not.user.creatable":"Failed to create flow. New instances of this flow type cannot be created."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.exceeded.max.amount":"Flow cannot be created because the maximum total number of flows has been reached.","architect.flow.cannot.create.type.max.exceeded":"Flow cannot be created because the maximum number of flows allowed for that type has been reached.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:add"]},"x-purecloud-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one flow could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlows"}},"/api/v2/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified IVR Config was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvr"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the IVR Config were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:edit"]},"x-purecloud-method-name":"putArchitectIvr"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Could not find the IVR config supplied","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Conflict occurred while deleting an IVR Config."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:delete"]},"x-purecloud-method-name":"deleteArchitectIvr"}},"/api/v2/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getArchitectIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"},{"name":"dnis","in":"query","description":"The phone number of the IVR to filter by.","required":false,"type":"string"},{"name":"scheduleGroup","in":"query","description":"The Schedule Group of the IVR to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postArchitectIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:add"]},"x-purecloud-method-name":"postArchitectIvrs"}},"/api/v2/architect/ivrs/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic ivr configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectIvrsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the IVR to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVRDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:search"]},"x-purecloud-method-name":"getArchitectIvrsDivisionviews"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find resource with specified prompt.","not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResource"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPromptResource"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deleteArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResource"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio":{"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource audio","description":"","operationId":"deleteArchitectPromptResourceAudio","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Audio successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.audio.cannot.delete":"Failed to delete the audio for the resource.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResourceAudio"}},"/api/v2/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query parameters can be used for filtering.","operationId":"getArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource","description":"","operationId":"postArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAssetCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.prompt.resource.already.exists":"Prompt already has a resource with specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"postArchitectPromptResources"}},"/api/v2/architect/prompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate prompt history","description":"Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"postArchitectPromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"postArchitectPromptHistory"}},"/api/v2/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompt"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPrompt"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deleteArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"allResources","in":"query","description":"Whether or not to delete all the prompt resources","required":false,"type":"boolean"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.cannot.delete.used.in.queues":"Prompt cannot be deleted due to being used by one or more queue configuration(s).","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.prompt.has.resources":"Cannot delete prompt since it contains prompt resources."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompt"}},"/api/v2/architect/prompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectPromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptHistoryHistoryId"}},"/api/v2/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getArchitectPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unspecified error has occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postArchitectPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists.","architect.user.prompt.create.failed":"Failed to create user prompt.","architect.user.prompt.exceeded.max.amount":"Failed to create user prompt since maximum amount of user prompts has been reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:add"]},"x-purecloud-method-name":"postArchitectPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"deleteArchitectPrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one prompt could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompts"}},"/api/v2/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroup"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the schedule group were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:edit"]},"x-purecloud-method-name":"putArchitectSchedulegroup"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule group could not be completed because it is assigned to one or more IVRs or Sites."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:delete"]},"x-purecloud-method-name":"deleteArchitectSchedulegroup"}},"/api/v2/architect/schedulegroups/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic schedule group configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectSchedulegroupsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the schedule group to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the schedule group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:search"]},"x-purecloud-method-name":"getArchitectSchedulegroupsDivisionviews"}},"/api/v2/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getArchitectSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule Group to filter by.","required":false,"type":"string"},{"name":"scheduleIds","in":"query","description":"A comma-delimited list of Schedule IDs to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postArchitectSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:add"]},"x-purecloud-method-name":"postArchitectSchedulegroups"}},"/api/v2/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedule"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the schedule were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:edit"]},"x-purecloud-method-name":"putArchitectSchedule"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested schedule could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule could not be completed because it is assigned to one or more schedule groups."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:delete"]},"x-purecloud-method-name":"deleteArchitectSchedule"}},"/api/v2/architect/schedules/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic schedule configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectSchedulesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the schedule group to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the schedule group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:search"]},"x-purecloud-method-name":"getArchitectSchedulesDivisionviews"}},"/api/v2/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getArchitectSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postArchitectSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:add"]},"x-purecloud-method-name":"postArchitectSchedules"}},"/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.not.found":"Could not find resource with specified language in specified system prompt.","architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResource"},"put":{"tags":["Architect"],"summary":"Updates a system prompt resource override.","description":"","operationId":"putArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.override.not.found":"Could not find resource override with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"putArchitectSystempromptResource"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.cannot.delete.default":"Cannot delete the default resource for the specified language as that would leave that language without a default resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectSystempromptResource"}},"/api/v2/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get system prompt resources.","description":"","operationId":"getArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","architect.system.prompt.resource.lang.missing":"A language was not specified in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.system.prompt.resource.cannot.create.non.default":"Cannot create a non-default resource for the specified language because a default resource for that language doesn't exist. A default must be created first.","architect.system.prompt.resource.override.already.exists":"The specified system prompt already has an override for the specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"postArchitectSystempromptResources"}},"/api/v2/architect/systemprompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate system prompt history","description":"Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}","operationId":"postArchitectSystempromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"postArchitectSystempromptHistory"}},"/api/v2/architect/systemprompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectSystempromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptHistoryHistoryId"}},"/api/v2/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get a system prompt","description":"","operationId":"getArchitectSystemprompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompt"}},"/api/v2/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts","description":"","operationId":"getArchitectSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompts.max.page.size.exceeded":"A page size greater than the maximum (250) has been requested.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompts"}},"/api/v2/architect/dependencytracking/updatedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that depend on updated resources","description":"","operationId":"getArchitectDependencytrackingUpdatedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingUpdatedresourceconsumers"}},"/api/v2/webchat/deployments/{deploymentId}":{"get":{"tags":["WebChat"],"summary":"Get a WebChat deployment","description":"","operationId":"getWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployment"},"put":{"tags":["WebChat"],"summary":"Update a WebChat deployment","description":"","operationId":"putWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatDeployment"},"delete":{"tags":["WebChat"],"summary":"Delete a WebChat deployment","description":"","operationId":"deleteWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatDeployment"}},"/api/v2/webchat/deployments":{"get":{"tags":["WebChat"],"summary":"List WebChat deployments","description":"","operationId":"getWebchatDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployments"},"post":{"tags":["WebChat"],"summary":"Create WebChat deployment","description":"","operationId":"postWebchatDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Too many deployments being handled","maximum.deployments.exceeded":"No more than 25 deployments allowed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:create"]},"x-purecloud-method-name":"postWebchatDeployments"}},"/api/v2/webchat/settings":{"get":{"tags":["WebChat"],"summary":"Get WebChat deployment settings","description":"","operationId":"getWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatSettings"},"put":{"tags":["WebChat"],"summary":"Update WebChat deployment settings","description":"","operationId":"putWebchatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webChatSettings","required":true,"schema":{"$ref":"#/definitions/WebChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatSettings"},"delete":{"tags":["WebChat"],"summary":"Remove WebChat deployment settings","description":"","operationId":"deleteWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatSettings"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}":{"get":{"tags":["WebChat"],"summary":"Get a media request in the conversation","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"deprecated":true,"x-purecloud-method-name":"getWebchatGuestConversationMediarequest"},"patch":{"tags":["WebChat"],"summary":"Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"},{"in":"body","name":"body","description":"Request","required":true,"schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"deprecated":true,"x-purecloud-method-name":"patchWebchatGuestConversationMediarequest"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests":{"get":{"tags":["WebChat"],"summary":"Get all media requests to the guest in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequests","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequestEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequests"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation member","description":"","operationId":"getWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation member was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMember"},"delete":{"tags":["WebChat"],"summary":"Remove a member from a chat conversation","description":"","operationId":"deleteWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","chat.error.member.state":"The conversation member is in a state which does not permit this action."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"deleteWebchatGuestConversationMember"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages":{"post":{"tags":["WebChat"],"summary":"Send a message in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"The request body may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Error occurred due to invalid request.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation messages operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberMessages"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing":{"post":{"tags":["WebChat"],"summary":"Send a typing-indicator in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.internal":"Internal chat error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation typing operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberTyping"}},"/api/v2/webchat/guest/conversations/{conversationId}/members":{"get":{"tags":["WebChat"],"summary":"Get the members of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMembers","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The number of entries to return per page, or omitted for the default.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number to return, or omitted for the first page.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeDisconnectedMembers","in":"query","description":"If true, the results will not contain members who have a DISCONNECTED state.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfoEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMembers"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation message","description":"","operationId":"getWebchatGuestConversationMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation message was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessage"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages":{"get":{"tags":["WebChat"],"summary":"Get the messages of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If available, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If available, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessages"}},"/api/v2/webdeployments/configurations/{configurationId}":{"delete":{"tags":["Web Deployments"],"summary":"Delete all versions of a configuration","description":"","operationId":"deleteWebdeploymentsConfiguration","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"204":{"description":"The configuration versions were deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","illegal.operation":"Unable to perform the requested operation"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.conflict":"Resource is used by another"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:delete"]},"x-purecloud-method-name":"deleteWebdeploymentsConfiguration"}},"/api/v2/webdeployments/configurations":{"get":{"tags":["Web Deployments"],"summary":"View configuration drafts","description":"","operationId":"getWebdeploymentsConfigurations","produces":["application/json"],"parameters":[{"name":"showOnlyPublished","in":"query","description":"Get only configuration drafts with published versions","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurations"},"post":{"tags":["Web Deployments"],"summary":"Create a configuration draft","description":"","operationId":"postWebdeploymentsConfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"configurationVersion","required":true,"schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"201":{"description":"The configuration version draft was created successfully","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","resource.limit.exceeded":"The maximum number of resources has been exceeded","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:add"]},"x-purecloud-method-name":"postWebdeploymentsConfigurations"}},"/api/v2/webdeployments/configurations/{configurationId}/versions":{"get":{"tags":["Web Deployments"],"summary":"Get the versions of a configuration","description":"This returns the 50 most recent versions for this configuration","operationId":"getWebdeploymentsConfigurationVersions","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersions"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}":{"get":{"tags":["Web Deployments"],"summary":"Get a configuration version","description":"","operationId":"getWebdeploymentsConfigurationVersion","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"The version of the configuration to get","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersion"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/draft":{"get":{"tags":["Web Deployments"],"summary":"Get the configuration draft","description":"","operationId":"getWebdeploymentsConfigurationVersionsDraft","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersionsDraft"},"put":{"tags":["Web Deployments"],"summary":"Update the configuration draft","description":"","operationId":"putWebdeploymentsConfigurationVersionsDraft","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"},{"in":"body","name":"configurationVersion","required":true,"schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:edit"]},"x-purecloud-method-name":"putWebdeploymentsConfigurationVersionsDraft"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish":{"post":{"tags":["Web Deployments"],"summary":"Publish the configuration draft and create a new version","description":"","operationId":"postWebdeploymentsConfigurationVersionsDraftPublish","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:edit","webDeployments:configuration:add"]},"x-purecloud-method-name":"postWebdeploymentsConfigurationVersionsDraftPublish"}},"/api/v2/webdeployments/deployments/{deploymentId}":{"get":{"tags":["Web Deployments"],"summary":"Get a deployment","description":"","operationId":"getWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected. ","required":false,"type":"array","items":{"type":"string","enum":["supportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:view"]},"x-purecloud-method-name":"getWebdeploymentsDeployment"},"put":{"tags":["Web Deployments"],"summary":"Update a deployment","description":"","operationId":"putWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"in":"body","name":"deployment","required":true,"schema":{"$ref":"#/definitions/WebDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","bad.flow.id":"The flow is not eligible for use here.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scp.id.not.found":"The Supported Content Profile ID is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:edit"]},"x-purecloud-method-name":"putWebdeploymentsDeployment"},"delete":{"tags":["Web Deployments"],"summary":"Delete a deployment","description":"","operationId":"deleteWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"}],"responses":{"204":{"description":"The deployment was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","illegal.operation":"Unable to perform the requested operation"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:delete"]},"x-purecloud-method-name":"deleteWebdeploymentsDeployment"}},"/api/v2/webdeployments/deployments/{deploymentId}/configurations":{"get":{"tags":["Web Deployments"],"summary":"Get active configuration for a given deployment","description":"","operationId":"getWebdeploymentsDeploymentConfigurations","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Get active configuration on a deployment","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value","required":false,"type":"array","items":{"type":"string","enum":["supportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentActiveConfigurationOnDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-purecloud-method-name":"getWebdeploymentsDeploymentConfigurations"}},"/api/v2/webdeployments/token/revoke":{"delete":{"tags":["Web Deployments"],"summary":"Invalidate JWT","description":"","operationId":"deleteWebdeploymentsTokenRevoke","produces":["application/json"],"parameters":[{"name":"X-Journey-Session-Id","in":"header","description":"The Customer's journey sessionId.","required":false,"type":"string"},{"name":"X-Journey-Session-Type","in":"header","description":"The Customer's journey session type.","required":false,"type":"string"}],"responses":{"204":{"description":"Revoke any tokens associate with the JWT. \nIf the JWT is expired the refresh endpoint should be called to obtain a valid JWT and this endpoint called again."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The credentials have expired.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","parameters.missing":"The parameters were missing."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Webmessaging JWT":[]}],"x-purecloud-method-name":"deleteWebdeploymentsTokenRevoke"}},"/api/v2/webdeployments/deployments":{"get":{"tags":["Web Deployments"],"summary":"Get deployments","description":"","operationId":"getWebdeploymentsDeployments","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["Configuration","SupportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExpandableWebDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:view"]},"x-purecloud-method-name":"getWebdeploymentsDeployments"},"post":{"tags":["Web Deployments"],"summary":"Create a deployment","description":"","operationId":"postWebdeploymentsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"deployment","required":true,"schema":{"$ref":"#/definitions/WebDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"201":{"description":"The deployment was created successfully","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","resource.limit.exceeded":"The maximum number of resources has been exceeded","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","bad.flow.id":"The flow is not eligible for use here.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scp.id.not.found":"The Supported Content Profile ID is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:add"]},"x-purecloud-method-name":"postWebdeploymentsDeployments"}},"/api/v2/webmessaging/messages":{"get":{"tags":["WebMessaging"],"summary":"Get the messages for a web messaging session.","description":"","operationId":"getWebmessagingMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebMessagingMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.expired":"The session has expired.","session.not.found":"Session was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Webmessaging JWT":[]}],"x-purecloud-method-name":"getWebmessagingMessages"}},"/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an annotation.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).","operationId":"getCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"200":{"description":"Annotation retrieved","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotation"},"delete":{"tags":["Coaching"],"summary":"Delete an existing annotation","description":"You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment","operationId":"deleteCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"204":{"description":"Annotation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation delete permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:delete","coaching:privateAnnotation:delete"]},"x-purecloud-method-name":"deleteCoachingAppointmentAnnotation"},"patch":{"tags":["Coaching"],"summary":"Update an existing annotation.","description":"You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the annotation","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation edit permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:edit","coaching:privateAnnotation:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentAnnotation"}},"/api/v2/coaching/appointments/{appointmentId}/annotations":{"get":{"tags":["Coaching"],"summary":"Get a list of annotations.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).","operationId":"getCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Annotations retrieved","schema":{"$ref":"#/definitions/CoachingAnnotationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotations"},"post":{"tags":["Coaching"],"summary":"Create a new annotation.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).","operationId":"postCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The annotation to add","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotationCreateRequest"}}],"responses":{"201":{"description":"Annotation created","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation add permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:add","coaching:privateAnnotation:add"]},"x-purecloud-method-name":"postCoachingAppointmentAnnotations"}},"/api/v2/coaching/appointments/{appointmentId}/conversations":{"post":{"tags":["Coaching"],"summary":"Add a conversation to an appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"postCoachingAppointmentConversations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddConversationRequest"}}],"responses":{"200":{"description":"Conversation Added","schema":{"$ref":"#/definitions/AddConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the permissions and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit","coaching:appointmentConversation:add"]},"x-purecloud-method-name":"postCoachingAppointmentConversations"}},"/api/v2/coaching/appointments/{appointmentId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an appointment","description":"Permission not required if you are the attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"200":{"description":"Retrieved appointment","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointment"},"delete":{"tags":["Coaching"],"summary":"Delete an existing appointment","description":"Permission not required if you are the creator of the appointment","operationId":"deleteCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"202":{"description":"Appointment delete request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"204":{"description":"Appointment deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User missing permissions: Not an appointment participant.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment delete permission and is not a creator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"There was a conflict deleting the appointment."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:delete"]},"x-purecloud-method-name":"deleteCoachingAppointment"},"patch":{"tags":["Coaching"],"summary":"Update an existing appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the appointment","required":true,"schema":{"$ref":"#/definitions/UpdateCoachingAppointmentRequest"}}],"responses":{"200":{"description":"Appointment updated","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment update request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","not.wfm.appointment":"Appointment was created without WFM schedule data; schedule cannot be added.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment edit permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another","appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit"]},"x-purecloud-method-name":"patchCoachingAppointment"}},"/api/v2/coaching/appointments/{appointmentId}/statuses":{"get":{"tags":["Coaching"],"summary":"Get the list of status changes for a coaching appointment.","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointmentStatuses","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Retrieved appointment statuses","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User does not have the appointment status: is not a participant","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:view"]},"x-purecloud-method-name":"getCoachingAppointmentStatuses"}},"/api/v2/coaching/appointments/{appointmentId}/status":{"patch":{"tags":["Coaching"],"summary":"Update the status of a coaching appointment","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"patchCoachingAppointmentStatus","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated status of the coaching appointment","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentStatusRequest"}}],"responses":{"200":{"description":"The status is posted successfully","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"Failed to validate the appointment status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User is not an appointment participant.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status edit permission and is not an attendee, creator or facilitator of the appointment","agent.cannot.change.status":"Agent cannot change the status of a facilitated appointment.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentStatus"}},"/api/v2/coaching/appointments/aggregates/query":{"post":{"tags":["Coaching"],"summary":"Retrieve aggregated appointment data","description":"","operationId":"postCoachingAppointmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentAggregateRequest"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/CoachingAppointmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"aggregate.too.many.users":"Too many users were included in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","aggregate.query.filter.missing.or.invalid":"The query must contain a filter with at least one clause and predicate","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"There was a problem with the request, see the message for details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"postCoachingAppointmentsAggregatesQuery"}},"/api/v2/coaching/appointments":{"get":{"tags":["Coaching"],"summary":"Get appointments for users and optional date range","description":"","operationId":"getCoachingAppointments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The user IDs for which to retrieve appointments","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"},{"name":"completionInterval","in":"query","description":"Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"]},{"name":"intervalCondition","in":"query","description":"Filter condition for interval","required":false,"type":"string","enum":["StartsIn","Overlaps"]}],"responses":{"200":{"description":"Get users coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"interval.query.param":"Start date of the interval cannot be greater than the end date","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","users.query.param":"User list cannot be empty or greater than 100 when querying for appointments","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","no.appointment.view.permission":"No permission to view appointments","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointments"},"post":{"tags":["Coaching"],"summary":"Create a new appointment","description":"","operationId":"postCoachingAppointments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The appointment to add","required":true,"schema":{"$ref":"#/definitions/CreateCoachingAppointmentRequest"}}],"responses":{"201":{"description":"Appointment created","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment create request accepted","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","validation.error":"Error validating the appointment.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:add"]},"x-purecloud-method-name":"postCoachingAppointments"}},"/api/v2/coaching/notifications/{notificationId}":{"get":{"tags":["Coaching"],"summary":"Get an existing notification","description":"Permission not required if you are the owner of the notification.","operationId":"getCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:notification:view"]},"x-purecloud-method-name":"getCoachingNotification"},"patch":{"tags":["Coaching"],"summary":"Update an existing notification.","description":"Can only update your own notifications.","operationId":"patchCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"in":"body","name":"body","description":"Change the read state of a notification","required":true,"schema":{"$ref":"#/definitions/CoachingNotification"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"The requested notification does not belong to this user.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-purecloud-method-name":"patchCoachingNotification"}},"/api/v2/coaching/notifications":{"get":{"tags":["Coaching"],"summary":"Retrieve the list of your notifications.","description":"","operationId":"getCoachingNotifications","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotificationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","pagination.bad.request":"The page size or page number could not be parsed."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingNotifications"}},"/api/v2/coaching/scheduleslots/query":{"post":{"tags":["Coaching"],"summary":"Get list of possible slots where a coaching appointment can be scheduled.","description":"","operationId":"postCoachingScheduleslotsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The slot search request","required":true,"schema":{"$ref":"#/definitions/CoachingSlotsRequest"}}],"responses":{"200":{"description":"Coaching slots retrieved","schema":{"$ref":"#/definitions/CoachingSlotsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","attendee.not.in.business.unit":"The attendee to be scheduled was not in a business unit, but a WFM schedule was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","users.in.different.business.units":"Users to be scheduled were in different business units","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:scheduleSlot:view"]},"x-purecloud-method-name":"postCoachingScheduleslotsQuery"}},"/api/v2/coaching/appointments/me":{"get":{"tags":["Coaching"],"summary":"Get my appointments for a given date range","description":"","operationId":"getCoachingAppointmentsMe","produces":["application/json"],"parameters":[{"name":"interval","in":"query","description":"Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"},{"name":"completionInterval","in":"query","description":"Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"]},{"name":"intervalCondition","in":"query","description":"Filter condition for interval","required":false,"type":"string","enum":["StartsIn","Overlaps"]}],"responses":{"200":{"description":"Get my coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingAppointmentsMe"}},"/api/v2/users/development/activities/{activityId}":{"get":{"tags":["Users"],"summary":"Get a Development Activity","description":"Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.","operationId":"getUsersDevelopmentActivity","produces":["application/json"],"parameters":[{"name":"activityId","in":"path","description":"Specifies the activity ID, maps to either assignment or appointment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Specifies the activity type.","required":true,"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivity"}},"/api/v2/users/development/activities":{"get":{"tags":["Users"],"summary":"Get list of Development Activities","description":"Either moduleId or userId is required. Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivities","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment"]},"collectionFormat":"multi"},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"collectionFormat":"multi"},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivities"}},"/api/v2/users/development/activities/me":{"get":{"tags":["Users"],"summary":"Get list of Development Activities for current user","description":"Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivitiesMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment"]},"collectionFormat":"multi"},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"collectionFormat":"multi"},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-purecloud-method-name":"getUsersDevelopmentActivitiesMe"}},"/api/v2/users/development/activities/aggregates/query":{"post":{"tags":["Users"],"summary":"Retrieve aggregated development activity data","description":"Results are filtered based on the applicable permissions.","operationId":"postUsersDevelopmentActivitiesAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/DevelopmentActivityAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/DevelopmentActivityAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval parameter cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","development.aggregate.no.permission":"Invalid User Operation. User does not have permission to get development data","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.type.not.implemented.exception":"Predicate is not implemented"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"postUsersDevelopmentActivitiesAggregatesQuery"}},"/api/v2/learning/assessments/scoring":{"post":{"tags":["Learning"],"summary":"Score learning assessment for preview","description":"","operationId":"postLearningAssessmentsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Assessment form and answers to score","required":true,"schema":{"$ref":"#/definitions/LearningAssessmentScoringRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.answer.not.in.assessment.form":"Submitted answers contained reference to an answer which is not in the assessment form","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.text.answer.too.long":"Submitted answers contained a free text answer that was too long.","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.answer.not.provided":"A submitted answer was empty","quality.scoring.na.disabled.marked.na":"A question or question group was marked as NA when it is not NA enabled.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.scoring.question.not.in.assessment.form":"Submitted answers contained reference to a question which is not in the assessment form","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Request is badly formed.","quality.scoring.question.group.not.in.assessment.form":"Submitted answers contained reference to a question group which is not in the assessment form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view","learning:module:add","learning:module:edit"]},"x-purecloud-method-name":"postLearningAssessmentsScoring"}},"/api/v2/learning/assignments/aggregates/query":{"post":{"tags":["Learning"],"summary":"Retrieve aggregated assignment data","description":"","operationId":"postLearningAssignmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/LearningAssignmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval parameter cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.type.not.implemented.exception":"Predicate is not implemented"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"postLearningAssignmentsAggregatesQuery"}},"/api/v2/learning/assignments/{assignmentId}":{"get":{"tags":["Learning"],"summary":"Get Learning Assignment","description":"Permission not required if you are the assigned user of the learning assignment","operationId":"getLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response","required":false,"type":"array","items":{"type":"string","enum":["module","assessment","assessmentForm","module.coverArt","step","step.moduleStep"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","wem.learning.assignment.division.forbidden.action":"The operation failed as the action is forbidden","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","wem.learning.assignment.forbidden":"The operation failed as the action is forbidden","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"getLearningAssignment"},"delete":{"tags":["Learning"],"summary":"Delete a learning assignment","description":"","operationId":"deleteLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"204":{"description":"The learning assignment was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","lm.no.permission.delete.assignment":"The operation failed because the user does not have the right permissions","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.conflict.exception":"The assignment was assigned by a rule and cannot be deleted.","wem.learning.assignment.state.conflict.exception":"The assignment is in a state where it cannot be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:delete"]},"x-purecloud-method-name":"deleteLearningAssignment"},"patch":{"tags":["Learning"],"summary":"Update Learning Assignment","description":"","operationId":"patchLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"in":"body","name":"body","description":"The Learning Assignment to be updated","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.answer.not.in.assessment.form":"Submitted answers contained reference to an answer which is not in the assessment form","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.text.answer.too.long":"Submitted answers contained a free text answer that was too long.","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.answer.not.provided":"A submitted answer was empty","quality.scoring.na.disabled.marked.na":"A question or question group was marked as NA when it is not NA enabled.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.scoring.question.not.in.assessment.form":"Submitted answers contained reference to a question which is not in the assessment form","constraint.validation":"%s","wem.learning.input.validation.error":"There was an error parsing argument","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.scoring.question.group.not.in.assessment.form":"Submitted answers contained reference to a question group which is not in the assessment form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","lm.update.state.error":"Cannot update an assignment belonging to another user.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"The operation failed as the state to be updated conflicts","wem.learning.module.type.exception":"The operation failed as it conflicts with the module type"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-purecloud-method-name":"patchLearningAssignment"}},"/api/v2/learning/assignments":{"get":{"tags":["Learning"],"summary":"List of Learning module Assignments","description":"Either moduleId or user value is required","operationId":"getLearningAssignments","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module. Fetch assignments for learning module ID","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"minPercentageScore","in":"query","description":"The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"maxPercentageScore","in":"query","description":"The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"sortBy","in":"query","description":"Specifies which field to sort the results by, default sort is by recommendedCompletionDate","required":false,"type":"string","enum":["RecommendedCompletionDate","DateModified"]},{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"types","in":"query","description":"Specifies the module types to filter by","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"states","in":"query","description":"Specifies the assignment states to filter by","required":false,"type":"array","items":{"type":"string","enum":["Assigned","InProgress","Completed","NotCompleted","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Specifies the expand option for returning additional information","required":false,"type":"array","items":{"type":"string","enum":["ModuleSummary"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentsDomainEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"getLearningAssignments"},"post":{"tags":["Learning"],"summary":"Create Learning Assignment","description":"","operationId":"postLearningAssignments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Learning Assignment to be created","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","lm.no.permission.create.assignment":"The operation failed because the user does not have the right permissions"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.conflict.exception":"The operation failed as the assignment conflicts with the existing assignment","wem.learning.assignment.state.conflict.exception":"A rule-based assignment already exists in a state that prevents this action.","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignments"}},"/api/v2/learning/assignments/{assignmentId}/reschedule":{"patch":{"tags":["Learning"],"summary":"Reschedule Learning Assignment","description":"","operationId":"patchLearningAssignmentReschedule","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"in":"body","name":"body","description":"The Learning assignment reschedule model","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentReschedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","lm.reschedule.state.error":"Cannot reschedule an assignment belonging to another user.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"The assignment is in a state where it cannot be rescheduled.","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:reschedule"]},"x-purecloud-method-name":"patchLearningAssignmentReschedule"}},"/api/v2/learning/assignments/me":{"get":{"tags":["Learning"],"summary":"List of Learning Assignments assigned to current user","description":"","operationId":"getLearningAssignmentsMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module. Fetch assignments for learning module ID","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"minPercentageScore","in":"query","description":"The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"maxPercentageScore","in":"query","description":"The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"sortBy","in":"query","description":"Specifies which field to sort the results by, default sort is by recommendedCompletionDate","required":false,"type":"string","enum":["RecommendedCompletionDate","DateModified"]},{"name":"types","in":"query","description":"Specifies the module types to filter by","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"states","in":"query","description":"Specifies the assignment states to filter by","required":false,"type":"array","items":{"type":"string","enum":["Assigned","InProgress","Completed","NotCompleted","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Specifies the expand option for returning additional information","required":false,"type":"array","items":{"type":"string","enum":["ModuleSummary"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentsDomainEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-purecloud-method-name":"getLearningAssignmentsMe"}},"/api/v2/learning/assignments/{assignmentId}/reset":{"post":{"tags":["Learning"],"summary":"Reset Learning Assignment","description":"This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment","operationId":"postLearningAssignmentReset","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"200":{"description":"Reset version of assignment which can be taken again","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"lm.no.permission.reset.assignment":"The operation failed because the user does not have the right permissions","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:reset"]},"x-purecloud-method-name":"postLearningAssignmentReset"}},"/api/v2/learning/assignments/{assignmentId}/reassign":{"post":{"tags":["Learning"],"summary":"Reassign Learning Assignment","description":"This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module","operationId":"postLearningAssignmentReassign","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"200":{"description":"Reassigned version of assignment which can be taken again","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignmentReassign"}},"/api/v2/learning/assignments/bulkadd":{"post":{"tags":["Learning"],"summary":"Add multiple learning assignments","description":"","operationId":"postLearningAssignmentsBulkadd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The learning assignments to be created","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/LearningAssignmentItem"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentBulkAddResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"None of the provided learning modules were found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignmentsBulkadd"}},"/api/v2/learning/assignments/bulkremove":{"post":{"tags":["Learning"],"summary":"Remove multiple Learning Assignments","description":"","operationId":"postLearningAssignmentsBulkremove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The IDs of the learning assignments to be removed","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentBulkRemoveResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:delete"]},"x-purecloud-method-name":"postLearningAssignmentsBulkremove"}},"/api/v2/learning/rules/query":{"post":{"tags":["Learning"],"summary":"Get users for learning module rule","description":"This will get the users who matches the given rule.","operationId":"postLearningRulesQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":true,"type":"integer","default":50,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":true,"type":"integer","default":1,"format":"int32"},{"in":"body","name":"body","description":"The learning module rule to fetch users","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentUserQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentUserListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when retrieving users","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.rule.part.exceeded":"There are too many values in rule parts","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:view"]},"x-purecloud-method-name":"postLearningRulesQuery"}},"/api/v2/learning/modules/{moduleId}":{"get":{"tags":["Learning"],"summary":"Get a learning module","description":"","operationId":"getLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["assessmentForm","coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModule"},"put":{"tags":["Learning"],"summary":"Update a learning module","description":"This will update the name, description, completion time in days and inform steps for a learning module","operationId":"putLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module to be updated","required":true,"schema":{"$ref":"#/definitions/LearningModuleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error in the input argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when updating learning module","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot update Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:edit"]},"x-purecloud-method-name":"putLearningModule"},"delete":{"tags":["Learning"],"summary":"Delete a learning module","description":"This will delete a learning module if it is unpublished or it will delete a published and archived learning module","operationId":"deleteLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"}],"responses":{"204":{"description":"The learning module was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","wem.learning.server.too.busy":"The operation failed because the service is too busy","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wem.learning.forbidden.action":"The operation failed since the action is forbidden"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"TThe operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:delete"]},"x-purecloud-method-name":"deleteLearningModule"}},"/api/v2/learning/modules/{moduleId}/jobs/{jobId}":{"get":{"tags":["Learning"],"summary":"Get a specific Learning Module job status","description":"","operationId":"getLearningModuleJob","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the learning module job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.bad.request":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.job.not.found":"The operation failed because the specified learning job is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModuleJob"}},"/api/v2/learning/modules/{moduleId}/versions/{versionId}":{"get":{"tags":["Learning"],"summary":"Get specific version of a published module","description":"","operationId":"getLearningModuleVersion","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"versionId","in":"path","description":"The version of learning module","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["assessmentForm","coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModuleVersion"}},"/api/v2/learning/modules/coverart/{coverArtId}":{"get":{"tags":["Learning"],"summary":"Get a specific Learning Module cover art using ID","description":"","operationId":"getLearningModulesCoverartCoverArtId","produces":["application/json"],"parameters":[{"name":"coverArtId","in":"path","description":"Key identifier for the cover art","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleCoverArtResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.cover.art.not.found":"The operation failed because the specified learning module cover art is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:coverart:view"]},"x-purecloud-method-name":"getLearningModulesCoverartCoverArtId"}},"/api/v2/learning/modules":{"get":{"tags":["Learning"],"summary":"Get all learning modules of an organization","description":"","operationId":"getLearningModules","produces":["application/json"],"parameters":[{"name":"isArchived","in":"query","description":"Archive status","required":false,"type":"boolean","default":false},{"name":"types","in":"query","description":"Specifies the module types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","createddate","percentpassed","averagescore"]},{"name":"searchTerm","in":"query","description":"Search Term (searchable by name)","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["rule","summaryData"]},"collectionFormat":"multi"},{"name":"isPublished","in":"query","description":"Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"statuses","in":"query","description":"Specifies the module statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Unpublished","Published","Archived"]},"collectionFormat":"multi"},{"name":"externalIds","in":"query","description":"Specifies the module external IDs to filter by. Only one ID is allowed","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModules"},"post":{"tags":["Learning"],"summary":"Create a new learning module","description":"This will create a new unpublished learning module with the specified fields.","operationId":"postLearningModules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The learning module to be created","required":true,"schema":{"$ref":"#/definitions/LearningModuleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.too.many.modules":"The max number of modules per organization has been reached","wem.learning.private.api.http.exception":"There was an error when creating learning module","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot create Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:add"]},"x-purecloud-method-name":"postLearningModules"}},"/api/v2/learning/modules/{moduleId}/publish":{"post":{"tags":["Learning"],"summary":"Publish a Learning module","description":"","operationId":"postLearningModulePublish","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":false,"schema":{"$ref":"#/definitions/LearningModulePublishRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulePublishResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","wem.learning.input.validation.error":"There was an error parsing argument","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when publishing learning module","wem.learning.informsteps.empty.error":"Cannot publish Learning Module as no inform steps provided","wem.learning.bad.request":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot publish Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:publish"]},"x-purecloud-method-name":"postLearningModulePublish"}},"/api/v2/learning/modules/{moduleId}/jobs":{"post":{"tags":["Learning"],"summary":"Starts a specified operation on learning module","description":"This will initiate operation specified in the request body for a learning module","operationId":"postLearningModuleJobs","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module job request","required":true,"schema":{"$ref":"#/definitions/LearningModuleJobRequest"}}],"responses":{"202":{"description":"Start a specific Learning Module job","schema":{"$ref":"#/definitions/LearningModuleJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.bad.request":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.job.already.exists":"The operation failed since a job already exists for the module","wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:add"]},"x-purecloud-method-name":"postLearningModuleJobs"}},"/api/v2/learning/modules/assignments":{"get":{"tags":["Learning"],"summary":"Get all learning modules of an organization including assignments for a specific user","description":"","operationId":"getLearningModulesAssignments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The IDs of the users to include","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"searchTerm","in":"query","description":"Search Term (searches by name and description)","required":false,"type":"string"},{"name":"overdue","in":"query","description":"Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned.","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"assignmentStates","in":"query","description":"Specifies the assignment states to return.","required":false,"type":"array","items":{"type":"string","enum":["NotAssigned","Assigned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedLearningModuleDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","no.user.ids.specified":"You must specify at least one userId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:module:view","learning:assignment:view"]},"x-purecloud-method-name":"getLearningModulesAssignments"}},"/api/v2/learning/modules/{moduleId}/users/{userId}/assignments":{"patch":{"tags":["Learning"],"summary":"Update an external assignment for a specific user","description":"","operationId":"patchLearningModuleUserAssignments","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"Key identifier for the module","required":true,"type":"string"},{"name":"userId","in":"path","description":"Key identifier for the user","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning request for updating the assignment","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentExternalUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"A rule-based assignment already exists in a state that prevents this action.","wem.learning.module.type.exception":"Cannot perform update on assignment with module of type External"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:externalAssignment:edit"]},"x-purecloud-method-name":"patchLearningModuleUserAssignments"}},"/api/v2/learning/modules/{moduleId}/rule":{"get":{"tags":["Learning"],"summary":"Get a learning module rule","description":"","operationId":"getLearningModuleRule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since corresponding learning module was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:view"]},"x-purecloud-method-name":"getLearningModuleRule"},"put":{"tags":["Learning"],"summary":"Update a learning module rule","description":"This will update a learning module rule with the specified fields.","operationId":"putLearningModuleRule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module rule to be updated","required":true,"schema":{"$ref":"#/definitions/LearningModuleRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since corresponding learning module was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:edit"]},"x-purecloud-method-name":"putLearningModuleRule"}},"/api/v2/learning/scheduleslots/query":{"post":{"tags":["Learning"],"summary":"Get list of possible slots where a learning activity can be scheduled.","description":"","operationId":"postLearningScheduleslotsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The slot search request","required":true,"schema":{"$ref":"#/definitions/LearningScheduleSlotsQueryRequest"}}],"responses":{"200":{"description":"Learning slots retrieved","schema":{"$ref":"#/definitions/LearningScheduleSlotsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wem.learning.forbidden.action":"There was an error as the action was forbidden","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.schedule.conflict.exception":"The operation failed because of a conflict"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:scheduleSlot:view"]},"x-purecloud-method-name":"postLearningScheduleslotsQuery"}},"/api/v2/widgets/deployments/{deploymentId}":{"get":{"tags":["Widgets"],"summary":"Get a Widget deployment","description":"","operationId":"getWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployment"},"put":{"tags":["Widgets"],"summary":"Update a Widget deployment","description":"","operationId":"putWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:edit","webchat:deployment:update"]},"x-purecloud-method-name":"putWidgetsDeployment"},"delete":{"tags":["Widgets"],"summary":"Delete a Widget deployment","description":"","operationId":"deleteWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:delete","webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWidgetsDeployment"}},"/api/v2/widgets/deployments":{"get":{"tags":["Widgets"],"summary":"List Widget deployments","description":"","operationId":"getWidgetsDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployments"},"post":{"tags":["Widgets"],"summary":"Create Widget deployment","description":"","operationId":"postWidgetsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Conflict caused by too many deployments","maximum.deployments.exceeded":"No more than 10 deployments allowed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:add","webchat:deployment:create"]},"x-purecloud-method-name":"postWidgetsDeployments"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes","description":"","operationId":"getWorkforcemanagementManagementunitActivitycodes","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityCodeContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitActivitycodes"}},"/api/v2/workforcemanagement/timeoffrequests/estimate":{"post":{"tags":["Workforce Management"],"summary":"Estimates available time off for current user","description":"","operationId":"postWorkforcemanagementTimeoffrequestsEstimate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/EstimateAvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimateAvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequestsEstimate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCodeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycodes"},"post":{"tags":["Workforce Management"],"summary":"Create a new activity code","description":"","operationId":"postWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.primary.secondary.presences":"The request contains one or more primary secondary presences","wfm.too.many.secondary.presences":"The request contains too many secondary presences","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more secondary presence IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.secondary.presences.inactive.or.not.found":"One or more secondary presences are inactive or do not exist","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivitycodes"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity code","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycode"},"delete":{"tags":["Workforce Management"],"summary":"Deletes an activity code","description":"","operationId":"deleteWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The activity code was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitActivitycode"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity code","description":"","operationId":"patchWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","wfm.ids.may.not.be.blank":"One or more secondary presence IDs was passed in as a blank value","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.primary.secondary.presences":"The request contains one or more primary secondary presences","wfm.too.many.secondary.presences":"The request contains too many secondary presences","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.secondary.presences.inactive.or.not.found":"One or more secondary presences are inactive or do not exist","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivitycode"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Get intraday planning groups for the given date","description":"","operationId":"getWorkforcemanagementBusinessunitIntradayPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"date","in":"query","description":"yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntradayPlanningGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitIntradayPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday":{"post":{"tags":["Workforce Management"],"summary":"Get intraday data for the given date for the requested planningGroupIds","description":"","operationId":"postWorkforcemanagementBusinessunitIntraday","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/IntradayPlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncIntradayResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitIntraday"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for importing a short term forecast","description":"Once the upload is complete, call the /import route to start the short term forecast import process","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportForecastUploadResponse"}},"201":{"description":"The upload url for import was successfully created","schema":{"$ref":"#/definitions/ImportForecastUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import":{"post":{"tags":["Workforce Management"],"summary":"Starts importing the uploaded short term forecast","description":"Call after uploading the forecast data to the url supplied by the /import/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImport","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportForecastResponse"}},"202":{"description":"The forecast import is processing","schema":{"$ref":"#/definitions/ImportForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImport"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast generation results","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts":{"get":{"tags":["Workforce Management"],"summary":"Get short term forecasts","description":"Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecasts","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecastListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecasts"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/GenerateBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was successfully generated","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}":{"get":{"tags":["Workforce Management"],"summary":"Get a short term forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the forecast","required":false,"type":"array","items":{"type":"string","enum":["planningGroups","generationResults"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecast"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecast"},"delete":{"tags":["Workforce Management"],"summary":"Delete a short term forecast","description":"Must not be tied to any schedules","operationId":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"204":{"description":"The forecast was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast planning group snapshot","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ForecastPlanningGroupsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a short term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastData","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumber","in":"query","description":"The week number to fetch (for multi-week forecasts)","required":false,"type":"integer","format":"int32"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastData"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement":{"get":{"tags":["Workforce Management"],"summary":"Get the staffing requirement by planning group for a forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumbers","in":"query","description":"The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastStaffingRequirementsResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingRequirement:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a long term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LongTermForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast to copy","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/CopyBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was created","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get business unit","description":"Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).","operationId":"getWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the business unit","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.timeZone","settings.startDayOfWeek","settings.shortTermForecasting","settings.scheduling"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","learning","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:staffingGroup:add","wfm:staffingGroup:delete","wfm:staffingGroup:edit","wfm:staffingGroup:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view","coaching:appointment:add","coaching:appointment:edit","learning:assignment:add","learning:assignment:reschedule"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete business unit","description":"A business unit cannot be deleted if it contains one or more management units","operationId":"deleteWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The business unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunit"},"patch":{"tags":["Workforce Management"],"summary":"Update business unit","description":"","operationId":"patchWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunit"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get all authorized management units in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitManagementunits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"feature","in":"query","description":"If specified, the list of management units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of management units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunitManagementunits"}},"/api/v2/workforcemanagement/businessunits":{"get":{"tags":["Workforce Management"],"summary":"Get business units","description":"","operationId":"getWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"name":"feature","in":"query","description":"If specified, the list of business units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of business units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunits"},"post":{"tags":["Workforce Management"],"summary":"Add a new business unit","description":"It may take a minute or two for a new business unit to be available for api operations","operationId":"postWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"201":{"description":"The business unit was successfully created","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunits"}},"/api/v2/workforcemanagement/businessunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get business units across divisions","description":"","operationId":"getWorkforcemanagementBusinessunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return business units in all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitsDivisionviews"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get management unit","description":"settings.shortTermForecasting is deprecated and now lives on the business unit","operationId":"getWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.adherence","settings.timeOff","settings.scheduling","settings.shortTermForecasting","settings.shiftTrading"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:staffingGroup:add","wfm:staffingGroup:delete","wfm:staffingGroup:edit","wfm:staffingGroup:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete management unit","description":"","operationId":"deleteWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The management unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunit"},"patch":{"tags":["Workforce Management"],"summary":"Update the requested management unit","description":"","operationId":"patchWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/move":{"post":{"tags":["Workforce Management"],"summary":"Move the requested management unit to a new business unit","description":"Returns status 200 if the management unit is already in the requested business unit","operationId":"postWorkforcemanagementManagementunitMove","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"202":{"description":"The management unit is being moved","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.validation.business.unit.not.found":"Business unit not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitMove"}},"/api/v2/workforcemanagement/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get management units","description":"","operationId":"getWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"expand","in":"query","description":"Deprecated, expand settings on the single MU route","required":false,"type":"string","enum":["details"]},{"name":"feature","in":"query","description":"If specified, the list of management units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of management units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementManagementunits"},"post":{"tags":["Workforce Management"],"summary":"Add a management unit","description":"It may take a minute or two for a new management unit to be available for api operations","operationId":"postWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateManagementUnitApiRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"201":{"description":"The management unit was successfully created","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.validation.business.unit.not.found":"Business unit not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:managementUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunits"}},"/api/v2/workforcemanagement/managementunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get management units across divisions","description":"","operationId":"getWorkforcemanagementManagementunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitsDivisionviews"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Get data for agent in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitAgent","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"},{"name":"excludeCapabilities","in":"query","description":"Excludes all capabilities of the agent such as queues, languages, and skills","required":false,"type":"boolean"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["workPlanOverrides"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgent"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given agent","description":"","operationId":"getWorkforcemanagementManagementunitAgentShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgentShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents":{"patch":{"tags":["Workforce Management"],"summary":"Update agent configurations","description":"","operationId":"patchWorkforcemanagementManagementunitAgents","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateMuAgentsRequest"}}],"responses":{"204":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested agents was not found in the management unit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitAgents"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users":{"get":{"tags":["Workforce Management"],"summary":"Get users in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:historicalAdherence:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:view","wfm:staffingGroup:view","wfm:timeOffRequest:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUsers"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a planning group","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes the planning group","description":"","operationId":"deleteWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The planning group was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitPlanninggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates the planning group","description":"","operationId":"patchWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more language, skill or queue IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitPlanninggroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets list of planning groups","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroupList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view","wfm:shortTermForecast:view","wfm:intraday:view","wfm:agent:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroups"},"post":{"tags":["Workforce Management"],"summary":"Adds a new planning group","description":"","operationId":"postWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"201":{"description":"The planning group was successfully created","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more language, skill or queue IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}":{"get":{"tags":["Workforce Management"],"summary":"Get a service goal template","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the service goal template","required":false,"type":"array","items":{"type":"string","enum":["impactOverride"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplate"},"delete":{"tags":["Workforce Management"],"summary":"Delete a service goal template","description":"","operationId":"deleteWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of the service goal template to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The service goal template was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitServicegoaltemplate"},"patch":{"tags":["Workforce Management"],"summary":"Updates a service goal template","description":"","operationId":"patchWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitServicegoaltemplate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates":{"get":{"tags":["Workforce Management"],"summary":"Gets list of service goal templates","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the service goal template","required":false,"type":"array","items":{"type":"string","enum":["impactOverride"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplateList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view","wfm:planningGroup:view","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplates"},"post":{"tags":["Workforce Management"],"summary":"Adds a new service goal template","description":"","operationId":"postWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"201":{"description":"The service goal template was successfully created","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitServicegoaltemplates"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users":{"get":{"tags":["Workforce Management"],"summary":"Gets list of users available for whom you can send direct shift trade requests","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesUsers"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched":{"get":{"tags":["Workforce Management"],"summary":"Gets a summary of all shift trades in the matched state","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesMatched","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeMatchesSummaryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesMatched"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of staffing groups","description":"","operationId":"getWorkforcemanagementBusinessunitStaffinggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific staffing groups","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitStaffinggroups"},"post":{"tags":["Workforce Management"],"summary":"Creates a new staffing group","description":"","operationId":"postWorkforcemanagementBusinessunitStaffinggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateStaffingGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"201":{"description":"The staffing group was successfully created","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitStaffinggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a staffing group","description":"","operationId":"getWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitStaffinggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a staffing group","description":"","operationId":"deleteWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The staffing group was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitStaffinggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates a staffing group","description":"","operationId":"patchWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateStaffingGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitStaffinggroup"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time off limit objects under management unit.","description":"Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.","operationId":"getWorkforcemanagementManagementunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view","wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeofflimits"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time off limit object under management unit.","description":"Only one limit object is allowed under management unit, so an attempt to create second object will fail.","operationId":"postWorkforcemanagementManagementunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"201":{"description":"The time off limit was successfully created","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeofflimits"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time off limit object","description":"Returns properties of time off limit object, but not daily values.","operationId":"getWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeofflimit"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time off limit object","description":"","operationId":"deleteWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit object to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time off limit object deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitTimeofflimit"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time off limit object.","description":"Updates time off limit object properties, but not daily values.","operationId":"patchWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The id of time off limit object to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeofflimit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values":{"put":{"tags":["Workforce Management"],"summary":"Sets daily values for a date range of time off limit object","description":"Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API","operationId":"putWorkforcemanagementManagementunitTimeofflimitValues","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit object to set values for","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/SetTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"putWorkforcemanagementManagementunitTimeofflimitValues"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves time off limit related values based on a given set of filters.","description":"","operationId":"postWorkforcemanagementManagementunitTimeofflimitsValuesQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeofflimitsValuesQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time off plans","description":"","operationId":"getWorkforcemanagementManagementunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlanListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeoffplans"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time off plan","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"201":{"description":"The time off plan was successfully created","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time off plan","description":"","operationId":"getWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeoffplan"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time off plan","description":"","operationId":"deleteWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time off plan was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitTimeoffplan"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time off plan","description":"","operationId":"patchWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeoffplan"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate":{"post":{"tags":["Workforce Management"],"summary":"Estimates available time off for an agent","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user for whom the time off request estimate is requested","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/EstimateAvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimateAvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves integration statuses for a list of time off requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffIntegrationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus":{"patch":{"tags":["Workforce Management"],"summary":"Set integration status for a time off request.","description":"","operationId":"patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/SetTimeOffIntegrationStatusRequest"}},{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of user to whom the time off request belongs.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Retrieves time off limit, allocated and waitlisted values according to specific time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the time off request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request, which dates and activityCodeId determine limit values to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:timeOffRequest:view","wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for a given user","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request","description":"","operationId":"patchWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user the requested time off request belongs to","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The id of the time off request to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AdminTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitUserTimeoffrequest"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests":{"post":{"tags":["Workforce Management"],"summary":"Create a new time off request","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAdminTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query":{"post":{"tags":["Workforce Management"],"summary":"Fetches time off requests matching the conditions specified in the request body","description":"Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/TimeOffRequestQueryBody"}},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves daily waitlist position for a list of time off requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryWaitlistPositionsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WaitlistPositionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query":{"post":{"tags":["Workforce Management"],"summary":"Gets staffing group associations for a list of user IDs","description":"","operationId":"postWorkforcemanagementBusinessunitStaffinggroupsQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryUserStaffingGroupListRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStaffingGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitStaffinggroupsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search":{"post":{"tags":["Workforce Management"],"summary":"Searches for potential shift trade matches for the current agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/SearchShiftTradesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SearchShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given week","description":"","operationId":"getWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"evaluateMatches","in":"query","description":"Whether to evaluate the matches for violations","required":false,"type":"boolean","default":true},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekShifttrades"},"post":{"tags":["Workforce Management"],"summary":"Adds a shift trade","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk":{"post":{"tags":["Workforce Management"],"summary":"Updates the state of a batch of shift trades","description":"Admin functionality is not supported with \"mine\".","operationId":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BulkShiftTradeStateUpdateRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"202":{"description":"The shift trades are being updated. Results will come via notification","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}":{"patch":{"tags":["Workforce Management"],"summary":"Updates a shift trade. This route can only be called by the initiating agent","description":"","operationId":"patchWorkforcemanagementManagementunitWeekShifttrade","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/PatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWeekShifttrade"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match":{"post":{"tags":["Workforce Management"],"summary":"Matches a shift trade. This route can only be called by the receiving agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradeMatch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/MatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MatchShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradeMatch"}},"/api/v2/workforcemanagement/agents/{agentId}/managementunit":{"get":{"tags":["Workforce Management"],"summary":"Get the management unit to which the agent belongs","description":"","operationId":"getWorkforcemanagementAgentManagementunit","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to look up","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentManagementUnitReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The requested agent is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","learning","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","coaching:appointment:add","coaching:appointment:edit","learning:assignment:add","learning:assignment:reschedule"]},"x-purecloud-method-name":"getWorkforcemanagementAgentManagementunit"}},"/api/v2/workforcemanagement/agents/me/managementunit":{"get":{"tags":["Workforce Management"],"summary":"Get the management unit to which the currently logged in agent belongs","description":"","operationId":"getWorkforcemanagementAgentsMeManagementunit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentManagementUnitReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The requested agent is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementAgentsMeManagementunit"}},"/api/v2/workforcemanagement/agents":{"post":{"tags":["Workforce Management"],"summary":"Move agents in and out of management unit","description":"","operationId":"postWorkforcemanagementAgents","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveAgentsRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/MoveAgentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more user IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found.","user.ids.not.found":"One of the requested resources in the request body was not found, please check the error details for more information"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"postWorkforcemanagementAgents"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate":{"post":{"tags":["Workforce Management"],"summary":"Validate Work Plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanValidate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanValidationRequest"}},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateWorkPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add","wfm:workPlan:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanValidate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan","description":"","operationId":"getWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to fetch","required":true,"type":"string"},{"name":"includeOnly","in":"query","description":"limit response to the specified fields","required":false,"type":"array","items":{"type":"string","enum":["agentCount","agents","optionalDays","shifts","shiftStartVariances"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view","wfm:workPlan:view","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplan"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplan"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to update work plan even if validation result is invalid","required":false,"type":"string","enum":["Ignore"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplan"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Get work plans","description":"\"expand=details\" is deprecated","operationId":"getWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the work plans","required":false,"type":"array","items":{"type":"string","enum":["agentCount","agents","optionalDays","shifts","shiftStartVariances","details"]},"collectionFormat":"multi"},{"name":"exclude","in":"query","description":"Exclude specific data on the work plans from the response","required":false,"type":"array","items":{"type":"string","enum":["shifts.activities"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplans"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to create work plan even if the validation result is invalid","required":false,"type":"string","enum":["Ignore"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlan"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Name not specified or there is already a work plan with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanCopy"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations":{"get":{"tags":["Workforce Management"],"summary":"Get work plan rotations","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotations"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AddWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"201":{"description":"The work plan rotation was successfully created","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotations"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotationCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Name not specified or there is already a work plan rotation with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotationCopy"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan rotation","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotation"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan rotation","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to be deleted","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan rotation was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplanrotation"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan rotation","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplanrotation"}},"/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an adherence explanation operation. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceExplanationsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementAdherenceExplanationsJob"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}":{"get":{"tags":["Workforce Management"],"summary":"Get an adherence explanation","description":"","operationId":"getWorkforcemanagementAgentAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The explanation was not found. It either does not exist or may now only be accessible via query by date range","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"getWorkforcemanagementAgentAdherenceExplanation"},"patch":{"tags":["Workforce Management"],"summary":"Update an adherence explanation","description":"","operationId":"patchWorkforcemanagementAgentAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/UpdateAdherenceExplanationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"202":{"description":"The adherence explanation update is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementAgentAdherenceExplanation"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations":{"post":{"tags":["Workforce Management"],"summary":"Add an adherence explanation for the requested user","description":"","operationId":"postWorkforcemanagementAgentAdherenceExplanations","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AddAdherenceExplanationAdminRequest"}}],"responses":{"202":{"description":"The adherence explanation is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:add"]},"x-purecloud-method-name":"postWorkforcemanagementAgentAdherenceExplanations"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations for the given agent across a specified range","description":"","operationId":"postWorkforcemanagementAgentAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsResponse"}},"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations across an entire business unit for the requested period","description":"","operationId":"postWorkforcemanagementBusinessunitAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsResponse"}},"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"The requested business unit was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations for the current user","description":"","operationId":"postWorkforcemanagementAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsRequest"}}],"responses":{"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/QueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/adherence/explanations":{"post":{"tags":["Workforce Management"],"summary":"Submit an adherence explanation for the current user","description":"","operationId":"postWorkforcemanagementAdherenceExplanations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AddAdherenceExplanationAgentRequest"}}],"responses":{"202":{"description":"The adherence explanation is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceExplanations"}},"/api/v2/workforcemanagement/adherence/explanations/{explanationId}":{"get":{"tags":["Workforce Management"],"summary":"Get an adherence explanation for the current user","description":"","operationId":"getWorkforcemanagementAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The explanation was not found. It either does not exist or may now only be accessible via query by date range","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAdherenceExplanation"}},"/api/v2/workforcemanagement/adherence/historical/bulk":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report in bulk","description":"","operationId":"postWorkforcemanagementAdherenceHistoricalBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.fields":"One or more required fields are missing from the request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.only.authorized.for.team.access.some.divisions":"You are only authorized to call this route for specific teams for some of the required divisions","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistoricalBulk"}},"/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceHistoricalBulkJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job to get","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementAdherenceHistoricalBulkJob"}},"/api/v2/workforcemanagement/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Deprecated. Use bulk routes instead (/adherence/historical/bulk)","description":"","operationId":"postWorkforcemanagementAdherenceHistorical","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForUsers"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistorical"}},"/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of a historical adherence request operation. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceHistoricalJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"Successful Operation","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entitynotfound":"The requested entity was not found.","job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherenceHistoricalJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementManagementunitHistoricaladherencequery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitHistoricaladherencequery"}},"/api/v2/workforcemanagement/teams/{teamId}/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Request a teams historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementTeamAdherenceHistorical","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"The ID of the team","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForTeams"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","wfm.unauthorized.for.any.team.members":"You are not authorized for any members of the team","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementTeamAdherenceHistorical"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of user schedule adherence records for the requested management unit","description":"","operationId":"getWorkforcemanagementManagementunitAdherence","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleAdherenceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"The management unit ID must be a valid UUID","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAdherence"}},"/api/v2/workforcemanagement/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of UserScheduleAdherence records for the requested users","description":"","operationId":"getWorkforcemanagementAdherence","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"All requested user IDs must be valid UUIDs","no.user.ids.specified":"You must specify at least one userId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fail":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherence"}},"/api/v2/workforcemanagement/agents/me/possibleworkshifts":{"post":{"tags":["Workforce Management"],"summary":"Get agent possible work shifts for requested time frame","description":"","operationId":"postWorkforcemanagementAgentsMePossibleworkshifts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AgentPossibleWorkShiftsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentPossibleWorkShiftsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentPossibleWorkShifts:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentsMePossibleworkshifts"}},"/api/v2/workforcemanagement/calendar/url/ics":{"get":{"tags":["Workforce Management"],"summary":"Get existing calendar link for the current user","description":"","operationId":"getWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"Calendar ICS not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync","wfm:agentSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementCalendarUrlIcs"},"post":{"tags":["Workforce Management"],"summary":"Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned","description":"","operationId":"postWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize default activity code names in the ics-formatted calendar","required":false,"type":"string","default":"en-US","x-example":"en-US"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"201":{"description":"","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync","wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementCalendarUrlIcs"},"delete":{"tags":["Workforce Management"],"summary":"Disable generated calendar link for the current user","description":"","operationId":"deleteWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync"]},"x-purecloud-method-name":"deleteWorkforcemanagementCalendarUrlIcs"}},"/api/v2/workforcemanagement/timeofflimits/available/query":{"post":{"tags":["Workforce Management"],"summary":"Queries available time off for the current user","description":"","operationId":"postWorkforcemanagementTimeofflimitsAvailableQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeofflimitsAvailableQuery"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions":{"get":{"tags":["Workforce Management"],"summary":"Get the daily waitlist positions of a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequestWaitlistpositions","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WaitlistPositionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequestWaitlistpositions"}},"/api/v2/workforcemanagement/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequests"},"post":{"tags":["Workforce Management"],"summary":"Create a time off request for the current user","description":"","operationId":"postWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAgentTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequests"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request for the current user","description":"","operationId":"patchWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementTimeoffrequest"}},"/api/v2/workforcemanagement/agentschedules/mine":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementAgentschedulesMine","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuGetCurrentAgentScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuCurrentAgentScheduleSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentschedulesMine"}},"/api/v2/workforcemanagement/schedules":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementSchedules"}},"/api/v2/workforcemanagement/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all of my shift trades","description":"","operationId":"getWorkforcemanagementShifttrades","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementShifttrades"}},"/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves integration statuses for a list of current user time off requests","description":"","operationId":"postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserTimeOffIntegrationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffIntegrationStatusResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The user is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery"}},"/api/v2/workforcemanagement/notifications":{"get":{"tags":["Workforce Management"],"summary":"Get a list of notifications for the current user","description":"Notifications are only initially sent if you have the relevant Notify and Edit permissions","operationId":"getWorkforcemanagementNotifications","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementNotifications"}},"/api/v2/workforcemanagement/notifications/update":{"post":{"tags":["Workforce Management"],"summary":"Mark a list of notifications as read or unread","description":"","operationId":"postWorkforcemanagementNotificationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateNotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-purecloud-method-name":"postWorkforcemanagementNotificationsUpdate"}},"/api/v2/workforcemanagement/historicaldata/deletejob":{"get":{"tags":["Workforce Management"],"summary":"Retrieves delete job status for historical data imports of the organization","description":"","operationId":"getWorkforcemanagementHistoricaldataDeletejob","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoricalImportDeleteJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Invalid status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"No historical data delete request was found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"getWorkforcemanagementHistoricaldataDeletejob"},"post":{"tags":["Workforce Management"],"summary":"Delete the entries of the historical data imports in the organization","description":"","operationId":"postWorkforcemanagementHistoricaldataDeletejob","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Delete job is accepted. Try using get API to get the status.","schema":{"$ref":"#/definitions/HistoricalImportDeleteJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postWorkforcemanagementHistoricaldataDeletejob"}},"/api/v2/workforcemanagement/historicaldata/importstatus":{"get":{"tags":["Workforce Management"],"summary":"Retrieves status of the historical data imports of the organization","description":"","operationId":"getWorkforcemanagementHistoricaldataImportstatus","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoricalImportStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"getWorkforcemanagementHistoricaldataImportstatus"}},"/api/v2/workforcemanagement/historicaldata/validate":{"post":{"tags":["Workforce Management"],"summary":"Trigger validation process for historical import","description":"","operationId":"postWorkforcemanagementHistoricaldataValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/ValidationServiceRequest"}}],"responses":{"202":{"description":"Accepted - Triggering validation process."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.historical.running.request":"Another request from organization is in progress."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postWorkforcemanagementHistoricaldataValidate"}},"/api/v2/workforcemanagement/agents/integrations/hris/query":{"post":{"tags":["Workforce Management"],"summary":"Query integrations for agents","description":"","operationId":"postWorkforcemanagementAgentsIntegrationsHrisQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryAgentsIntegrationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentsIntegrationsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentsIntegrationsHrisQuery"}},"/api/v2/workforcemanagement/agents/{agentId}/integrations/hris":{"put":{"tags":["Workforce Management"],"summary":"Update integrations for agent","description":"","operationId":"putWorkforcemanagementAgentIntegrationsHris","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AgentIntegrationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentIntegrationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","user.ids.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"putWorkforcemanagementAgentIntegrationsHris"}},"/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the results of time off types job","description":"","operationId":"getWorkforcemanagementIntegrationsHrisTimeofftypesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HrisTimeOffTypesJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementIntegrationsHrisTimeofftypesJob"}},"/api/v2/workforcemanagement/integrations/hris":{"get":{"tags":["Workforce Management"],"summary":"Get integrations","description":"","operationId":"getWorkforcemanagementIntegrationsHris","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:integration:view"]},"x-purecloud-method-name":"getWorkforcemanagementIntegrationsHris"}},"/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs":{"post":{"tags":["Workforce Management"],"summary":"Get list of time off types configured in integration","description":"","operationId":"postWorkforcemanagementIntegrationsHriTimeofftypesJobs","produces":["application/json"],"parameters":[{"name":"hrisIntegrationId","in":"path","description":"The ID of the HRIS integration for which time off types are queried.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HrisTimeOffTypesResponse"}},"202":{"description":"The time off types query is processing","schema":{"$ref":"#/definitions/HrisTimeOffTypesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The integration was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:integration:view"]},"x-purecloud-method-name":"postWorkforcemanagementIntegrationsHriTimeofftypesJobs"}},"/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"To get status of the modeling job.","description":"This Endpoint is Deprecated, and not recommended to be used.","operationId":"getWorkforcemanagementAdhocmodelingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the modeling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ModelingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adhocModel:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdhocmodelingjob"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions":{"get":{"tags":["Workforce Management"],"summary":"Get the performance prediction for the associated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Upload daily activity changes to be able to request a performance prediction recalculation","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations":{"post":{"tags":["Workforce Management"],"summary":"Request a daily recalculation of the performance prediction for the associated schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}":{"get":{"tags":["Workforce Management"],"summary":"Get recalculated performance prediction result","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the recalculation belongs to","required":true,"type":"string"},{"name":"recalculationId","in":"path","description":"The ID of the recalculation request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs":{"get":{"tags":["Workforce Management"],"summary":"Get the list of scheduling runs","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRuns","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRunListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRuns"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}":{"get":{"tags":["Workforce Management"],"summary":"Get a scheduling run","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRun"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRun"},"delete":{"tags":["Workforce Management"],"summary":"Cancel a scheduling run","description":"","operationId":"deleteWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"204":{"description":"The run was successfully canceled"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitSchedulingRun"},"patch":{"tags":["Workforce Management"],"summary":"Mark a schedule run as applied","description":"","operationId":"patchWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PatchBuScheduleRunRequest"}}],"responses":{"204":{"description":"The update was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitSchedulingRun"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a rescheduling operation","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRunResult","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"name":"managementUnitIds","in":"query","description":"The IDs of the management units for which to fetch the reschedule results","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The fields to expand. Omitting will return an empty response","required":true,"type":"array","items":{"type":"string","enum":["headcountForecast","generationResults","agentSchedules"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuRescheduleResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","wfm.only.authorized.for.team.access":"Unauthorized: User only given team access permissions","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit","wfm:schedule:generate"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRunResult"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Search published schedules","description":"","operationId":"postWorkforcemanagementBusinessunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["managementUnits.agents"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedule"},"delete":{"tags":["Workforce Management"],"summary":"Delete a schedule","description":"","operationId":"deleteWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule is being deleted and updates will be sent by notification"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekSchedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule":{"post":{"tags":["Workforce Management"],"summary":"Start a rescheduling run","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleReschedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuRescheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"202":{"description":"The rescheduling run was started and updates will be sent by notification","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleReschedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Get the list of week schedules for the specified week","description":"Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"includeOnlyPublished","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["forecast.description"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedules"},"post":{"tags":["Workforce Management"],"summary":"Create a blank schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCreateBlankScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"201":{"description":"The schedule was successfully created","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"VALIDATION_FAILURE","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedules"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for importing a schedule","description":"Once the upload is complete, call the /import route to start the schedule import process","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScheduleUploadResponse"}},"201":{"description":"The upload url for import was successfully created","schema":{"$ref":"#/definitions/ImportScheduleUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import":{"post":{"tags":["Workforce Management"],"summary":"Starts processing a schedule import","description":"Call after uploading the schedule data to the url supplied by the /import/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesImport","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleUploadProcessingResponse"}},"202":{"description":"The schedule import is processing","schema":{"$ref":"#/definitions/ScheduleUploadProcessingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesImport"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuGenerateScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"202":{"description":"The schedule generation run was started and updates will be sent via notification","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCopyScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"201":{"description":"The schedule was successfully copied","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule copy was started and updates will be sent via notification","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Get the generation results for a generated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast":{"get":{"tags":["Workforce Management"],"summary":"Get the headcount forecast by planning group for the schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"forceDownload","in":"query","description":"Whether to force the result to come via download url. For testing purposes only","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuHeadcountForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query":{"post":{"tags":["Workforce Management"],"summary":"Loads agent schedule data from the schedule. Used in combination with the metadata route","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuQueryAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You requested teams to which you do not have access","wfm.management.unit.not.authorized":"You are not authorized to view schedules for this management unit","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Loads agent's schedule history.","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"agentId","in":"path","description":"THe ID of the agent","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAgentScheduleHistoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The requested user is not in a team but you only have access to teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","wfm.management.unit.not.authorized":"You are not authorized to view schedule history for this management unit","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wfm.only.authorized.for.team.required.divisions":"The requested user is not in a team but you only have access to teams in the required division","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for updating a schedule","description":"Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process","operationId":"postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateScheduleUploadResponse"}},"201":{"description":"The upload url for schedule update was successfully created","schema":{"$ref":"#/definitions/UpdateScheduleUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update":{"post":{"tags":["Workforce Management"],"summary":"Starts processing a schedule update","description":"Call after uploading the schedule data to the url supplied by the /update/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekScheduleUpdate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/ProcessScheduleUpdateUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule update process was started","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only edit schedules for up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.no.authorization.to.edit.schedule.for.teams":"The user is not authorized to edit the schedule(s) of any of the users in the requested teams","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleUpdate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitSchedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UserListScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","wfm.deprecated.api.timeout":"The response of this deprecated route needed to come via notification, instead please use /agentschedules/search"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitSchedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"Return only published schedules","required":false,"type":"boolean"},{"name":"earliestWeekDate","in":"query","description":"The start date of the earliest week to query in yyyy-MM-dd format","required":false,"type":"string"},{"name":"latestWeekDate","in":"query","description":"The start date of the latest week to query in yyyy-MM-dd format","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedules"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get a week schedule","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"string","enum":["generationResults","headcountForecast"]},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedule"}},"/api/v2/workforcemanagement/schedulingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the scheduling job","description":"","operationId":"getWorkforcemanagementSchedulingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the scheduling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchedulingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedulingrequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementSchedulingjob"}},"/api/v2/workforcemanagement/shrinkage/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Request to fetch the status of the historical shrinkage query","description":"","operationId":"getWorkforcemanagementShrinkageJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"Accepted","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementShrinkageJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a historical shrinkage report","description":"The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body. ","operationId":"postWorkforcemanagementManagementunitShrinkageJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalShrinkageRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shrinkage:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitShrinkageJobs"}},"/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a historical shrinkage report","description":"The maximum supported range for historical shrinkage queries is up to 32 days","operationId":"postWorkforcemanagementTeamShrinkageJobs","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"The ID of the team","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalShrinkageTeamsRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.unauthorized.for.any.team.members":"You are not authorized for any members of the team","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shrinkage:view"]},"x-purecloud-method-name":"postWorkforcemanagementTeamShrinkageJobs"}},"/api/v2/workforcemanagement/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for the current user for specified activity code and dates","description":"","operationId":"postWorkforcemanagementTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/TimeOffBalanceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The current user time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the results of time off types job","description":"","operationId":"getWorkforcemanagementTimeoffbalanceJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalanceJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementTimeoffbalanceJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for dates spanned by a given time off request","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the time off request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The time off request id.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for a given user for specified activity code and dates","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/TimeOffBalanceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The user time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time-off limit objects","description":"","operationId":"getWorkforcemanagementBusinessunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific time-off limit objects","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view","wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeofflimits"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time-off limit object","description":"","operationId":"postWorkforcemanagementBusinessunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuCreateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"201":{"description":"The time-off limit was successfully created","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeofflimits"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time-off limit object","description":"Returns properties of time-off limit object, but not daily values","operationId":"getWorkforcemanagementBusinessunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeofflimit"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time-off limit object","description":"","operationId":"deleteWorkforcemanagementBusinessunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit object to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time-off limit object deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitTimeofflimit"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values":{"put":{"tags":["Workforce Management"],"summary":"Sets daily values for a date range of time-off limit object","description":"Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API","operationId":"putWorkforcemanagementBusinessunitTimeofflimitValues","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit object to set values for","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSetTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"putWorkforcemanagementBusinessunitTimeofflimitValues"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves time-off limit related values based on a given set of filters.","description":"","operationId":"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time-off plans","description":"","operationId":"getWorkforcemanagementBusinessunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific staffing groups","required":false,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeoffplans"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time-off plan","description":"","operationId":"postWorkforcemanagementBusinessunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuCreateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"201":{"description":"The time-off plan was successfully created","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeoffplans"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time-off plan","description":"","operationId":"getWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeoffplan"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time-off plan","description":"","operationId":"deleteWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time-off plan was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitTimeoffplan"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time-off plan","description":"","operationId":"patchWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuUpdateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitTimeoffplan"}},"/api/v2/taskmanagement/workbins/query":{"post":{"tags":["Task Management"],"summary":"Query for workbins","description":"","operationId":"postTaskmanagementWorkbinsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"QueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorkbinQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"User has no permission access to the division.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"postTaskmanagementWorkbinsQuery"}},"/api/v2/taskmanagement/workbins/{workbinId}":{"get":{"tags":["Task Management"],"summary":"Get a workbin","description":"","operationId":"getTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbin"},"delete":{"tags":["Task Management"],"summary":"Delete a workbin","description":"","operationId":"deleteTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.entity.used":"Workbin still being used by a Worktype.","pre.check.delete.failed":"Workbin still has Workitems associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkbin"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a workbin","description":"","operationId":"patchTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Json with attributes and their new values: {\"description\":\"new description\", \"name\":\"new name\"}.","required":true,"schema":{"$ref":"#/definitions/WorkbinUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkbin"}},"/api/v2/taskmanagement/workbins":{"post":{"tags":["Task Management"],"summary":"Create a workbin","description":"","operationId":"postTaskmanagementWorkbins","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkbinCreate"}}],"responses":{"201":{"description":"Workbin created.","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"Maximum number of Workbins reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:add"]},"x-purecloud-method-name":"postTaskmanagementWorkbins"}},"/api/v2/taskmanagement/workitems":{"post":{"tags":["Task Management"],"summary":"Create a workitem","description":"","operationId":"postTaskmanagementWorkitems","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"201":{"description":"Workitem created.","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.missing.queue":"No queueId provided.","service.limit.per.day.maximum.created.limit.reached":"Reached maximum amount of workitems created per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.date.above.max":"Date above maximum.","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.date.below.min":"Date below minimum.","invalid.input.duplicate.scored.agents":"Duplicate entries in the scored agents list.","invalid.input.empty.value":"Empty value.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.timestamp.above.max":"Timestamp above maximum.","invalid.input.timestamp.below.min":"Timestamp below minimum.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.undefined.status":"Undefined status.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","workitem.queue.division.mismatch":"Queue is in a different division from workitem."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","utilization.label.id.not.found":"Utilization label ID does not exist","not.found":"The requested resource was not found.","not.found.error":"Worktype or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.workitem.division.mismatch":"A Workitem's Workbin and Worktype must belong to the same division.","wrapup.not.in.queue":"Wrapup code is not configured in the queue.","pre.check.value.greater.than":"Due date greater than expiration or expiration greater than TTL.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","service.limit.acd.started.maximum.limit.reached":"Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schema.error.schema.not.found":"Schema not found.","schema.error.schema.disabled":"Schema disabled.","schema.error.worktype.no.schema":"Worktype for this workitem does not have a schema defined.","schema.error.property.disabled":"Schema property disabled.","schema.error.missing.attributes":"Missing attributes.","schema.error.schema.deleted":"Schema deleted.","schema.error.invalid.schema":"Invalid schema.","schema.error.missing.version":"Schema version is not defined in this workitem.","schema.error.invalid.instance":"Invalid schema instance."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schedule.service.error.job.creation.failed":"Failed to schedule status transition.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitems"}},"/api/v2/taskmanagement/workitems/query/jobs":{"post":{"tags":["Task Management"],"summary":"Create a workitem query job","description":"","operationId":"postTaskmanagementWorkitemsQueryJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WorkitemQueryJobCreate","required":true,"schema":{"$ref":"#/definitions/WorkitemQueryJobCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemQueryJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.concurrent.query.job.per.user.limit.exceeded":"Rate limit exceeded for concurrent queries per user","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","workitem.concurrent.query.job.per.organization.limit.exceeded":"Rate limit exceeded for concurrent queries per org","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"No permission in any divisions to create the job.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:queryJob:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsQueryJobs"}},"/api/v2/taskmanagement/workitems/query/jobs/{jobId}":{"get":{"tags":["Task Management"],"summary":"Get the workitem query job associated with the job id.","description":"","operationId":"getTaskmanagementWorkitemsQueryJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemQueryJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","workitem.missing.required.division.permissions":"Missing division permissions to view the job."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Job not found with the supplied id"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:queryJob:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsQueryJob"}},"/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results":{"get":{"tags":["Task Management"],"summary":"Get results from for workitem query job ","description":"","operationId":"getTaskmanagementWorkitemsQueryJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemPagedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","workitem.missing.required.division.permissions":"Missing division permissions to view the job results."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Job not found with the supplied id"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:queryJobResults:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsQueryJobResults"}},"/api/v2/taskmanagement/workitems/{workitemId}/disconnect":{"post":{"tags":["Task Management"],"summary":"Disconnect the assignee of the workitem","description":"","operationId":"postTaskmanagementWorkitemDisconnect","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:disconnect"]},"x-purecloud-method-name":"postTaskmanagementWorkitemDisconnect"}},"/api/v2/taskmanagement/workitems/{workitemId}/terminate":{"post":{"tags":["Task Management"],"summary":"Terminate a workitem","description":"","operationId":"postTaskmanagementWorkitemTerminate","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Terminated request","required":false,"schema":{"$ref":"#/definitions/WorkitemTerminate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.cannot.terminate.terminated.workitem":"Cannot terminate an already terminated workitem.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","pre.check.status.must.be.closed.category.for.terminated.workitem":"Status provided is not a 'Closed' category status.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Not found error"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:terminate"]},"x-purecloud-method-name":"postTaskmanagementWorkitemTerminate"}},"/api/v2/taskmanagement/workitems/{workitemId}":{"get":{"tags":["Task Management"],"summary":"Get a workitem","description":"","operationId":"getTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields to expand. Comma separated if more than one.","required":false,"type":"string","enum":["type","workbin","status","queue","assignee"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitem"},"delete":{"tags":["Task Management"],"summary":"Delete a workitem","description":"","operationId":"deleteTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.cannot.be.deleted.due.to.assignment.state":"Workitem cannot be deleted in certain assignment states"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkitem"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a workitem","description":"","operationId":"patchTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.invalid.assign.state":"Invalid assignment state.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.date.above.max":"Date above maximum.","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.date.below.min":"Date below minimum.","invalid.input.transition.delay.too.low":"Status transition delay too low.","invalid.input.duplicate.scored.agents":"Duplicate entries in the scored agents list.","invalid.input.empty.value":"Empty value.","invalid.input.missing.queue.in.workitem":"No queueId provided in the Workitem.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.update.queue.and.assignee":"Cannot update queue and assignee in the same request.","service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","invalid.input.timestamp.above.max":"Timestamp above maximum.","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","invalid.input.timestamp.below.min":"Timestamp below minimum.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.undefined.status":"Undefined status.","invalid.input.update.user.and.queue":"Cannot update user and queue in the same request.","invalid.input.update.assign.state.in.assign":"Cannot update assignmentState.","invalid.input.missing.assignee":"Cannot perform assignment without an assignee.","invalid.input.int.value.too.low":"Integer too low.","invalid.input.invalid.status.transition":"Invalid status transition.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","workitem.queue.division.mismatch":"Queue is in a different division from workitem."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","utilization.label.id.not.found":"Utilization label ID does not exist","not.found":"The requested resource was not found.","not.found.error":"Workitem type or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition.","pre.check.workitem.division.cannot.be.changed":"A workitem cannot be moved to a Workbin from another division.","invalid.assignment.requester.not.assignee":"Requester is not the assignee.","pre.check.cannot.be.reassigned":"Workitem cannot be reassigned.","pre.check.cannot.update.terminated.workitem":"Terminated workitem cannot be updated.","pre.check.value.greater.than":"Due date greater than expiration or expiration greater than TTL.","service.limit.acd.started.maximum.limit.reached":"Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue","invalid.assignment.cannot.reassign.for.state":"Cannot be assigned to another user."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schema.error.schema.not.found":"Schema not found.","schema.error.worktype.no.schema":"Worktype for this workitem does not have a schema defined.","schema.error.property.disabled":"Schema property disabled.","schema.error.missing.attributes":"Missing attributes.","schema.error.invalid.schema":"Invalid schema.","schema.error.missing.version":"Schema version is not defined in this workitem.","schema.error.invalid.instance":"Invalid schema instance."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schedule.service.error.job.creation.failed":"Job creation failed.","schedule.service.error.job.search.failed":"Job search failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:edit","workitems:workitem:accept"]},"x-purecloud-method-name":"patchTaskmanagementWorkitem"}},"/api/v2/taskmanagement/workitems/{workitemId}/assignment":{"patch":{"tags":["Task Management"],"summary":"Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"patchTaskmanagementWorkitemAssignment","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/WorkitemManualAssign"}}],"responses":{"202":{"description":"The manual assignment request was accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","workitem.not.queued.for.assignment":"The workitem cannot be manually assigned as it is not queued for assignment.","invalid.property":"Value [%s] is not a valid property for object [%s]","operation.failed":"The manual assignment attempt failed.","constraint.validation":"%s","invalid.status":"The user's current routing status does not allow for new assignments.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","feature.not.enabled":"Manual assignment not enabled for queue","invalid.id":"The targeted user ID is missing or invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:pull","workitems:workitem:assign"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemAssignment"}},"/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel":{"post":{"tags":["Task Management"],"summary":"Cancel the assignment process for a workitem that is currently queued for assignment through ACD.","description":"","operationId":"postTaskmanagementWorkitemAcdCancel","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:cancelRouting"]},"x-purecloud-method-name":"postTaskmanagementWorkitemAcdCancel"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}":{"get":{"tags":["Task Management"],"summary":"Get a schema","description":"","operationId":"getTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchema"},"put":{"tags":["Task Management"],"summary":"Update a schema","description":"","operationId":"putTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:edit"]},"x-purecloud-method-name":"putTaskmanagementWorkitemsSchema"},"delete":{"tags":["Task Management"],"summary":"Delete a schema","description":"","operationId":"deleteTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.schema.cannot.be.deleted":"Workitem schema cannot be deleted. There are Worktypes associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkitemsSchema"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["Task Management"],"summary":"Get a specific version of a schema","description":"","operationId":"getTaskmanagementWorkitemsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemaVersion"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a schema","description":"","operationId":"getTaskmanagementWorkitemsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemaVersions"}},"/api/v2/taskmanagement/workitems/schemas":{"get":{"tags":["Task Management"],"summary":"Get a list of schemas.","description":"","operationId":"getTaskmanagementWorkitemsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemas"},"post":{"tags":["Task Management"],"summary":"Create a schema","description":"","operationId":"postTaskmanagementWorkitemsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsSchemas"}},"/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups":{"get":{"tags":["Task Management"],"summary":"Get all wrapup codes added for the given user for a workitem.","description":"","operationId":"getTaskmanagementWorkitemUserWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["wrapupCode"]},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup view permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemUserWrapups"},"patch":{"tags":["Task Management"],"summary":"Add/Remove a wrapup code for a given user in a workitem.","description":"","operationId":"patchTaskmanagementWorkitemUserWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to add/remove a wrapup code for a workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemWrapupUpdate"}},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Wrapup code did not pass validation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","wrapup.action.required":"The request body is missing the action property","invalid.value":"Invalid value for action is provided.","validation.failure":"The json request body is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup edit permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.not.found":"Wrapup code not found","wrapup.deleted":"Wrapup code has been deleted","user.not.found":"User not found","workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","wrapup.max.count.per.user":"Maximum wrap-up count is reached.","wrapup.already.added":"This wrap-up code was already added for this user.","wrapup.not.in.queue":"Wrap-up code is not configured in the queue.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","wrapup.cannot.be.added.or.removed":"A terminated workitem cannot have wrap-up codes applied or removed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemUserWrapups"}},"/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups":{"patch":{"tags":["Task Management"],"summary":"Add/Remove a wrapup code for the current user in a workitem.","description":"","operationId":"patchTaskmanagementWorkitemUsersMeWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to add/remove the wrapup code for workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemWrapupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Wrapup did not pass validation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","wrapup.action.required":"The request body is missing the action property","invalid.value":"Invalid value for action is provided.","validation.failure":"The json request body is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup edit permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.not.found":"Wrapup code not found","wrapup.deleted":"Wrapup code has been deleted","user.not.found":"User not found","workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","wrapup.max.count.per.user":"Maximum wrap-up count is reached.","wrapup.already.added":"This wrap-up code was already added for this user.","wrapup.not.in.queue":"Wrap-up code is not configured in the queue.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","wrapup.cannot.be.added.or.removed":"A terminated workitem cannot have wrapup codes applied or removed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapupSelf:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemUsersMeWrapups"}},"/api/v2/taskmanagement/workitems/{workitemId}/wrapups":{"get":{"tags":["Task Management"],"summary":"Get all wrapup codes added for all users for a workitem.","description":"","operationId":"getTaskmanagementWorkitemWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["wrapupCode"]},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup view permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemWrapups"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}":{"get":{"tags":["Task Management"],"summary":"Get a status","description":"","operationId":"getTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeStatus"},"delete":{"tags":["Task Management"],"summary":"Delete a status","description":"","operationId":"deleteTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.status.is.default.status":"The status is the Worktype's default status.","pre.check.worktype.being.used":"Worktype is in use.","pre.check.status.is.destination":"The status is a destination status.","pre.check.status.is.default.destination":"The status is a default destination of another status."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeStatus"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a status","description":"","operationId":"patchTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkitemStatusUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.int.value.too.high":"Integer too high.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.duplicate.status.name":"Duplicate status name.","invalid.input.transition.delay.too.low":"Transition delay too low.","invalid.input.empty.value":"Empty value.","invalid.input.transition.delay.too.high":"Transition delay too high.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.wrong.time.format":"Wrong time format.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.duplicate.destinations":"Duplicate destinations.","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.input.status.itself.as.destination":"Cannot have itself as destination.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.destinations.without.default.destination":"Destinations list does not contain the default destination.","invalid.input.destination.does.not.exist":"Destination does not exist.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.input.missing.transition.delay":"Missing transition delay."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeStatus"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/statuses":{"get":{"tags":["Task Management"],"summary":"Get list of statuses for this worktype.","description":"","operationId":"getTaskmanagementWorktypeStatuses","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.invalid.path.id":"Invalid UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeStatuses"},"post":{"tags":["Task Management"],"summary":"Add a status to a worktype","description":"","operationId":"postTaskmanagementWorktypeStatuses","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkitemStatusCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"201":{"description":"Workitem status created.","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.invalid.category":"Invalid category.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.duplicate.status.name":"Duplicate status name.","invalid.input.transition.delay.too.low":"Transition delay too low.","invalid.input.empty.value":"Empty value.","invalid.input.transition.delay.too.high":"Transition delay too high.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.wrong.time.format":"Wrong time format.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.duplicate.destinations":"Duplicate destinations.","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.destination.does.not.exist":"Destination does not exist.","invalid.input.limit.reached":"Limit reached for number of statuses.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.input.missing.transition.delay":"Missing transition delay."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeStatuses"}},"/api/v2/taskmanagement/worktypes/query":{"post":{"tags":["Task Management"],"summary":"Query for worktypes","description":"","operationId":"postTaskmanagementWorktypesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"QueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorktypeQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"User has no permission access to the division.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"postTaskmanagementWorktypesQuery"}},"/api/v2/taskmanagement/worktypes/{worktypeId}":{"get":{"tags":["Task Management"],"summary":"Get a worktype","description":"","operationId":"getTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["defaultQueue","defaultSkills","defaultLanguage","schema"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktype"},"delete":{"tags":["Task Management"],"summary":"Delete a worktype","description":"","operationId":"deleteTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.worktype.being.used":"Worktype still has Workitems associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktype"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a worktype","description":"","operationId":"patchTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorktypeUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.int.value.too.high":"Integer too high.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.default.queue.required":"Default Queue ID cannot be null if Assignment is enabled.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.schema.cannot.change":"Schema cannot be changed.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","worktype.queue.division.mismatch":"Worktype must be in the same division as the default queue.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","workitem.schema.not.updatable":"The schemaId of a worktype cannot be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","not.found":"The requested resource was not found.","not.found.error":"Worktype or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.worktype.workbin.division.mismatch":"A Worktype and its default Workbin must belong to the same division.","pre.check.name.in.use":"Name is already in use.","pre.check.value.greater.than":"Due duration greater than expiration or expiration greater than TTL."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:worktype:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktype"}},"/api/v2/taskmanagement/worktypes":{"post":{"tags":["Task Management"],"summary":"Create a worktype","description":"","operationId":"postTaskmanagementWorktypes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorktypeCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"201":{"description":"Worktype created.","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","workitem.default.workbin.required":"A defaultWorkbinId is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.default.queue.required":"Default Queue ID cannot be null if Assignment is enabled.","invalid.property":"Value [%s] is not a valid property for object [%s]","workitem.division.mismatch":"Worktype must be in the same division as its default Workbin.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","worktype.queue.division.mismatch":"Worktype must be in the same division as the default queue.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","not.found":"The requested resource was not found.","not.found.error":"Default Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use.","pre.check.value.greater.than":"Due duration greater than expiration or expiration greater than TTL.","pre.check.maximum.limit.reached":"Maximum number of Worktypes reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypes"}},"/api/v2/analytics/actions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for action aggregates asynchronously","description":"","operationId":"postAnalyticsActionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ActionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"postAnalyticsActionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/actions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for action aggregates","description":"","operationId":"getAnalyticsActionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getAnalyticsActionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/actions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsActionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getAnalyticsActionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for bot aggregates asynchronously","description":"","operationId":"postAnalyticsBotsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/BotAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"postAnalyticsBotsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for bot aggregates","description":"","operationId":"getAnalyticsBotsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"getAnalyticsBotsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsBotsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"getAnalyticsBotsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation aggregates asynchronously","description":"","operationId":"postAnalyticsConversationsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Conversations"],"summary":"Get status for async query for conversation aggregates","description":"","operationId":"getAnalyticsConversationsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsConversationsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Conversations"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsConversationsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsConversationsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs":{"post":{"tags":["Analytics","Quality"],"summary":"Query for evaluation aggregates asynchronously","description":"","operationId":"postAnalyticsEvaluationsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Quality"],"summary":"Get status for async query for evaluation aggregates","description":"","operationId":"getAnalyticsEvaluationsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsEvaluationsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Quality"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsEvaluationsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsEvaluationsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for flow execution aggregates asynchronously","description":"","operationId":"postAnalyticsFlowexecutionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowExecutionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowexecutionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for flow execution aggregates","description":"","operationId":"getAnalyticsFlowexecutionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowexecutionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsFlowexecutionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowexecutionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow aggregates asynchronously","description":"","operationId":"postAnalyticsFlowsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Flows"],"summary":"Get status for async query for Flow aggregates","description":"","operationId":"getAnalyticsFlowsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Flows"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsFlowsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs":{"post":{"tags":["Analytics","Journey"],"summary":"Query for journey aggregates asynchronously","description":"","operationId":"postAnalyticsJourneysAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Journey"],"summary":"Get status for async query for journey aggregates","description":"","operationId":"getAnalyticsJourneysAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsJourneysAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Journey"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsJourneysAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsJourneysAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for knowledge aggregates asynchronously","description":"","operationId":"postAnalyticsKnowledgeAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/KnowledgeAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"postAnalyticsKnowledgeAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for knowledge aggregates","description":"","operationId":"getAnalyticsKnowledgeAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"getAnalyticsKnowledgeAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsKnowledgeAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"getAnalyticsKnowledgeAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for resolution aggregates asynchronously","description":"","operationId":"postAnalyticsResolutionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ResolutionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsResolutionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for resolution aggregates","description":"","operationId":"getAnalyticsResolutionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsResolutionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsResolutionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResolutionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsResolutionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs":{"post":{"tags":["Analytics","Quality"],"summary":"Query for survey aggregates asynchronously","description":"","operationId":"postAnalyticsSurveysAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Quality"],"summary":"Get status for async query for survey aggregates","description":"","operationId":"getAnalyticsSurveysAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsSurveysAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Quality"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsSurveysAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsSurveysAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async task management query","description":"","operationId":"getAnalyticsTaskmanagementAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TaskManagementAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"getAnalyticsTaskmanagementAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for task management aggregates","description":"","operationId":"postAnalyticsTaskmanagementAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TaskManagementAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TaskManagementAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"postAnalyticsTaskmanagementAggregatesQuery","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for task management aggregates asynchronously","description":"","operationId":"postAnalyticsTaskmanagementAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TaskManagementAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"postAnalyticsTaskmanagementAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for task management aggregates","description":"","operationId":"getAnalyticsTaskmanagementAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"getAnalyticsTaskmanagementAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for transcript aggregates","description":"","operationId":"getAnalyticsTranscriptsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"getAnalyticsTranscriptsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsTranscriptsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"getAnalyticsTranscriptsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates asynchronously","description":"","operationId":"postAnalyticsTranscriptsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs":{"post":{"tags":["Analytics","Users"],"summary":"Query for user aggregates asynchronously","description":"","operationId":"postAnalyticsUsersAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Users"],"summary":"Get status for async query for user aggregates","description":"","operationId":"getAnalyticsUsersAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"getAnalyticsUsersAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Users"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsUsersAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"getAnalyticsUsersAggregatesJobResults","x-genesys-preview":true}},"/api/v2/chats/users/{userId}":{"get":{"tags":["Chat"],"summary":"Get information for a 1on1","description":"","operationId":"getChatsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneOnOne"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:view"]},"x-purecloud-method-name":"getChatsUser","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/messages/pins":{"post":{"tags":["Chat"],"summary":"Add pinned messages for a 1on1, up to a maximum of 5 pinned messages","description":"","operationId":"postChatsUserMessagesPins","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"in":"body","name":"body","description":"Pinned Message Ids","required":true,"schema":{"$ref":"#/definitions/PinnedMessageRequest"}}],"responses":{"204":{"description":"Pinned messages added successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:edit"]},"x-purecloud-method-name":"postChatsUserMessagesPins","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}":{"delete":{"tags":["Chat"],"summary":"Remove a pinned message from a 1on1","description":"","operationId":"deleteChatsUserMessagesPin","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"pinnedMessageId","in":"path","description":"pinnedMessageId","required":true,"type":"string"}],"responses":{"204":{"description":"Pinned message removed successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:edit"]},"x-purecloud-method-name":"deleteChatsUserMessagesPin","x-genesys-preview":true}},"/api/v2/conversations/{conversationId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a conversation creating a barged in conference of connected participants.","description":"","operationId":"postConversationBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationBarge","x-genesys-preview":true}},"/api/v2/conversations/{conversationId}/utilizationlabel":{"patch":{"tags":["Conversations"],"summary":"Update the utilization label on a conversation. When there is no value provided, the system default label is applied","description":"","operationId":"patchConversationUtilizationlabel","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Utilization Label","required":true,"schema":{"$ref":"#/definitions/ConversationUtilizationLabelUpdate"}}],"responses":{"202":{"description":"The utilization label update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","utilization.label.id.not.found":"Utilization label id was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:utilizationLabel:edit"]},"x-purecloud-method-name":"patchConversationUtilizationlabel","x-genesys-preview":true}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a given participant's call creating a barged in conference of connected participants.","description":"","operationId":"postConversationsCallParticipantBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.barge.not.consult.initiator":"A user cannot barge a consult transfer party that is not the initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.multiple.barges":"A user cannot barge a participant that is already being barged.","conversation.error.barge.conference":"A participant cannot be barged when conversation is a conference.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationsCallParticipantBarge","x-genesys-preview":true}},"/api/v2/conversations/videos/meetings/{meetingId}":{"get":{"tags":["Conversations"],"summary":"Gets a record for a given meetingId","description":"","operationId":"getConversationsVideosMeeting","produces":["application/json"],"parameters":[{"name":"meetingId","in":"path","description":"meetingId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MeetingIdRecord"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"getConversationsVideosMeeting","x-genesys-preview":true}},"/api/v2/conversations/videos/meetings":{"post":{"tags":["Conversations"],"summary":"Generate a meetingId for a given conferenceId","description":"","operationId":"postConversationsVideosMeetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MeetingIdRequest","required":true,"schema":{"$ref":"#/definitions/GenerateMeetingIdRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MeetingIdRecord"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"postConversationsVideosMeetings","x-genesys-preview":true}},"/api/v2/conversations/videos/{conferenceId}/details":{"get":{"tags":["Conversations"],"summary":"Get video conference details (e.g. the current number of active participants).","description":"","operationId":"getConversationsVideoDetails","produces":["application/json"],"parameters":[{"name":"conferenceId","in":"path","description":"conferenceId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VideoConferenceDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.conference.not.found":"The conference does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"getConversationsVideoDetails","x-genesys-preview":true}},"/api/v2/flows/instances/settings/executiondata":{"get":{"tags":["Architect"],"summary":"Get the execution history enabled setting.","description":"Get the execution history enabled setting.","operationId":"getFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsExecutiondata","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Edit the execution history enabled setting.","description":"Edit the execution history enabled setting.","operationId":"patchFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"New Execution Data Setting","required":true,"schema":{"$ref":"#/definitions/ExecutionDataSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:edit"]},"x-purecloud-method-name":"patchFlowsInstancesSettingsExecutiondata","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels/default":{"get":{"tags":["Architect"],"summary":"Returns the flow default log level.","description":"Returns the flow default log level which will be used if no specific flow id log level is found.","operationId":"getFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true},"put":{"tags":["Architect"],"summary":"Edit the flow default log level.","description":"Edit the flow default log level.","operationId":"putFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:edit"]},"x-purecloud-method-name":"putFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Resets the org log level to default, base","description":"Resets the org log level to default, base","operationId":"deleteFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:delete"]},"x-purecloud-method-name":"deleteFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true}},"/api/v2/flows/{flowId}/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieves the log level for a flow by flow id.","description":"Retrieves the log level for a flow by flow id.","operationId":"getFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to get the loglevel for","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view"]},"x-purecloud-method-name":"getFlowInstancesSettingsLoglevels","x-genesys-preview":true},"post":{"tags":["Architect"],"summary":"Set the logLevel for a particular flow id","description":"Assigns a new loglevel to a flow id","operationId":"postFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to set the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:add"]},"x-purecloud-method-name":"postFlowInstancesSettingsLoglevels","x-genesys-preview":true},"put":{"tags":["Architect"],"summary":"Edit the logLevel for a particular flow id","description":"Updates the loglevel for a flow id","operationId":"putFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to edit the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:edit"]},"x-purecloud-method-name":"putFlowInstancesSettingsLoglevels","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Deletes a log level for a flow by flow id.","description":"Deletes the associated log level for a flow by flow id","operationId":"deleteFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to delete the loglevel for","required":true,"type":"string"}],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:delete"]},"x-purecloud-method-name":"deleteFlowInstancesSettingsLoglevels","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels/characteristics":{"get":{"tags":["Architect"],"summary":"Gets the available flow log level characteristics for this organization.","description":"Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.","operationId":"getFlowsInstancesSettingsLoglevelsCharacteristics","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowLogLevelCharacteristicsDefinitions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevel:view","architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsCharacteristics","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieve a list of LogLevels for the organization.","description":"Returns a paged set of LogLevels per flow id","operationId":"getFlowsInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view","architect:flow:search"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevels","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/draft/function":{"get":{"tags":["Integrations"],"summary":"Get draft function settings for Action","description":"","operationId":"getIntegrationsActionDraftFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftFunction","x-genesys-preview":true},"put":{"tags":["Integrations"],"summary":"Update draft function settings.","description":"","operationId":"putIntegrationsActionDraftFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to update function settings.","required":true,"schema":{"$ref":"#/definitions/Function"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:edit"]},"x-purecloud-method-name":"putIntegrationsActionDraftFunction","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/draft/function/upload":{"post":{"tags":["Uploads","Integrations"],"summary":"Create upload presigned URL for draft function package file.","description":"","operationId":"postIntegrationsActionDraftFunctionUpload","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to request URL upload.","required":true,"schema":{"$ref":"#/definitions/FunctionUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftFunctionUpload","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/function":{"get":{"tags":["Integrations"],"summary":"Get published function settings for Action","description":"","operationId":"getIntegrationsActionFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionFunction","x-genesys-preview":true}},"/api/v2/integrations/actions/functions/runtimes":{"get":{"tags":["Integrations"],"summary":"Get action function settings for Action","description":"","operationId":"getIntegrationsActionsFunctionsRuntimes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/FunctionRuntime"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionsFunctionsRuntimes","x-genesys-preview":true}},"/api/v2/chats/users/me/settings":{"get":{"tags":["Chat"],"summary":"Get a user's chat settings","description":"","operationId":"getChatsUsersMeSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getChatsUsersMeSettings","x-genesys-preview":true},"patch":{"tags":["Chat"],"summary":"Update a user's chat settings","description":"","operationId":"patchChatsUsersMeSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ChatUserSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-purecloud-method-name":"patchChatsUsersMeSettings","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/settings":{"get":{"tags":["Chat"],"summary":"Get a user's chat settings","description":"","operationId":"getChatsUserSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:usersettings:view","chat:setting:view"]},"x-purecloud-method-name":"getChatsUserSettings","x-genesys-preview":true},"patch":{"tags":["Chat"],"summary":"Update a user's chat settings","description":"","operationId":"patchChatsUserSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ChatUserSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:usersettings:edit","chat:setting:edit"]},"x-purecloud-method-name":"patchChatsUserSettings","x-genesys-preview":true}},"/api/v2/journey/sessions/{sessionId}/events":{"get":{"tags":["Journey"],"summary":"Retrieve all events for a given session.","description":"","operationId":"getJourneySessionEvents","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"System-generated UUID that represents the session the event is a part of.","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:event:view"]},"x-purecloud-method-name":"getJourneySessionEvents","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs":{"post":{"tags":["Journey"],"summary":"Create Outcome Attributions","description":"","operationId":"postJourneyOutcomesAttributionsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outcome attribution request","required":false,"schema":{"$ref":"#/definitions/OutcomeAttributionListing"}}],"responses":{"202":{"description":"Accepted - Running job asynchronously","schema":{"$ref":"#/definitions/OutcomeAttributionAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomeAttributionJob:add"]},"x-purecloud-method-name":"postJourneyOutcomesAttributionsJobs","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get job status.","description":"","operationId":"getJourneyOutcomesAttributionsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeAttributionJobStateResponse"}},"202":{"description":"Accepted - Running job asynchronously","schema":{"$ref":"#/definitions/OutcomeAttributionJobStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:outcomeAttributionJob:view"]},"x-purecloud-method-name":"getJourneyOutcomesAttributionsJob","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get outcome attribution entities from completed job.","description":"","operationId":"getJourneyOutcomesAttributionsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeAttributionResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:outcomeAttribution:view"]},"x-purecloud-method-name":"getJourneyOutcomesAttributionsJobResults","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}":{"get":{"tags":["Journey"],"summary":"Get a Journey View by ID","description":"returns the latest version","operationId":"getJourneyView","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyView","x-genesys-preview":true},"delete":{"tags":["Journey"],"summary":"Delete a Journey View by ID","description":"deletes all versions","operationId":"deleteJourneyView","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:delete"]},"x-purecloud-method-name":"deleteJourneyView","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{versionId}":{"get":{"tags":["Journey"],"summary":"Get a Journey View by ID and version","description":"","operationId":"getJourneyViewVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"versionId","in":"path","description":"versionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersion","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions":{"post":{"tags":["Journey"],"summary":"Update a Journey View by ID","description":"creates a new version","operationId":"postJourneyViewVersions","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"in":"body","name":"body","description":"JourneyView","required":true,"schema":{"$ref":"#/definitions/JourneyView"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"postJourneyViewVersions","x-genesys-preview":true}},"/api/v2/journey/views":{"get":{"tags":["Journey"],"summary":"Get a list of Journey Views","description":"","operationId":"getJourneyViews","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AddressableEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViews","x-genesys-preview":true},"post":{"tags":["Journey"],"summary":"Create a new Journey View","description":"","operationId":"postJourneyViews","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"JourneyView","required":true,"schema":{"$ref":"#/definitions/JourneyView"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:add"]},"x-purecloud-method-name":"postJourneyViews","x-genesys-preview":true}},"/api/v2/journey/views/encodings/validate":{"post":{"tags":["Journey"],"summary":"Validate whether an encoding exist for a label/value combination.","description":"True indicates a valid encoding","operationId":"postJourneyViewsEncodingsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/Label"}}}],"responses":{"200":{"description":"Execution submitted successfully.","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsEncodings:view"]},"x-purecloud-method-name":"postJourneyViewsEncodingsValidate","x-genesys-preview":true}},"/api/v2/journey/views/eventdefinitions/{eventDefinitionId}":{"get":{"tags":["Journey"],"summary":"Get an Event Definition","description":"","operationId":"getJourneyViewsEventdefinition","produces":["application/json"],"parameters":[{"name":"eventDefinitionId","in":"path","description":"Event Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyEventDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:eventDefinition:view"]},"x-purecloud-method-name":"getJourneyViewsEventdefinition","x-genesys-preview":true}},"/api/v2/journey/views/eventdefinitions":{"get":{"tags":["Journey"],"summary":"Get a list of Event Definitions","description":"","operationId":"getJourneyViewsEventdefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyEventDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:eventDefinition:view"]},"x-purecloud-method-name":"getJourneyViewsEventdefinitions","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest":{"get":{"tags":["Journey"],"summary":"Get the latest job of a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJobsLatest","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:view"]},"x-purecloud-method-name":"getJourneyViewVersionJobsLatest","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get the job for a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJob","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"jobId","in":"path","description":"JobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:view"]},"x-purecloud-method-name":"getJourneyViewVersionJob","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs":{"post":{"tags":["Journey"],"summary":"Submit a job request for a journey view version.","description":"used for long descriptions","operationId":"postJourneyViewVersionJobs","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"}],"responses":{"202":{"description":"Job submitted successfully.","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.conflicting.request":"Job is already running for this version of the journey view"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:add"]},"x-purecloud-method-name":"postJourneyViewVersionJobs","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get the result of a job for a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJobResults","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"JourneyViewResult id","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Id of the executing job","required":true,"type":"string"}],"responses":{"200":{"description":"Result received successfully","schema":{"$ref":"#/definitions/JourneyViewResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.resource.not.found":"Resource Not Found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsResults:view"]},"x-purecloud-method-name":"getJourneyViewVersionJobResults","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}":{"get":{"tags":["Knowledge"],"summary":"Get document content upload status","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocumentUpload","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"name":"uploadId","in":"path","description":"UploadId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operation.not.found":"Upload does not exist","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocumentUpload","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads":{"post":{"tags":["Knowledge"],"summary":"Upload Article Content","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocumentUploads","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocumentUploads","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}":{"get":{"tags":["Knowledge","Uploads"],"summary":"Get content upload from URL job status","description":"","operationId":"getKnowledgeKnowledgebaseUploadsUrlsJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Upload job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Content upload job status","schema":{"$ref":"#/definitions/GetUploadSourceUrlJobStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:uploadSourceUrlJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUploadsUrlsJob","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs":{"post":{"tags":["Knowledge","Uploads"],"summary":"Create content upload from URL job","description":"","operationId":"postKnowledgeKnowledgebaseUploadsUrlsJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"uploadRequest","required":true,"schema":{"$ref":"#/definitions/CreateUploadSourceUrlJobRequest"}}],"responses":{"202":{"description":"Content upload in progress","schema":{"$ref":"#/definitions/CreateUploadSourceUrlJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.reached":"Daily or monthly limit reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:uploadSourceUrlJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseUploadsUrlsJobs","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove":{"post":{"tags":["Knowledge"],"summary":"Bulk remove documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsBulkRemove","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkRemoveRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsBulkRemove","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update":{"post":{"tags":["Knowledge"],"summary":"Bulk update documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsBulkUpdate","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsBulkUpdate","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add":{"post":{"tags":["Knowledge"],"summary":"Bulk add document versions.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkVersionAddRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations":{"get":{"tags":["Knowledge"],"summary":"Get operations","description":"","operationId":"getKnowledgeKnowledgebaseOperations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"userId","in":"query","description":"If specified, retrieves operations associated with user ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"If specified, retrieves operations with specified operation type, comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["Export","Import","Parse","Sync"]},"collectionFormat":"multi"},{"name":"status","in":"query","description":"If specified, retrieves operations with specified operation status, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ","required":false,"type":"string","format":"interval"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OperationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importExportOperationsList:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseOperations","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query":{"get":{"tags":["Knowledge"],"summary":"Get ids of operation creator users and oauth clients","description":"","operationId":"getKnowledgeKnowledgebaseOperationsUsersQuery","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OperationCreatorUserResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importExportOperationsList:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseOperationsUsersQuery","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import":{"post":{"tags":["Knowledge"],"summary":"Import the parsed articles","description":"","operationId":"postKnowledgeKnowledgebaseParseJobImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequestImport"}}],"responses":{"204":{"description":"Parsed import job in progress"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseParseJobImport","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}":{"get":{"tags":["Knowledge"],"summary":"Get parse job report","description":"","operationId":"getKnowledgeKnowledgebaseParseJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.","required":false,"type":"array","items":{"type":"string","enum":["urls"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Parse job is done","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"202":{"description":"Parse job in progress","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseParseJob","x-genesys-preview":true},"patch":{"tags":["Knowledge"],"summary":"Send update to the parse operation","description":"","operationId":"patchKnowledgeKnowledgebaseParseJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequestPatch"}}],"responses":{"204":{"description":"Override saved"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseParseJob","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs":{"post":{"tags":["Knowledge"],"summary":"Create parse job","description":"","operationId":"postKnowledgeKnowledgebaseParseJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequest"}}],"responses":{"202":{"description":"Parse job in progress","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseParseJobs","x-genesys-preview":true}},"/api/v2/languageunderstanding/settings":{"get":{"tags":["Language Understanding"],"summary":"Get Organization Configuration","description":"","operationId":"getLanguageunderstandingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:settings:view"]},"x-purecloud-method-name":"getLanguageunderstandingSettings","x-genesys-preview":true}},"/api/v2/documentation/all/search":{"post":{"tags":["Search"],"summary":"Search all documents","description":"","operationId":"postDocumentationAllSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationV2SearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationAllSearch","x-genesys-preview":true}},"/api/v2/routing/utilization/labels/{labelId}":{"get":{"tags":["Routing"],"summary":"Get details about this utilization label","description":"","operationId":"getRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabel","x-genesys-preview":true},"put":{"tags":["Routing"],"summary":"Update a utilization label","description":"","operationId":"putRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/UpdateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilizationLabel","x-genesys-preview":true},"delete":{"tags":["Routing"],"summary":"Delete a utilization label","description":"","operationId":"deleteRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Remove all label usages (if found) without warning","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Utilization label cannot be deleted due to its usage in max utilization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilizationLabel","x-genesys-preview":true}},"/api/v2/routing/utilization/labels/{labelId}/agents":{"get":{"tags":["Routing"],"summary":"Get list of agent ids associated with a utilization label","description":"","operationId":"getRoutingUtilizationLabelAgents","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabelAgents","x-genesys-preview":true}},"/api/v2/routing/utilization/labels":{"get":{"tags":["Routing"],"summary":"Get list of utilization labels","description":"","operationId":"getRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order by name","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabels","x-genesys-preview":true},"post":{"tags":["Routing"],"summary":"Create a utilization label","description":"","operationId":"postRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/CreateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"201":{"description":"Utilization label created.","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Invalid utilization label request.","invalid.name":"Invalid utilization code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A utilization label with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"postRoutingUtilizationLabels","x-genesys-preview":true}},"/api/v2/routing/utilization/tags/{tagId}":{"get":{"tags":["Routing"],"summary":"Get details about this utilization tag","description":"","operationId":"getRoutingUtilizationTag","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTag","x-genesys-preview":true},"delete":{"tags":["Routing"],"summary":"Delete an utilization tag","description":"","operationId":"deleteRoutingUtilizationTag","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Remove all tag usages (if found) without warning","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.utilization.tag":"Utilization tag cannot be deleted due to its usage in max utilization."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilizationTag","x-genesys-preview":true}},"/api/v2/routing/utilization/tags/{tagId}/agents":{"get":{"tags":["Routing"],"summary":"Get list of agent ids associated with a utilization tag","description":"","operationId":"getRoutingUtilizationTagAgents","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTagAgents","x-genesys-preview":true}},"/api/v2/routing/utilization/tags":{"get":{"tags":["Routing"],"summary":"Get list of utilization tags","description":"","operationId":"getRoutingUtilizationTags","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order by name","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Utilization tag's name (Wildcard is supported, e.g., 'tag1*')","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTagEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTags","x-genesys-preview":true},"post":{"tags":["Routing"],"summary":"Create an utilization tag","description":"","operationId":"postRoutingUtilizationTags","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UtilizationTag","required":true,"schema":{"$ref":"#/definitions/CreateUtilizationTagRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTag"}},"201":{"description":"Utilization tag created.","schema":{"$ref":"#/definitions/UtilizationTag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid utilization code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"An utilization tag with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.utilization.tag":"Invalid utilization tag request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"postRoutingUtilizationTags","x-genesys-preview":true}},"/api/v2/routing/sms/phonenumbers/alphanumeric":{"post":{"tags":["Routing"],"summary":"Provision an alphanumeric number for SMS","description":"","operationId":"postRoutingSmsPhonenumbersAlphanumeric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsAlphanumericProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number create is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The address is invalid.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phone.number.duplicate":"Phone number has already been created.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbersAlphanumeric","x-genesys-preview":true}},"/api/v2/groups/dynamicsettings/preview":{"post":{"tags":["Groups"],"summary":"Preview the number of users selected for a dynamic group definition query","description":"","operationId":"postGroupsDynamicsettingsPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group query to preview","required":true,"schema":{"$ref":"#/definitions/DynamicGroupQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DynamicGroupQueryPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:view"]},"x-purecloud-method-name":"postGroupsDynamicsettingsPreview","x-genesys-preview":true}},"/api/v2/groups/{groupId}/dynamicsettings":{"get":{"tags":["Groups"],"summary":"Get dynamic group definition","description":"","operationId":"getGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DynamicGroupDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:view"]},"x-purecloud-method-name":"getGroupDynamicsettings","x-genesys-preview":true},"put":{"tags":["Groups"],"summary":"Create / Update dynamic group definition","description":"","operationId":"putGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Create/Update dynamic groups","required":true,"schema":{"$ref":"#/definitions/DynamicGroupQuery"}}],"responses":{"204":{"description":"Success, dynamic group was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Provided request is not valid","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroupDynamicsettings","x-genesys-preview":true},"delete":{"tags":["Groups"],"summary":"Remove dynamic group definition","description":"","operationId":"deleteGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, dynamic group was removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroupDynamicsettings","x-genesys-preview":true}},"/api/v2/settings/executiondata":{"get":{"tags":["Settings"],"summary":"Get the execution history enabled setting.","description":"Get the execution history enabled setting.","operationId":"getSettingsExecutiondata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataGlobalSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["settings:executiondata:view"]},"x-purecloud-method-name":"getSettingsExecutiondata","x-genesys-preview":true},"patch":{"tags":["Settings"],"summary":"Edit the execution history on off setting.","description":"Edit the execution history on off setting.","operationId":"patchSettingsExecutiondata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"New Execution Data Setting","required":true,"schema":{"$ref":"#/definitions/ExecutionDataSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataGlobalSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["settings:executiondata:edit"]},"x-purecloud-method-name":"patchSettingsExecutiondata","x-genesys-preview":true}},"/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get media endpoint statistics event.","description":"","operationId":"getTelephonyProvidersEdgesMediastatisticsConversationCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Identifier of the conversation","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Identifier of the media session","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaStatistics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMediastatisticsConversationCommunication","x-genesys-preview":true}},"/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get media endpoint statistics events.","description":"","operationId":"getTelephonyProvidersEdgesMediastatisticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Identifier of the conversation","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaStatisticsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMediastatisticsConversation","x-genesys-preview":true}},"/api/v2/users/search/conversation/target":{"post":{"tags":["Users","Search"],"summary":"Search users as conversation targets","description":"","operationId":"postUsersSearchConversationTarget","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:target"]},"x-purecloud-method-name":"postUsersSearchConversationTarget","x-genesys-preview":true}},"/api/v2/users/search/queuemembers/manage":{"post":{"tags":["Users","Search"],"summary":"Search manage queue member","description":"","operationId":"postUsersSearchQueuemembersManage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Unable to find any users that match your search criteria"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queueMember:manage","routing:queue:edit"]},"x-purecloud-method-name":"postUsersSearchQueuemembersManage","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a grammar language.","description":"","operationId":"getArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammarLanguage","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Delete specified grammar language","description":"","operationId":"deleteArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguage","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Updates a grammar language","description":"","operationId":"patchArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GrammarLanguageUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"patchArchitectGrammarLanguage","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice":{"post":{"tags":["Architect"],"summary":"Creates a presigned URL for uploading a grammar voice mode file","description":"","operationId":"postArchitectGrammarLanguageFilesVoice","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/GrammarFileUploadRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguageFilesVoice","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Clear the voice mode file for the grammar language if there is one","description":"","operationId":"deleteArchitectGrammarLanguageFilesVoice","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"File was cleared."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguageFilesVoice","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf":{"post":{"tags":["Architect"],"summary":"Creates a presigned URL for uploading a grammar DTMF mode file","description":"","operationId":"postArchitectGrammarLanguageFilesDtmf","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/GrammarFileUploadRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguageFilesDtmf","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Clear the DTMF mode file for the grammar language if there is one","description":"","operationId":"deleteArchitectGrammarLanguageFilesDtmf","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"File was cleared."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguageFilesDtmf","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages":{"post":{"tags":["Architect"],"summary":"Create a new language for a given grammar","description":"","operationId":"postArchitectGrammarLanguages","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/GrammarLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.grammar.language.validate.failed.no.language":"Failed to validate grammar language due to missing or invalid language.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.language.already.exists":"Grammar already has the specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguages","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}":{"get":{"tags":["Architect"],"summary":"Get a grammar","description":"Returns a specified grammar","operationId":"getArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"},{"name":"includeFileUrls","in":"query","description":"Include grammar language file URLs","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Specified grammar not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammar","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Delete a grammar.","description":"","operationId":"deleteArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not find the specified grammar."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:delete"]},"x-purecloud-method-name":"deleteArchitectGrammar","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Updates a grammar","description":"","operationId":"patchArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Grammar"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.validate.failed.missing.name":"Failed to validate grammar due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.grammar.validate.failed.invalid.name.no.alpha":"Failed to validate grammar due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.grammar.validate.failed.invalid.name.spaces":"Failed to validate grammar due to invalid name. Names must not contain leading or trailing whitespaces.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not find the specified grammar."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.already.exists":"A grammar with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"patchArchitectGrammar","x-genesys-preview":true}},"/api/v2/architect/grammars":{"get":{"tags":["Architect"],"summary":"Get a pageable list of grammars, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.","operationId":"getArchitectGrammars","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["description","id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"includeFileUrls","in":"query","description":"Include grammar language file URLs","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammars","x-genesys-preview":true},"post":{"tags":["Architect"],"summary":"Create a new grammar","description":"","operationId":"postArchitectGrammars","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Grammar"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.validate.failed.missing.name":"Failed to validate grammar due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","architect.grammar.validate.failed.name.no.alpha":"Failed to validate grammar due to invalid name. Names must contain at least one alphanumeric character.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.grammar.validate.failed.invalid.name":"Failed to validate grammar due to invalid name. grammar names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.grammar.validate.failed":"Failed to validate grammar.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.exceeded.max.amount":"Could not create grammar since the maximum number of grammars already exist.","architect.grammar.already.exists":"A grammar with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:add"]},"x-purecloud-method-name":"postArchitectGrammars","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a workbin","description":"","operationId":"getTaskmanagementWorkbinVersions","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a workbin","description":"","operationId":"getTaskmanagementWorkbinVersion","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Workbin version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a workbin's attribute change history","description":"","operationId":"getTaskmanagementWorkbinHistory","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinHistory","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/query":{"post":{"tags":["Task Management"],"summary":"Query for workitems","description":"This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.","operationId":"postTaskmanagementWorkitemsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WorkitemQueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorkitemQueryPostRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemPostQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.query.missing.workitem.filter":"Missing mandatory filters","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.query.missing.filters":"Missing filters.","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.attributes.missing.expands":"Invalid value for attributes. 'attributes' list must contain all fields specified in 'expands' list."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Not found error"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsQuery","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a workitem","description":"","operationId":"getTaskmanagementWorkitemVersions","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a workitem","description":"","operationId":"getTaskmanagementWorkitemVersion","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Workitem version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a workitem's attribute change history","description":"","operationId":"getTaskmanagementWorkitemHistory","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemHistory","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a worktype","description":"","operationId":"getTaskmanagementWorktypeVersions","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a worktype","description":"","operationId":"getTaskmanagementWorktypeVersion","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Worktype version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a worktype's attribute change history","description":"","operationId":"getTaskmanagementWorktypeHistory","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeHistory","x-genesys-preview":true}}},"securityDefinitions":{"PureCloud OAuth":{"type":"oauth2","authorizationUrl":"https://login.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}},"Guest Chat JWT":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"BatchEventResponse":{"type":"object","properties":{"errors":{"type":"array","description":"A list of validation or server errors that occurred for posted events.","items":{"$ref":"#/definitions/EventError"}}}},"EventError":{"type":"object","properties":{"eventId":{"type":"string","description":"The eventId (V4 UUID) for the event that encountered an error."},"message":{"type":"string","description":"A message describing the error."},"retryable":{"type":"boolean","description":"The event for this eventId can be resubmitted if this value is true."}}},"AudioState":{"type":"object","properties":{"canHear":{"type":"boolean","description":"Indicates that this communication's audio allows its participant to hear others."},"canSpeak":{"type":"boolean","description":"Indicates that this communication's audio allows others to hear this participant."}}},"AudioUpdatedEvent":{"type":"object","required":["audioState","communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"audioState":{"description":"The updated audioState for the target communication.","$ref":"#/definitions/AudioState"}}},"BatchConversationEventRequest":{"type":"object","properties":{"endTransferEvents":{"type":"array","description":"Voice - EndTransfer events for this batch","items":{"$ref":"#/definitions/EndTransferEvent"}},"phoneTransferEvents":{"type":"array","description":"Voice - PhoneTransfer events for this batch","items":{"$ref":"#/definitions/PhoneTransferEvent"}},"progressTransferEvents":{"type":"array","description":"Voice - ProgressTransfer events for this batch","items":{"$ref":"#/definitions/ProgressTransferEvent"}},"routingTransferEvents":{"type":"array","description":"Voice - RoutingTransfer events for this batch","items":{"$ref":"#/definitions/RoutingTransferEvent"}},"userTransferEvents":{"type":"array","description":"Voice - UserTransfer events for this batch","items":{"$ref":"#/definitions/UserTransferEvent"}},"communicationAnsweredEvents":{"type":"array","description":"Voice - CommunicationAnswered events for this batch","items":{"$ref":"#/definitions/CommunicationAnsweredEvent"}},"communicationDispositionAppliedEvents":{"type":"array","description":"Voice - CommunicationDispositionApplied events for this batch","items":{"$ref":"#/definitions/CommunicationDispositionAppliedEvent"}},"holdUpdatedEvents":{"type":"array","description":"Voice - HoldUpdated events for this batch","items":{"$ref":"#/definitions/HoldUpdatedEvent"}},"externalEstablishedEvents":{"type":"array","description":"Voice - ExternalEstablished events for this batch","items":{"$ref":"#/definitions/ExternalEstablishedEvent"}},"ivrEstablishedEvents":{"type":"array","description":"Voice - IvrEstablished events for this batch","items":{"$ref":"#/definitions/IvrEstablishedEvent"}},"phoneEstablishedEvents":{"type":"array","description":"Voice - PhoneEstablished events for this batch","items":{"$ref":"#/definitions/PhoneEstablishedEvent"}},"routingEstablishedEvents":{"type":"array","description":"Voice - RoutingEstablished events for this batch","items":{"$ref":"#/definitions/RoutingEstablishedEvent"}},"userEstablishedEvents":{"type":"array","description":"Voice - UserEstablished events for this batch","items":{"$ref":"#/definitions/UserEstablishedEvent"}},"audioUpdatedEvents":{"type":"array","description":"Voice - AudioUpdated events for this batch","items":{"$ref":"#/definitions/AudioUpdatedEvent"}},"communicationEndedEvents":{"type":"array","description":"Voice - CommunicationEnded events for this batch","items":{"$ref":"#/definitions/CommunicationEndedEvent"}},"consultTransferEvents":{"type":"array","description":"Voice - ConsultTransfer events for this batch","items":{"$ref":"#/definitions/ConsultTransferEvent"}},"progressConsultTransferEvents":{"type":"array","description":"Voice - ProgressConsultTransfer events for this batch","items":{"$ref":"#/definitions/ProgressConsultTransferEvent"}},"endConsultTransferEvents":{"type":"array","description":"Voice - EndConsultTransfer events for this batch","items":{"$ref":"#/definitions/EndConsultTransferEvent"}}},"description":"A maximum of 100 events are allowed per request"},"CommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"CommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"CommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Error","Peer","Self","System","Transfer","TransferACD","TransferConference","TransferConsult","TransferUser"]},"destinationConversationId":{"type":"string","description":"The id (V4 UUID) of the conversation that the communication is being moved to when conversations are merged."}}},"ConsultTransferEvent":{"type":"object","required":["conversationId","destinationCommunicationId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."}}},"EmailBeginTransmittingEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."}}},"EmailCommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"EmailCommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"EmailCommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Unknown","Self","Peer","System","Error","Spam","Transfer","TransferACD","TransferUser"]}}},"EmailCommunicationRepliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."}}},"EmailEndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"EmailExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"displayName":{"type":"string","description":"A name for the participant if it is available for this conversation."},"includeMessage":{"type":"boolean","description":"Indicates that established communication has an initial email. If true, the initial messagesSent value will be initialized to 1."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailFlowEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailHoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"EmailInitialConfiguration":{"type":"object","required":["from","to"],"properties":{"to":{"type":"string","description":"An email address that this email is to."},"from":{"type":"string","description":"An email address that this email is from."},"cc":{"type":"array","description":"An email addresses that this email is carbon copied to.","items":{"type":"string"}},"bcc":{"type":"array","description":"An email addresses that this email is blind carbon copied to.","items":{"type":"string"}},"subject":{"type":"string","description":"The subject for this email."},"previousEmailId":{"type":"string","description":"UUID identifying the most recent previous email communication ID from the same participant on this email conversation. Will be null if this is a new participant."},"held":{"type":"boolean","description":"Indicates that this communication's initial state is held."},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"EmailProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"EmailRoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"queueId":{"type":"string","description":"The id of the queue that is routing this conversation."},"skillIds":{"type":"array","description":"The unique identifiers for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier for the language that should be used to determine the destination for the conversation."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailRoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"EmailUserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"userId":{"type":"string","description":"A unique Id (V4 UUID) identifying the user this communication belongs to."},"queueId":{"type":"string","description":"A unique Id (V4 UUID) identifying the queue that the user is emailing on behalf of. Applies to outbound emails only."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailUserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"EndConsultTransferEvent":{"type":"object","required":["conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"}}},"EndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"ExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"aniName":{"type":"string","description":"The automatic number identification name if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"dnisName":{"type":"string","description":"The dialed number identification name if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"HoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"InitialConfiguration":{"type":"object","properties":{"audioState":{"description":"Indicates the initial audio state for the communication.","$ref":"#/definitions/AudioState"},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"recordingActive":{"type":"boolean","description":"Indicates whether recording is active for this communication at creation."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"IvrEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"ivrPhoneNumber":{"type":"string","description":"The phone number for this IVR, if any is known"},"ivrName":{"type":"string","description":"A displayable name for this IVR, if any is known."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingCommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"MessagingCommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"MessagingCommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Unknown","Self","Peer","System","Error","Transfer","TransferACD","TransferUser"]}}},"MessagingEndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"MessagingExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"displayName":{"type":"string","description":"A name for the participant if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingFlowEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingHoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"MessagingInitialConfiguration":{"type":"object","required":["fromAddress","toAddress"],"properties":{"toAddress":{"type":"string","description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended."},"fromAddress":{"type":"string","description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended."},"messageType":{"type":"string","description":"The type of message platform from which the message originated.","enum":["Sms","Twitter","Facebook","Line","WhatsApp","WebMessage","Open","Instagram","Unknown"]},"held":{"type":"boolean","description":"Indicates that this communication's initial state is held."},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"MessagingProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"MessagingRoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"queueId":{"type":"string","description":"The id of the queue that is routing this conversation."},"skillIds":{"type":"array","description":"The unique identifiers for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier for the language that should be used to determine the destination for the conversation."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingRoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"MessagingUserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"userId":{"type":"string","description":"A unique Id (V4 UUID) identifying the user this communication belongs to."},"queueId":{"type":"string","description":"A unique Id (V4 UUID) identifying the queue that the user is messaging on behalf of. Applies to outbound messages only."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingUserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"PhoneEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"The phone number for this phone."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"PhoneTransferEvent":{"type":"object","required":["commandId","conversationId","destinationPhoneNumber","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationPhoneNumber":{"type":"string","description":"The desired destination phone number that the object communication should be transferred to."}}},"ProgressConsultTransferEvent":{"type":"object","required":["conversationId","destinationCommunicationId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."}}},"ProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"RoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"Identifies the phone number used to reach this queue if it is different from the information that would be accessed by queueId."},"queueId":{"type":"string","description":"The id (V4 UUID) of the queue that is routing this conversation."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"RoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"SourceConfiguration":{"type":"object","required":["interactionId","sourceId"],"properties":{"sourceId":{"type":"string","description":"Identifies the external platform that is the source of the conversation."},"interactionId":{"type":"string","description":"The customer's unique external identifier associated with the conversation that comes from the external platform."},"tagId":{"type":"string","description":"The customer's external identifier or tag associated with the conversation. If set, it will be used to tag the conversation."}}},"UserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"Identifies the phone number used to reach this user if it is different from the information that would be accessed by userId."},"userId":{"type":"string","description":"The userId (V4 UUID) for the user this communication belongs to."},"stationId":{"type":"string","description":"A Station ID (V4 UUID) that identifies the station being used if the user is using a station and the stationId is known."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"queueId":{"type":"string","description":"The id (V4 UUID) of the queue that the user is calling on behalf of. Applies to outbound calls only."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"UserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"BatchUserRoutingStatusEventRequest":{"type":"object","properties":{"userRoutingStatusEvents":{"type":"array","description":"UserRoutingStatus events for this batch","items":{"$ref":"#/definitions/UserRoutingStatusEvent"}}},"description":"A maximum of 100 events are allowed per request"},"UserRoutingStatusEvent":{"type":"object","required":["agentId","eventDateTime","eventId","sourceId","status"],"properties":{"eventId":{"type":"string","description":"A unique (UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A timestamp as epoch representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentId":{"type":"string","description":"Unique identifier of the agent."},"status":{"type":"string","description":"The agent's current routing status.","enum":["OffQueue","Idle","Interacting","Communicating","NotResponding"]},"sourceId":{"type":"string","description":"The agent's source platform Id."}}},"BatchUserPresenceEventRequest":{"type":"object","properties":{"userPresenceEvents":{"type":"array","description":"UserPresence events for this batch","items":{"$ref":"#/definitions/UserPresenceEvent"}}},"description":"A maximum of 100 events are allowed per request"},"UserPresenceEvent":{"type":"object","required":["eventDateTime","eventId","sourceId","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string","description":"The User ID of the user associated with this UserPresence"},"sourceId":{"type":"string","description":"The id (V4 UUID) of the presence source being updated"},"presenceDefinitionId":{"type":"string","description":"The id (UUID) of the presence definition that the user presence is associated with"},"message":{"type":"string","description":"The message associated with the presence"}}},"AuthzDivision":{"type":"object","required":["description"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A helpful description for the division."},"homeDivision":{"type":"boolean","description":"A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update.","readOnly":true},"objectCounts":{"type":"object","description":"A count of objects in this division, grouped by type.","readOnly":true,"additionalProperties":{"type":"integer","format":"int64"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzDivisionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Entity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"NamedEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true}}},"OrgOAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organization":{"description":"The oauth client's organization.","readOnly":true,"$ref":"#/definitions/NamedEntity"}}},"RoleDivision":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"Role to be associated with the given division which forms a grant"},"divisionId":{"type":"string","description":"Division associated with the given role which forms a grant"}}},"TokenInfo":{"type":"object","properties":{"organization":{"description":"The current organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"homeOrganization":{"description":"The token's home organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"authorizedScope":{"type":"array","description":"The list of scopes authorized for the OAuth client","readOnly":true,"items":{"type":"string"}},"clonedUser":{"description":"Only present when a user is a clone of trustee user in the trustor org.","readOnly":true,"$ref":"#/definitions/TokenInfoClonedUser"},"OAuthClient":{"$ref":"#/definitions/OrgOAuthClient"}}},"TokenInfoClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"User id of the original native user","readOnly":true},"organization":{"description":"Organization of the original native user","readOnly":true,"$ref":"#/definitions/Entity"}}},"ActiveAlertCount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of active alerts for a user."}}},"AddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Biography":{"type":"object","properties":{"biography":{"type":"string","description":"Personal detailed description"},"interests":{"type":"array","items":{"type":"string"}},"hobbies":{"type":"array","items":{"type":"string"}},"spouse":{"type":"string"},"education":{"type":"array","description":"User education details","items":{"$ref":"#/definitions/Education"}}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN","OTHER"]},"extension":{"type":"string","description":"Use internal extension instead of address. Mutually exclusive with the address field."},"countryCode":{"type":"string"},"integration":{"type":"string","example":"microsoftteams","description":"Integration tag value if this number is associated with an external integration."}}},"Division":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"Education":{"type":"object","properties":{"school":{"type":"string"},"fieldOfStudy":{"type":"string"},"notes":{"type":"string","description":"Notes about education has a 2000 character limit"},"dateStart":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"EmployerInfo":{"type":"object","properties":{"officialName":{"type":"string"},"employeeId":{"type":"string"},"employeeType":{"type":"string"},"dateHire":{"type":"string"}}},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"locations":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupContact":{"type":"object","required":["address","mediaType","type"],"properties":{"address":{"type":"string","description":"Phone number for this contact type"},"extension":{"type":"string","description":"Extension is set if the number is e164 valid"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"type":{"type":"string","description":"Contact type of the address","enum":["GROUPRING","GROUPPHONE"]},"mediaType":{"type":"string","description":"Media type of the address","enum":["PHONE"]}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email","callback","message"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read."},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the location"},"floorplanId":{"type":"string","description":"Unique identifier for the location floorplan image","readOnly":true},"coordinates":{"type":"object","description":"Users coordinates on the floorplan. Only used when floorplanImage is set","additionalProperties":{"type":"number","format":"double"}},"notes":{"type":"string","description":"Optional description on the users location"},"locationDefinition":{"$ref":"#/definitions/LocationDefinition"}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"LocationAddressVerificationDetails":{"type":"object","properties":{"status":{"type":"string","description":"Status of address verification process","enum":["Pending","InProgress","Retry","Complete","Failed"]},"dateFinished":{"type":"string","format":"date-time","description":"Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateStarted":{"type":"string","format":"date-time","description":"Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"service":{"type":"string","example":"smartystreets-us","description":"Third party service used for address verification"}}},"LocationDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactUser":{"description":"Site contact for the location entity","$ref":"#/definitions/AddressableEntityRef"},"emergencyNumber":{"description":"Emergency number for the location entity","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"$ref":"#/definitions/LocationAddress"},"state":{"type":"string","description":"Current state of the location entity","enum":["active","deleted"]},"notes":{"type":"string","description":"Notes for the location entity"},"version":{"type":"integer","format":"int32","description":"Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response"},"path":{"type":"array","description":"A list of ancestor IDs in order","readOnly":true,"items":{"type":"string"}},"profileImage":{"type":"array","description":"Profile image of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"floorplanImage":{"type":"array","description":"Floorplan images of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"addressVerificationDetails":{"description":"Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter","readOnly":true,"$ref":"#/definitions/LocationAddressVerificationDetails"},"addressVerified":{"type":"boolean","description":"Boolean field which states if the address has been verified as an actual address","readOnly":true},"addressStored":{"type":"boolean","description":"Boolean field which states if the address has been stored for E911","readOnly":true},"images":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"LocationImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"OAuthLastTokenIssued":{"type":"object","properties":{"dateIssued":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean"},"indefinite":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PresenceDefinition":{"type":"object","properties":{"id":{"type":"string","description":"description"},"systemPresence":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]},"value":{"type":"string"}}},"ResourcePermissionPolicy":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string","description":"The userId of the agent"},"status":{"type":"string","description":"Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist.","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"startTime":{"type":"string","format":"date-time","description":"The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Team":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The team name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Team information."},"dateCreated":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members in a team","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"User":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"unusedRoles":{"type":"array","description":"A collection of the roles the user is not using","readOnly":true,"items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"message":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"Represents the ID of a registered source"},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing language.","enum":["active","inactive","deleted"]},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id."},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}},"webRtcCallAppearances":{"type":"integer","format":"int32","description":"The number of call appearances on the station.","readOnly":true}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"WorkPlanBidRanks":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlanBiddingPerformance":{"type":"integer","format":"int32","description":"Work plan bidding agent performance ranking. The range of values is between 0 and 9999."},"biddingTieBreaker":{"type":"string","description":"Custom agent ranking metric that some customers can use."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WritableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread."}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email","callback","message"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of unread alerts for a specific rule type."}}},"ActionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ActionAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ActionAggregateDataContainer"}}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"AggregateViewData":{"type":"object","properties":{"name":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}},"views":{"type":"array","items":{"$ref":"#/definitions/AggregateViewData"}}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"countNegative":{"type":"integer","format":"int64"},"countPositive":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"},"p95":{"type":"integer","format":"int64"},"p99":{"type":"integer","format":"int64"}}},"ActionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ActionAggregateQueryPredicate"}}}},"ActionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ActionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ActionAggregateQueryPredicate"}}}},"ActionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ActionAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ActionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tTotalExecution"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ActionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"ActionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tTotalExecution"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"AsyncQueryResponse":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results."}}},"AsyncQueryStatus":{"type":"object","properties":{"state":{"type":"string","description":"The current state of the asynchronous query","enum":["QUEUED","PENDING","FAILED","CANCELLED","FULFILLED","EXPIRED"]},"errorMessage":{"type":"string","description":"The error associated with the current query, if the state is FAILED"},"expirationDate":{"type":"string","format":"date-time","description":"The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"submissionDate":{"type":"string","format":"date-time","description":"The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionDate":{"type":"string","format":"date-time","description":"The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BotAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"BotAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BotAggregateDataContainer"}}}},"BotAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/BotAggregateQueryPredicate"}}}},"BotAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/BotAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/BotAggregateQueryPredicate"}}}},"BotAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"BotAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/BotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/BotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"BotAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"ConversationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ConversationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}}}},"ConversationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","canonicalExternalContactId","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ConversationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"ConversationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"QueryDivision":{"type":"object","properties":{}},"ConversationActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/ConversationActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/ConversationActivityEntityData"}}}},"ConversationActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metric":{"type":"string","description":"Activity metric","enum":["oAlerting","oInteracting","oWaiting"]},"activeRouting":{"type":"string","description":"Active routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"userId":{"type":"string","description":"Unique identifier for the user"},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/ConversationActivityScoredAgent"}}}},"ConversationActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oAlerting","oInteracting","oWaiting"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"ConversationActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ConversationActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}}},"ConversationActivityScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The subscription id"},"topic":{"type":"string","description":"Notification topic"}}},"ConversationActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/ConversationActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"ConversationActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationActivityQueryPredicate"}}}},"ConversationActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationActivityQueryPredicate"}}}},"ConversationActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oAlerting","oInteracting","oWaiting"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"ConversationActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"AnalyticsAgentGroup":{"type":"object","properties":{"agentGroupId":{"type":"string","description":"Conditional group routing agent group identifier"},"agentGroupType":{"type":"string","description":"Conditional group routing agent group type","enum":["Group","SkillGroup","Team"]}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"totalHits":{"type":"integer","format":"int32"}}},"AnalyticsConversationSegment":{"type":"object","properties":{"audioMuted":{"type":"boolean","description":"Flag indicating if audio is muted or not (true/false)"},"conference":{"type":"boolean","description":"Indicates whether the segment was a conference"},"destinationConversationId":{"type":"string","description":"The unique identifier of a new conversation when a conversation is ended for a conference"},"destinationSessionId":{"type":"string","description":"The unique identifier of a new session when a session is ended for a conference"},"disconnectType":{"type":"string","description":"The session disconnect type","enum":["client","conferenceTransfer","consultTransfer","dndEndpoint","dndTransfer","endpoint","error","forwardTransfer","noAnswerTransfer","notAvailableTransfer","other","peer","spam","system","timeout","transfer","transportFailure","uncallable"]},"errorCode":{"type":"string","description":"A code corresponding to the error that occurred"},"groupId":{"type":"string","description":"Unique identifier for a PureCloud group"},"q850ResponseCodes":{"type":"array","description":"Q.850 response code(s)","items":{"type":"integer","format":"int64"}},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutingUserIds":{"type":"array","description":"Unique identifier(s) for agent(s) requested for an interaction","items":{"type":"string"}},"segmentEnd":{"type":"string","format":"date-time","description":"The end time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentStart":{"type":"string","format":"date-time","description":"The start time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentType":{"type":"string","description":"The activity that takes place in the segment, such as hold or interact","enum":["alert","barging","callback","coaching","contacting","converting","delay","dialing","hold","interact","ivr","monitoring","parked","scheduled","sharing","system","transmitting","unknown","uploading","voicemail","wrapup"]},"sipResponseCodes":{"type":"array","description":"SIP response code(s)","items":{"type":"integer","format":"int64"}},"sourceConversationId":{"type":"string","description":"The unique identifier of the previous conversation when a new conversation is created for a conference"},"sourceSessionId":{"type":"string","description":"The unique identifier of the previous session when a new session is created for a conference"},"subject":{"type":"string","description":"The subject for the initial email that started this conversation"},"videoMuted":{"type":"boolean","description":"Flag indicating if video is muted/paused or not (true/false)"},"wrapUpCode":{"type":"string","description":"Wrap up code"},"wrapUpNote":{"type":"string","description":"Note entered by an agent during after-call work"},"wrapUpTags":{"type":"array","description":"Tag(s) assigned during after-call work","items":{"type":"string"}},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}},"properties":{"type":"array","description":"Additional segment properties","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"AnalyticsConversationWithoutAttributes":{"type":"object","properties":{"conferenceStart":{"type":"string","format":"date-time","description":"The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationInitiator":{"type":"string","description":"Indicates the participant purpose of the participant initiating a message conversation","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"conversationStart":{"type":"string","format":"date-time","description":"The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"customerParticipation":{"type":"boolean","description":"Indicates a messaging conversation in which the customer participated by sending at least one message"},"divisionIds":{"type":"array","description":"Identifier(s) of division(s) associated with a conversation","items":{"type":"string"}},"externalTag":{"type":"string","description":"External tag for the conversation"},"knowledgeBaseIds":{"type":"array","description":"The unique identifier(s) of the knowledge base(s) used","items":{"type":"string"}},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"]},"selfServed":{"type":"boolean","description":"Indicates whether all flow sessions were self serviced"},"evaluations":{"type":"array","description":"Evaluations associated with this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys associated with this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions associated with this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipantWithoutAttributes"}}}},"AnalyticsEvaluation":{"type":"object","properties":{"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable"},"assigneeId":{"type":"string","description":"UserId of the assignee"},"calibrationId":{"type":"string","description":"The calibration ID used for the purpose of training evaluators"},"contextId":{"type":"string","description":"A unique identifier for an evaluation form, regardless of version"},"deleted":{"type":"boolean","description":"Whether the evaluation has been deleted"},"evaluationId":{"type":"string","description":"Unique identifier for the evaluation"},"evaluationStatus":{"type":"string","description":"Status of evaluation","enum":["Finished","InProgress","InReview","Pending","Retracted"]},"evaluatorId":{"type":"string","description":"A unique identifier of the user who evaluated the interaction"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"formId":{"type":"string","description":"ID of the evaluation form used"},"formName":{"type":"string","description":"Name of the evaluation form used"},"queueId":{"type":"string","description":"The ID of the associated queue"},"released":{"type":"boolean","description":"Whether the evaluation has been released"},"rescored":{"type":"boolean","description":"Whether the evaluation has been rescored at least once"},"userId":{"type":"string","description":"ID of the agent the evaluation was performed against"},"oTotalCriticalScore":{"type":"integer","format":"int64"},"oTotalScore":{"type":"integer","format":"int64"}}},"AnalyticsFlow":{"type":"object","properties":{"endingLanguage":{"type":"string","description":"Flow ending language, e.g. en-us"},"entryReason":{"type":"string","description":"The particular entry reason for this flow, e.g. an address, userId, or flowId"},"entryType":{"type":"string","description":"The entry type for this flow, e.g. dnis, dialer, agent, flow, or direct","enum":["agent","direct","dnis","flow","outbound"]},"exitReason":{"type":"string","description":"The exit reason for this flow, e.g. DISCONNECT"},"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowName":{"type":"string","description":"The name of this flow at the time of flow execution"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"flowVersion":{"type":"string","description":"The version of this flow"},"issuedCallback":{"type":"boolean","description":"Flag indicating whether the flow issued a callback"},"recognitionFailureReason":{"type":"string","description":"The recognition failure reason causing to exit/disconnect"},"startingLanguage":{"type":"string","description":"Flow starting language, e.g. en-us"},"transferTargetAddress":{"type":"string","description":"The address of a flow transfer target, e.g. a phone number, an email address, or a queueId"},"transferTargetName":{"type":"string","description":"The name of a flow transfer target"},"transferType":{"type":"string","description":"The type of transfer for flows that ended with a transfer"},"outcomes":{"type":"array","description":"Flow outcomes","items":{"$ref":"#/definitions/AnalyticsFlowOutcome"}}}},"AnalyticsFlowOutcome":{"type":"object","properties":{"flowOutcome":{"type":"string","description":"Combination of unique flow outcome identifier and its value separated by colon"},"flowOutcomeEndTimestamp":{"type":"string","format":"date-time","description":"The outcome ending timestamp in ISO 8601 format. This may be null if the outcome did not succeed."},"flowOutcomeId":{"type":"string","description":"Unique identifier of a flow outcome"},"flowOutcomeStartTimestamp":{"type":"string","format":"date-time","description":"The outcome starting timestamp in ISO 8601 format"},"flowOutcomeValue":{"type":"string","description":"Flow outcome value, e.g. SUCCESS"}}},"AnalyticsMediaEndpointStat":{"type":"object","properties":{"codecs":{"type":"array","description":"The MIME type(s) of the audio encodings used by the audio streams belonging to this endpoint","items":{"type":"string"}},"discardedPackets":{"type":"integer","format":"int64","description":"The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint"},"duplicatePackets":{"type":"integer","format":"int64","description":"The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"invalidPackets":{"type":"integer","format":"int64","description":"The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint"},"maxLatencyMs":{"type":"integer","format":"int64","description":"The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds"},"minMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this endpoint"},"minRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this endpoint"},"overrunPackets":{"type":"integer","format":"int64","description":"The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)"},"receivedPackets":{"type":"integer","format":"int64","description":"The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)"},"underrunPackets":{"type":"integer","format":"int64","description":"The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)"}}},"AnalyticsParticipantWithoutAttributes":{"type":"object","properties":{"externalContactId":{"type":"string","description":"External contact identifier"},"externalOrganizationId":{"type":"string","description":"External organization identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"]},"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"purpose":{"type":"string","description":"The participant's purpose","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"AnalyticsProperty":{"type":"object","properties":{"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property."},"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"]},"value":{"type":"string","description":"What property value to match against"}}},"AnalyticsProposedAgent":{"type":"object","properties":{"agentRank":{"type":"integer","format":"int32","description":"Proposed agent rank for this conversation from predictive routing (lower is better)"},"proposedAgentId":{"type":"string","description":"Unique identifier for the agent that was proposed by predictive routing"}}},"AnalyticsResolution":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"The ID of the last queue on which the conversation was handled."},"userId":{"type":"string","description":"The ID of the last user who handled the conversation."},"nNextContactAvoided":{"type":"integer","format":"int64"}}},"AnalyticsScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"AnalyticsSession":{"type":"object","properties":{"activeSkillIds":{"type":"array","description":"ID(s) of Skill(s) that are active on the conversation","items":{"type":"string"}},"acwSkipped":{"type":"boolean","description":"Marker for an agent that skipped after call work"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressOther":{"type":"string","description":"The email address for the participant on the other side of the email conversation"},"addressSelf":{"type":"string","description":"The email address for the participant on this side of the email conversation"},"addressTo":{"type":"string","description":"The address receiving an action"},"agentAssistantId":{"type":"string","description":"Unique identifier of the active virtual agent assistant"},"agentBullseyeRing":{"type":"integer","format":"int32","description":"Bullseye ring of the targeted agent"},"agentOwned":{"type":"boolean","description":"Flag indicating an agent-owned callback"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"assignerId":{"type":"string","description":"ID of the user that manually assigned a conversation"},"authenticated":{"type":"boolean","description":"Flag that indicates that the identity of the customer has been asserted as verified by the provider."},"bargedParticipantId":{"type":"string","description":"The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation)"},"bcc":{"type":"array","description":"Blind carbon copy email address(es)","items":{"type":"string"}},"callbackNumbers":{"type":"array","description":"Callback phone number(s)","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackUserName":{"type":"string","description":"The name of the user requesting a call back"},"cc":{"type":"array","description":"Carbon copy email address(es)","items":{"type":"string"}},"cleared":{"type":"boolean","description":"Flag that indicates that the conversation has been cleared by the customer"},"coachedParticipantId":{"type":"string","description":"The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation)"},"cobrowseRole":{"type":"string","description":"Describes side of the cobrowse (sharer or viewer)"},"cobrowseRoomId":{"type":"string","description":"A unique identifier for a PureCloud cobrowse room"},"deliveryStatus":{"type":"string","description":"The email or SMS delivery status","enum":["DeliveryFailed","DeliverySuccess","Failed","Published","Queued","Read","Received","Sent"]},"deliveryStatusChangeDate":{"type":"string","format":"date-time","description":"Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"destinationAddresses":{"type":"array","description":"Destination address(es) of transfers or consults","items":{"type":"string"}},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dispositionAnalyzer":{"type":"string","description":"(Dialer) Analyzer (for example speech.person)"},"dispositionName":{"type":"string","description":"(Dialer) Result of the analysis (for example disposition.classification.callable.machine)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"edgeId":{"type":"string","description":"Unique identifier of the edge device"},"eligibleAgentCounts":{"type":"array","description":"Number of eligible agents for each predictive routing attempt","items":{"type":"integer","format":"int32"}},"extendedDeliveryStatus":{"type":"string","description":"Extended delivery status"},"flowInType":{"type":"string","description":"Type of flow in that occurred when entering ACD."},"flowOutType":{"type":"string","description":"Type of flow out that occurred when emitting tFlowOut."},"journeyActionId":{"type":"string","description":"Identifier of the journey action."},"journeyActionMapId":{"type":"string","description":"Identifier of the journey action map that triggered the action."},"journeyActionMapVersion":{"type":"integer","format":"int32","description":"Version of the journey action map that triggered the action."},"journeyCustomerId":{"type":"string","description":"Primary identifier of the journey customer in the source where the activities originate from."},"journeyCustomerIdType":{"type":"string","description":"Type of primary identifier of the journey customer (e.g. cookie)."},"journeyCustomerSessionId":{"type":"string","description":"Unique identifier of the journey session."},"journeyCustomerSessionIdType":{"type":"string","description":"Type or category of journey sessions (e.g. web, ticket, delivery, atm)."},"mediaBridgeId":{"type":"string","description":"Media bridge ID for the conference session consistent across all participants"},"mediaCount":{"type":"integer","format":"int32","description":"Count of any media (images, files, etc) included in this session"},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"messageType":{"type":"string","description":"Message type for messaging services. E.g.: sms, facebook, twitter, line"},"monitoredParticipantId":{"type":"string","description":"The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation)"},"outboundCampaignId":{"type":"string","description":"(Dialer) Unique identifier of the outbound campaign"},"outboundContactId":{"type":"string","description":"(Dialer) Unique identifier of the contact"},"outboundContactListId":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"peerId":{"type":"string","description":"This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session."},"protocolCallId":{"type":"string","description":"The original voice protocol call ID, e.g. a SIP call ID"},"provider":{"type":"string","description":"The source provider for the communication."},"recording":{"type":"boolean","description":"Flag determining if an audio recording was started or not"},"remote":{"type":"string","description":"Name, phone number, or email address of the remote party."},"remoteNameDisplayable":{"type":"string","description":"Unique identifier for the remote party"},"removedSkillIds":{"type":"array","description":"ID(s) of Skill(s) that have been removed by bullseye routing","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"roomId":{"type":"string","description":"Unique identifier for the room"},"routingRing":{"type":"integer","format":"int32","description":"Routing ring for bullseye or preferred agent routing"},"routingRule":{"type":"string","description":"Routing rule for preferred, conditional and predictive routing type"},"routingRuleType":{"type":"string","description":"Routing rule type","enum":["Bullseye","Conditional","Predictive","Preferred"]},"screenShareAddressSelf":{"type":"string","description":"Direct ScreenShare address"},"screenShareRoomId":{"type":"string","description":"A unique identifier for a PureCloud ScreenShare room"},"scriptId":{"type":"string","description":"A unique identifier for a script"},"selectedAgentId":{"type":"string","description":"Selected agent ID"},"selectedAgentRank":{"type":"integer","format":"int32","description":"Selected agent GPR rank"},"sessionDnis":{"type":"string","description":"Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"sharingScreen":{"type":"boolean","description":"Flag determining if screenShare is started or not (true/false)"},"skipEnabled":{"type":"boolean","description":"(Dialer) Whether the agent can skip the dialer contact"},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before PureCloud begins the call for a call back (0 disables automatic calling)"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"videoAddressSelf":{"type":"string","description":"Direct Video address"},"videoRoomId":{"type":"string","description":"A unique identifier for a PureCloud video room"},"waitingInteractionCounts":{"type":"array","description":"Number of waiting interactions for each predictive routing attempt","items":{"type":"integer","format":"int32"}},"agentGroups":{"type":"array","description":"Conditional group routing agent groups","items":{"$ref":"#/definitions/AnalyticsAgentGroup"}},"proposedAgents":{"type":"array","description":"Proposed agents","items":{"$ref":"#/definitions/AnalyticsProposedAgent"}},"mediaEndpointStats":{"type":"array","description":"MediaEndpointStats associated with this session","items":{"$ref":"#/definitions/AnalyticsMediaEndpointStat"}},"flow":{"description":"IVR flow execution associated with this session","$ref":"#/definitions/AnalyticsFlow"},"metrics":{"type":"array","description":"List of metrics for this session","items":{"$ref":"#/definitions/AnalyticsSessionMetric"}},"segments":{"type":"array","description":"List of segments for this session","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}}}},"AnalyticsSessionMetric":{"type":"object","properties":{"emitDate":{"type":"string","format":"date-time","description":"Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"Unique name of this metric"},"value":{"type":"integer","format":"int64","description":"The metric value"}}},"AnalyticsSurvey":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"The ID of the associated queue"},"surveyCompletedDate":{"type":"string","format":"date-time","description":"Completion datetime of the survey in ISO 8601 format"},"surveyFormContextId":{"type":"string","description":"Unique identifier for the survey form, regardless of version"},"surveyFormId":{"type":"string","description":"ID of the survey form used"},"surveyFormName":{"type":"string","description":"Name of the survey form used"},"surveyId":{"type":"string","description":"ID of the survey"},"surveyPartialResponse":{"type":"boolean","description":"Whether the survey was completed with any required questions unanswered."},"surveyPromoterScore":{"type":"integer","format":"int32","description":"Score of the survey used with NPS"},"surveyStatus":{"type":"string","description":"The status of the survey"},"surveyType":{"type":"string","description":"The type of the survey","enum":["Web","Voice"]},"userId":{"type":"string","description":"ID of the agent the survey was performed against"},"oSurveyTotalScore":{"type":"integer","format":"int64"}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"ConversationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationEnd","conversationId","conversationInitiator","conversationStart","customerParticipation","divisionId","externalTag","mediaStatsMinConversationMos","originatingDirection"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oFlowMilestone","oMediaCount","oMessageTurn","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tConversationDuration","tDialing","tFirstConnect","tFirstDial","tFlow","tFlowDisconnect","tFlowExit","tFlowOut","tFlowOutcome","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"ConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"EvaluationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","deleted","evaluationId","evaluationStatus","evaluatorId","eventTime","formId","formName","queueId","released","rescored","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oTotalCriticalScore","oTotalScore"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"PagingSpec":{"type":"object","required":["pageNumber","pageSize"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"ResolutionDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nNextContactAvoided"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for metric predicates"},"range":{"description":"Right hand side for metric predicates","$ref":"#/definitions/NumericRange"}}},"SegmentDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SegmentDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentOwned","ani","authenticated","bargedParticipantId","callbackNumber","callbackScheduledTime","canonicalExternalContactId","cleared","coachedParticipantId","conference","deliveryStatus","destinationAddress","destinationConversationId","direction","disconnectType","dnis","edgeId","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalOrganizationId","flaggedReason","flowId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowVersion","groupId","journeyActionId","journeyActionMapId","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","mediaCount","mediaType","messageType","monitoredParticipantId","outboundCampaignId","outboundContactId","outboundContactListId","participantName","protocolCallId","provider","purpose","queueId","recording","remote","remoteNameDisplayable","requestedLanguageId","requestedRouting","requestedRoutingSkillId","scoredAgentId","scriptId","segmentEnd","segmentType","sessionDnis","sipResponseCode","subject","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode","wrapUpNote"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension, metric, or property predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension, metric, or property predicates","$ref":"#/definitions/NumericRange"}}},"SurveyDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["eventTime","queueId","surveyCompletedDate","surveyFormContextId","surveyFormId","surveyId","surveyPartialResponse","surveyPromoterScore","surveyStatus","surveyType","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oSurveyTotalScore"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"AnalyticsConversationWithoutAttributesMultiGetResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"PropertyIndexRequest":{"type":"object","required":["properties","sessionId","targetDate"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session"},"targetDate":{"type":"string","format":"date-time","description":"Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"AsyncConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"},"startOfDayIntervalMatching":{"type":"boolean","description":"Add a filter to only include conversations that started after the beginning of the interval start date (UTC)"}}},"AnalyticsConversation":{"type":"object","properties":{"conferenceStart":{"type":"string","format":"date-time","description":"The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationInitiator":{"type":"string","description":"Indicates the participant purpose of the participant initiating a message conversation","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"conversationStart":{"type":"string","format":"date-time","description":"The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"customerParticipation":{"type":"boolean","description":"Indicates a messaging conversation in which the customer participated by sending at least one message"},"divisionIds":{"type":"array","description":"Identifier(s) of division(s) associated with a conversation","items":{"type":"string"}},"externalTag":{"type":"string","description":"External tag for the conversation"},"knowledgeBaseIds":{"type":"array","description":"The unique identifier(s) of the knowledge base(s) used","items":{"type":"string"}},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"]},"selfServed":{"type":"boolean","description":"Indicates whether all flow sessions were self serviced"},"evaluations":{"type":"array","description":"Evaluations associated with this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys associated with this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions associated with this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipant"}}}},"AnalyticsConversationAsyncQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsParticipant":{"type":"object","properties":{"externalContactId":{"type":"string","description":"External contact identifier"},"externalOrganizationId":{"type":"string","description":"External organization identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"]},"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"purpose":{"type":"string","description":"The participant's purpose","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}},"attributes":{"type":"object","description":"List of attributes associated to this participant","additionalProperties":{"type":"string"}}}},"DataAvailabilityResponse":{"type":"object","properties":{"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EvaluationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"EvaluationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}}}},"EvaluationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","conversationStart","divisionId","evaluationContextId","evaluationCreatedDate","evaluationId","evaluationReleaseDate","evaluatorId","formId","queueId","released","rescored","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]}}},"EvaluationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowExecutionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowExecutionAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionAggregateDataContainer"}}}},"FlowExecutionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryPredicate"}}}},"FlowExecutionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryPredicate"}}}},"FlowExecutionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["divisionId","flowId","flowObjectId","flowVersion"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowExecutionAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["divisionId","flowId","flowObjectId","flowVersion"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowExecutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlowExecutions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowExecutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"FlowExecutionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlowExecutions"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}}}},"FlowAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","canonicalExternalContactId","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"FlowAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"FlowObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowObservationDataContainer"}}}},"ObservationMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"},"truncated":{"type":"boolean","description":"Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations."},"observations":{"type":"array","description":"List of observations sorted by timestamp in ascending order. This list may be truncated.","items":{"$ref":"#/definitions/ObservationValue"}}}},"ObservationValue":{"type":"object","required":["observationDate"],"properties":{"observationDate":{"type":"string","format":"date-time","description":"The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier for a skill requested for an interaction","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"Unique identifier for the user"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"teamId":{"type":"string","description":"The team id the user is a member of"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods","uniqueItems":true,"items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}}}},"FlowObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oFlow"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oFlow"]}}}},"FlowObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["flowId","mediaType"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/FlowActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/FlowActivityEntityData"}}}},"FlowActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metric":{"type":"string","description":"Activity metric","enum":["oFlow"]},"activeRouting":{"type":"string","description":"Active routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"userId":{"type":"string","description":"Unique identifier for the user"},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/FlowActivityScoredAgent"}}}},"FlowActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oFlow"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"FlowActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/FlowActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}}},"FlowActivityScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"FlowActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/FlowActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"FlowActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowActivityQueryPredicate"}}}},"FlowActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowActivityQueryPredicate"}}}},"FlowActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oFlow"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"FlowActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"JourneyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"JourneyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}}}},"JourneyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/JourneyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"JourneyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"JourneyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"KnowledgeAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"KnowledgeAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/KnowledgeAggregateDataContainer"}}}},"KnowledgeAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/KnowledgeAggregateQueryPredicate"}}}},"KnowledgeAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/KnowledgeAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/KnowledgeAggregateQueryPredicate"}}}},"KnowledgeAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"KnowledgeAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/KnowledgeAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/KnowledgeAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."}}},"KnowledgeAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"QueueObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"QueueObservationQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/QueueObservationDataContainer"}}}},"QueueObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/QueueObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"]}}}},"QueueObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/QueueObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["mediaType","queueId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RateLimitAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"RateLimitAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/RateLimitAggregateDataContainer"}}}},"RateLimitAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RateLimitAggregateQueryPredicate"}}}},"RateLimitAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RateLimitAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RateLimitAggregateQueryPredicate"}}}},"RateLimitAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["correlationId","entityId","limitName","max","namespace","timeUnit","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RateLimitAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["correlationId","entityId","limitName","max","namespace","timeUnit","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/RateLimitAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oRateLimitRecorded"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/RateLimitAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"RateLimitAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["oRateLimitRecorded"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"RoutingActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/RoutingActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/RoutingActivityEntityData"}}}},"RoutingActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"RoutingActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oActiveUsers","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"RoutingActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/RoutingActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"RoutingActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/RoutingActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["queueId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/RoutingActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"RoutingActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingActivityQueryPredicate"}}}},"RoutingActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingActivityQueryPredicate"}}}},"RoutingActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oActiveUsers","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"RoutingActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"SurveyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"SurveyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}}}},"SurveyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"SurveyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"]}}},"SurveyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"TeamActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/TeamActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/TeamActivityEntityData"}}}},"TeamActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"TeamActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oTeamOffQueueUsers","oTeamOnQueueUsers","oTeamPresences","oTeamRoutingStatuses"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"TeamActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/TeamActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"TeamActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/TeamActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["teamId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TeamActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"TeamActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TeamActivityQueryPredicate"}}}},"TeamActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TeamActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TeamActivityQueryPredicate"}}}},"TeamActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oTeamOffQueueUsers","oTeamOnQueueUsers","oTeamPresences","oTeamRoutingStatuses"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"TeamActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"TranscriptAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TranscriptAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}}}},"TranscriptAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TranscriptAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","ani","channel","conversationDuration","conversationId","direction","divisionId","dnis","flowId","flowVersion","handleTime","mediaType","messageType","queueId","resultsBy","teamId","topicId","userId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TranscriptAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"TranscriptAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"UserAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"UserAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}}}},"UserAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"UserAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AnalyticsRoutingStatusRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"routingStatus":{"type":"string","description":"The user's ACD routing status","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]}}},"AnalyticsUserDetail":{"type":"object","properties":{"userId":{"type":"string","description":"The identifier for the user"},"primaryPresence":{"type":"array","description":"The presence records for the user","items":{"$ref":"#/definitions/AnalyticsUserPresenceRecord"}},"routingStatus":{"type":"array","description":"The ACD routing status records for the user","items":{"$ref":"#/definitions/AnalyticsRoutingStatusRecord"}}}},"AnalyticsUserDetailsQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"totalHits":{"type":"integer","format":"int32"}}},"AnalyticsUserPresenceRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"The user's system presence","enum":["AVAILABLE","AWAY","BUSY","OFFLINE","IDLE","ON_QUEUE","MEAL","TRAINING","MEETING","BREAK"]},"organizationPresenceId":{"type":"string","description":"The identifier for the user's organization presence"}}},"PresenceDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/PresenceDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","systemPresence"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RoutingStatusDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingStatusDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["routingStatus"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"presenceAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"routingStatusAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"UserObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"UserObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/UserObservationDataContainer"}}}},"UserObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"]}}}},"UserObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/UserActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/UserActivityEntityData"}}}},"UserActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"UserActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oActiveQueues","oMemberQueues"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"UserActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/UserActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"UserActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/UserActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"UserActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserActivityQueryPredicate"}}}},"UserActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserActivityQueryPredicate"}}}},"UserActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oActiveQueues","oMemberQueues"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"UserActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"AsyncUserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"}}},"AnalyticsUserDetailsAsyncQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ReportingTurn":{"type":"object","properties":{"userInput":{"type":"string","description":"The chosen user input associated with this reporting turn."},"botPrompts":{"type":"array","description":"The bot prompts associated with this reporting turn.","items":{"type":"string"}},"sessionId":{"type":"string","description":"The bot session ID that this reporting turn is grouped under."},"askAction":{"description":"The bot flow 'ask' action associated with this reporting turn (e.g. AskForIntent).","$ref":"#/definitions/ReportingTurnAction"},"intent":{"description":"The intent and associated slots detected during this reporting turn.","$ref":"#/definitions/ReportingTurnIntent"},"knowledge":{"description":"The knowledge data captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledge"},"knowledgeBaseEvents":{"description":"The knowledge data captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeEvents"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp indicating when the original turn was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"askActionResult":{"type":"string","description":"Result of the bot flow 'ask' action.","enum":["SuccessCollection","SuccessConfirmationYes","SuccessConfirmationNo","SkippedCollection","NoMatchCollection","NoMatchConfirmation","AgentRequestedByUser","ConfirmationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","DisambiguationRequired","SuccessDisambiguation","SuccessDisambiguationNone","NoMatchDisambiguation","NoInputDisambiguation"]},"sessionEndDetails":{"description":"The details related to end of bot flow session.","$ref":"#/definitions/SessionEndDetails"},"conversation":{"description":"The conversation details, across potentially multiple Bot Flow sessions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"ReportingTurnAction":{"type":"object","properties":{"actionId":{"type":"string","description":"The ID of the action in the bot flow."},"actionName":{"type":"string","description":"The name of the action in the bot flow."},"actionNumber":{"type":"integer","format":"int32","description":"The number of the action in the bot flow."},"actionType":{"type":"string","enum":["AddFlowMilestoneAction","AskForNLUIntentAction","AskForBooleanAction","AskForSlotAction","AskSurveyQuestionAction","AskForNLUNextIntentAction","BotState","CallTaskAction","ClearSlotAction","ClearUtilizationLabelAction","DisconnectAction","EndTaskAction","ExitBotFlowAction","UpdateVariableAction","CommunicateAction","DecisionAction","FindEmergencyGroupAction","FindGrammarAction","FindGrammarByIdAction","FindGroupAction","FindLanguageSkillAction","FindQueueAction","FindQueueByIdAction","FindScheduleAction","FindScheduleGroupAction","FindSkillAction","FindSystemPromptAction","FindUserAction","FindUserByIdAction","FindUsersByIdAction","FindUserPromptAction","FindUtilizationLabelAction","SwitchAction","DataAction","DataTableLookupAction","GetExternalContactAction","GetExternalOrganizationAction","LoopAction","ExitLoopAction","NextLoopAction","LoopUntilAction","SetActiveIntentAction","SetFlowOutcomeAction","InitializeFlowOutcomeAction","AskForStringAction","SendResponseAction","GetResponseAction","ExtractSecureDataAction","SecureAction","TransferTaskAction","DigitalMenuAction","WaitForInputAction","EvaluateScheduleAction","EvaluateScheduleGroupAction","ShowKnowledgeArticleAction","SendKnowledgeFeedbackAction","SetLocaleAction","ScreenPopAction","SetUtilizationLabelAction","TransferPureMatchAction","Unknown"]}}},"ReportingTurnIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the intent detected during this reporting turn."},"confidence":{"type":"number","format":"double","description":"The confidence score of the intent detected during this reporting turn."},"slots":{"type":"array","description":"The slots detected during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnIntentSlot"}}}},"ReportingTurnIntentSlot":{"type":"object","properties":{"name":{"type":"string","description":"The name of the slot."},"value":{"type":"string","description":"The value of the slot."},"type":{"type":"string","description":"The NLU entity type of the slot (either builtin or user defined)"},"confidence":{"type":"number","format":"double","description":"The confidence score this slot received during detection."}}},"ReportingTurnKnowledge":{"type":"object","properties":{"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"feedback":{"description":"The knowledge feedback data that was captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeFeedback"},"search":{"description":"The knowledge search data that was captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeSearch"}}},"ReportingTurnKnowledgeDocument":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the knowledge document."},"question":{"type":"string","description":"The the question that was used to match against the search query."},"answer":{"type":"string","description":"The corresponding answer to the question."},"confidence":{"type":"number","format":"double","description":"The confidence score of how well the question matched the search query."}}},"ReportingTurnKnowledgeEvents":{"type":"object","properties":{"search":{"type":"array","description":"The knowledge search data captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeSearchEvent"}},"feedback":{"type":"array","description":"The knowledge feedback data captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeFeedbackEvent"}}}},"ReportingTurnKnowledgeFeedback":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of the original knowledge search that this feedback relates to."},"rating":{"type":"integer","format":"int32","description":"The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}}}},"ReportingTurnKnowledgeFeedbackEvent":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"feedbackRating":{"type":"integer","format":"int32","description":"The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive."},"documentVariationId":{"type":"string","description":"The variation of the document."},"documentVersionId":{"type":"string","description":"The version of the document."}}},"ReportingTurnKnowledgeSearch":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"documents":{"type":"array","description":"The list of search documents captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"query":{"type":"string","description":"The search query that was used to search the Knowledge Base documents for a matching question."}}},"ReportingTurnKnowledgeSearchEvent":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"searchQuery":{"type":"string","description":"The search query that was used to search the Knowledge Base documents for a matching question."},"answerDocumentId":{"type":"string","description":"The document ID of the search answer."}}},"ReportingTurnsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingTurn"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SessionEndDetails":{"type":"object","properties":{"type":{"type":"string","description":"The type of termination handling that resulted in the session end. It can be either Exit or Disconnect","enum":["Disconnect","Exit"]},"reason":{"type":"string","description":"The reason for termination action. It can be due to an error or normal flow execution"}}},"BotChannel":{"type":"object","required":["inputModes","name","outputModes","userAgent"],"properties":{"name":{"type":"string","description":"The name of the channel.","enum":["Chat","Call","Messaging"]},"inputModes":{"type":"array","description":"The input modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text","Voice","DTMF"]}},"outputModes":{"type":"array","description":"The output modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text","Voice"]}},"userAgent":{"description":"Information about the end user agent calling the bot flow.","$ref":"#/definitions/TextBotUserAgent"}},"description":"Channel information relevant to a bot flow."},"BotFlowSession":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the bot session."},"flow":{"description":"The flow associated to this bot session.","$ref":"#/definitions/Entity"},"channel":{"description":"Channel-specific information that describes the message channel/provider.","$ref":"#/definitions/BotChannel"},"language":{"type":"string","description":"The initial language of operation for the session."},"endLanguage":{"type":"string","description":"The language of the session at the time the session ended"},"botResult":{"type":"string","description":"The reason for session termination.","enum":["Unknown","ExitRequestedByUser","ExitRequestedByBot","ExitError","ExitRecognitionFailure","DisconnectRequestedByUser","DisconnectRequestedByBot","DisconnectSessionExpired","DisconnectError","DisconnectRecognitionFailure","TransferToACD"]},"botResultCategory":{"type":"string","description":"The category of result for the session.","enum":["Unknown","UserExit","BotExit","Error","RecognitionFailure","UserDisconnect","BotDisconnect","SessionExpired","Transfer"]},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"description":"The conversation details, across potentially multiple Bot Flow sessions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SessionsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotFlowSession"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"TextBotUserAgent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the user agent.","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"]}},"description":"Information about the caller executing a bot flow."},"AnalyticsDataRetentionResponse":{"type":"object","properties":{"retentionDays":{"type":"integer","format":"int32","description":"Analytics data retention period in days for the organization."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time when the analytics data retention was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date and time when the analytics data retention was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UpdateAnalyticsDataRetentionRequest":{"type":"object","required":["retentionDays"],"properties":{"retentionDays":{"type":"integer","format":"int32","description":"Analytics data retention period in days to set for the organization."}}},"AnalyticsReportingSettings":{"type":"object","properties":{"piiMaskingEnabled":{"type":"boolean","description":"Indication of whether or not personal data is masked in data export and the Analytics/Reporting UI"},"queueAgentAccessObfuscation":{"type":"boolean","description":"Indication of whether or not to obfuscate export data from the Queue Agent Details view based on User ACL"},"myInteractionsPiiMaskingEnabled":{"type":"boolean","description":"Indicates whether PII data is masked in My Interaction export and the Analytics/Reporting UI"}}},"ConversationProperties":{"type":"object","properties":{"isWaiting":{"type":"boolean","description":"Indicates filtering for waiting"},"isActive":{"type":"boolean","description":"Indicates filtering for active"},"isAcd":{"type":"boolean","description":"Indicates filtering for Acd"},"isPreferred":{"type":"boolean","description":"Indicates filtering for Preferred Agent Routing"},"isScreenshare":{"type":"boolean","description":"Indicates filtering for screenshare"},"isCobrowse":{"type":"boolean","description":"Indicates filtering for Cobrowse"},"isVoicemail":{"type":"boolean","description":"Indicates filtering for Voice mail"},"isFlagged":{"type":"boolean","description":"Indicates filtering for flagged"},"isMonitored":{"type":"boolean","description":"Indicates filtering for monitored"},"isScreenMonitored":{"type":"boolean","description":"Indicates filtering for screenMonitored"},"filterWrapUpNotes":{"type":"boolean","description":"Indicates filtering for WrapUpNotes"},"matchAll":{"type":"boolean","description":"Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic"}}},"DashboardConfiguration":{"type":"object","required":["dateCreated","dateModified","name","widgets"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of dashboard configuration."},"rows":{"type":"integer","description":"The count of rows for the specific dashboard configuration."},"columns":{"type":"integer","description":"The count of columns for the specific dashboard."},"widgets":{"type":"array","description":"List of widgets for dashboard configuration.","items":{"$ref":"#/definitions/Widget"}},"favorite":{"type":"boolean","description":"The flag indicates if the dashboard is favorited by the user"},"publicDashboard":{"type":"boolean","description":"The flag to indicate if the dashboard is published by an user"},"restricted":{"type":"boolean","description":"The flag to indicate if the dashboard has any restricted data for that user","readOnly":true},"layoutType":{"type":"string","description":"The layout type of the dashboard","enum":["Grid","Flow"]},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The last modified date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The id of user who created the dashboard","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptTopics":{"type":"object","properties":{"includes":{"type":"array","description":"List of topics which need to be included in exact match criteria. This field is not mutually exclusive with excludes topic list.","items":{"type":"string"}},"excludes":{"type":"array","description":"List of topics which need to be excluded in exact match criteria. This field is not mutually exclusive with includes topic list.","items":{"type":"string"}}}},"Transcripts":{"type":"object","properties":{"exactMatch":{"type":"array","description":"List of transcript contents which needs to satisfy exact match criteria","items":{"type":"string"}},"contains":{"type":"array","description":"List of transcript contents which needs to satisfy contains criteria","items":{"type":"string"}},"doesNotContain":{"type":"array","description":"List of transcript contents which needs to satisfy does not contain criteria","items":{"type":"string"}}}},"ViewFilter":{"type":"object","properties":{"mediaTypes":{"type":"array","description":"The media types are used to filter the view","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queueIds":{"type":"array","description":"The queue ids are used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"QUEUE_ID"}},"skillIds":{"type":"array","description":"The skill ids are used to filter the view","items":{"type":"string"}},"skillGroups":{"type":"array","description":"The skill groups used to filter the view","items":{"type":"string"}},"languageIds":{"type":"array","description":"The language ids are used to filter the view","items":{"type":"string"}},"languageGroups":{"type":"array","description":"The language groups used to filter the view","items":{"type":"string"}},"directions":{"type":"array","description":"The directions are used to filter the view","items":{"type":"string","enum":["inbound","outbound"]}},"originatingDirections":{"type":"array","description":"The list of orginating directions used to filter the view","items":{"type":"string","enum":["inbound","outbound"]}},"wrapUpCodes":{"type":"array","description":"The wrap up codes are used to filter the view","items":{"type":"string"}},"dnisList":{"type":"array","description":"The dnis list is used to filter the view","items":{"type":"string"}},"sessionDnisList":{"type":"array","description":"The list of session dnis used to filter the view","items":{"type":"string"}},"filterQueuesByUserIds":{"type":"array","description":"The user ids are used to fetch associated queues for the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"USER_ID"}},"filterUsersByQueueIds":{"type":"array","description":"The queue ids are used to fetch associated users for the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"QUEUE_ID"}},"userIds":{"type":"array","description":"The user ids are used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"USER_ID"}},"managementUnitIds":{"type":"array","description":"The management unit ids are used to filter the view","items":{"type":"string"}},"addressTos":{"type":"array","description":"The address To values are used to filter the view","items":{"type":"string"}},"addressFroms":{"type":"array","description":"The address from values are used to filter the view","items":{"type":"string"}},"outboundCampaignIds":{"type":"array","description":"The outbound campaign ids are used to filter the view","items":{"type":"string"}},"outboundContactListIds":{"type":"array","description":"The outbound contact list ids are used to filter the view","items":{"type":"string"}},"contactIds":{"type":"array","description":"The contact ids are used to filter the view","items":{"type":"string"}},"externalContactIds":{"type":"array","description":"The external contact ids are used to filter the view","items":{"type":"string"}},"externalOrgIds":{"type":"array","description":"The external org ids are used to filter the view","items":{"type":"string"}},"aniList":{"type":"array","description":"The ani list ids are used to filter the view","items":{"type":"string"}},"durationsMilliseconds":{"type":"array","description":"The durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acdDurationsMilliseconds":{"type":"array","description":"The acd durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"talkDurationsMilliseconds":{"type":"array","description":"The talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acwDurationsMilliseconds":{"type":"array","description":"The acw durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"handleDurationsMilliseconds":{"type":"array","description":"The handle durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"holdDurationsMilliseconds":{"type":"array","description":"The hold durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"abandonDurationsMilliseconds":{"type":"array","description":"The abandon durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"evaluationScore":{"description":"The evaluationScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationCriticalScore":{"description":"The evaluationCriticalScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationFormIds":{"type":"array","description":"The evaluation form ids are used to filter the view","items":{"type":"string"}},"evaluatedAgentIds":{"type":"array","description":"The evaluated agent ids are used to filter the view","items":{"type":"string"}},"evaluatorIds":{"type":"array","description":"The evaluator ids are used to filter the view","items":{"type":"string"}},"transferred":{"type":"boolean","description":"Indicates filtering for transfers"},"abandoned":{"type":"boolean","description":"Indicates filtering for abandons"},"answered":{"type":"boolean","description":"Indicates filtering for answered interactions"},"messageTypes":{"type":"array","description":"The message media types used to filter the view","items":{"type":"string","enum":["sms","twitter","line","facebook","whatsapp","webmessaging","open","instagram"]}},"divisionIds":{"type":"array","description":"The divison Ids used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"DIVISION_ID"}},"surveyFormIds":{"type":"array","description":"The survey form ids used to filter the view","items":{"type":"string"}},"surveyTotalScore":{"description":"The survey total score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyNpsScore":{"description":"The survey NPS score used to filter the view","$ref":"#/definitions/NumericRange"},"mos":{"description":"The desired range for mos values","$ref":"#/definitions/NumericRange"},"surveyQuestionGroupScore":{"description":"The survey question group score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyPromoterScore":{"description":"The survey promoter score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyFormContextIds":{"type":"array","description":"The list of survey form context ids used to filter the view","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of conversation ids used to filter the view","items":{"type":"string"}},"sipCallIds":{"type":"array","description":"The list of SIP call ids used to filter the view","items":{"type":"string"}},"isEnded":{"type":"boolean","description":"Indicates filtering for ended"},"isSurveyed":{"type":"boolean","description":"Indicates filtering for survey"},"surveyScores":{"type":"array","description":"The list of survey score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"promoterScores":{"type":"array","description":"The list of promoter score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"isCampaign":{"type":"boolean","description":"Indicates filtering for campaign"},"surveyStatuses":{"type":"array","description":"The list of survey statuses used to filter the view","items":{"type":"string"}},"conversationProperties":{"description":"A grouping of conversation level filters","$ref":"#/definitions/ConversationProperties"},"isBlindTransferred":{"type":"boolean","description":"Indicates filtering for blind transferred"},"isConsulted":{"type":"boolean","description":"Indicates filtering for consulted"},"isConsultTransferred":{"type":"boolean","description":"Indicates filtering for consult transferred"},"remoteParticipants":{"type":"array","description":"The list of remote participants used to filter the view","items":{"type":"string"}},"flowIds":{"type":"array","description":"The list of flow Ids","items":{"type":"string"}},"flowOutcomeIds":{"type":"array","description":"A list of outcome ids of the flow","items":{"type":"string"}},"flowOutcomeValues":{"type":"array","description":"A list of outcome values of the flow","items":{"type":"string","enum":["SUCCESS","FAILURE"]}},"flowDestinationTypes":{"type":"array","description":"The list of destination types of the flow","items":{"type":"string","enum":["ACD","USER","GROUP","NUMBER","FLOW","SECURE_FLOW","ACD_VOICEMAIL","USER_VOICEMAIL","GROUP_VOICEMAIL","RETURN_TO_AGENT"]}},"flowDisconnectReasons":{"type":"array","description":"The list of reasons for the flow to disconnect","items":{"type":"string","enum":["FLOW_DISCONNECT","FLOW_ERROR_DISCONNECT","DISCONNECT"]}},"flowTypes":{"type":"array","description":"A list of types of the flow","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]}},"flowEntryTypes":{"type":"array","description":"A list of types of the flow entry","items":{"type":"string","enum":["agent","direct","dnis","flow","outbound"]}},"flowEntryReasons":{"type":"array","description":"A list of reasons of flow entry","items":{"type":"string"}},"flowVersions":{"type":"array","description":"A list of versions of a flow","items":{"type":"string"}},"groupIds":{"type":"array","description":"A list of directory group ids","items":{"type":"string"}},"hasJourneyCustomerId":{"type":"boolean","description":"Indicates filtering for journey customer id"},"hasJourneyActionMapId":{"type":"boolean","description":"Indicates filtering for Journey action map id"},"hasJourneyVisitId":{"type":"boolean","description":"Indicates filtering for Journey visit id"},"hasMedia":{"type":"boolean","description":"Indicates filtering for presence of MMS media"},"roleIds":{"type":"array","description":"The role Ids used to filter the view","items":{"type":"string"}},"reportsTos":{"type":"array","description":"The report to user IDs used to filter the view","items":{"type":"string"}},"locationIds":{"type":"array","description":"The location Ids used to filter the view","items":{"type":"string"}},"flowOutTypes":{"type":"array","description":"A list of flow out types","items":{"type":"string"}},"providerList":{"type":"array","description":"A list of providers","items":{"type":"string"}},"callbackNumberList":{"type":"array","description":"A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])","items":{"type":"string"}},"callbackInterval":{"type":"string","description":"An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"usedRoutingTypes":{"type":"array","description":"A list of routing types used","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"requestedRoutingTypes":{"type":"array","description":"A list of routing types requested","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"hasAgentAssistId":{"type":"boolean","description":"Indicates filtering for agent assist id"},"transcripts":{"type":"array","description":"A list of transcript contents requested","items":{"$ref":"#/definitions/Transcripts"}},"transcriptLanguages":{"type":"array","description":"A list of transcript languages requested","items":{"type":"string"}},"participantPurposes":{"type":"array","description":"A list of participant purpose requested","items":{"type":"string","enum":["internal","external"]}},"showFirstQueue":{"type":"boolean","description":"Indicates filtering for first queue data"},"teamIds":{"type":"array","description":"The team ids used to filter the view data","items":{"type":"string"}},"filterUsersByTeamIds":{"type":"array","description":"The team ids are used to fetch associated users for the view","items":{"type":"string"}},"journeyActionMapIds":{"type":"array","description":"The journey action map ids are used to fetch action maps for the associated view","items":{"type":"string"}},"journeyOutcomeIds":{"type":"array","description":"The journey outcome ids are used to fetch outcomes for the associated view","items":{"type":"string"}},"journeySegmentIds":{"type":"array","description":"The journey segment ids are used to fetch segments for the associated view","items":{"type":"string"}},"journeyActionMapTypes":{"type":"array","description":"The journey action map types are used to filter action map data for the associated view","items":{"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]}},"developmentRoleList":{"type":"array","description":"The list of development roles used to filter agent development view","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]}},"developmentTypeList":{"type":"array","description":"The list of development types used to filter agent development view","items":{"type":"string","enum":["Informational","Coaching","Assessment","AssessedContent","External"]}},"developmentStatusList":{"type":"array","description":"The list of development status used to filter agent development view","items":{"type":"string","enum":["Planned","Scheduled","InvalidSchedule","InProgress","Completed","NotCompleted"]}},"developmentModuleIds":{"type":"array","description":"The list of development moduleIds used to filter agent development view","items":{"type":"string"}},"developmentActivityOverdue":{"type":"boolean","description":"Indicates filtering for development activities"},"customerSentimentScore":{"description":"The customer sentiment score used to filter the view","$ref":"#/definitions/NumericRange"},"customerSentimentTrend":{"description":"The customer sentiment trend used to filter the view","$ref":"#/definitions/NumericRange"},"flowTransferTargets":{"type":"array","description":"The list of transfer targets used to filter flow data","items":{"type":"string"}},"developmentName":{"type":"string","description":"Filter for development name"},"topicIds":{"type":"array","description":"Represents the topics detected in the transcript","items":{"type":"string"}},"externalTags":{"type":"array","description":"The list of external Tags used to filter conversation data","items":{"type":"string"}},"isNotResponding":{"type":"boolean","description":"Indicates filtering for not responding users"},"isAuthenticated":{"type":"boolean","description":"Indicates filtering for the authenticated chat"},"botIds":{"type":"array","description":"The list of bot IDs used to filter bot views","items":{"type":"string"}},"botVersions":{"type":"array","description":"The list of bot versions used to filter bot views","items":{"type":"string"}},"botMessageTypes":{"type":"array","description":"The list of bot message types used to filter bot views","items":{"type":"string","enum":["Unknown","Phone","SMS","GenesysChatWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other"]}},"botProviderList":{"type":"array","description":"The list of bot providers used to filter bot views","items":{"type":"string","enum":["Unknown","Genesys","Amazon","Google","Nuance"]}},"botProductList":{"type":"array","description":"The list of bot products used to filter bot views","items":{"type":"string","enum":["Unknown","GenesysDialogEngine","AmazonLex","GoogleDialogFlow","GoogleDialogFlowResell","GenesysBotFlow","NuanceDlg","GoogleDialogFlowCx","GenesysByob","AmazonLexV2","GoogleDialogFlowCxResell","GoogleSttBotFlow","MicrosoftSttBotFlow"]}},"botRecognitionFailureReasonList":{"type":"array","description":"The list of bot recognition failure reasons used to filter bot views","items":{"type":"string","enum":["Unknown","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","MaxWrongMatch"]}},"botIntentList":{"type":"array","description":"The list of bot intents used to filter bot views","items":{"type":"string"}},"botFinalIntentList":{"type":"array","description":"The list of bot final intents used to filter bot views","items":{"type":"string"}},"botSlotList":{"type":"array","description":"The list of bot slots used to filter bot views","items":{"type":"string"}},"botResultList":{"type":"array","description":"The list of bot results used to filter bot views","items":{"type":"string","enum":["Unknown","ExitRequestedByUser","ExitRequestedByBot","ExitError","ExitRecognitionFailure","DisconnectRequestedByUser","DisconnectRequestedByBot","DisconnectSessionExpired","DisconnectError","DisconnectRecognitionFailure","TransferToACD"]}},"blockedReasons":{"type":"array","description":"The list of blocked reason used to filter action map constraints views","items":{"type":"string","enum":["PageUrlConditionsNotMatching","AlreadyExistingOffer","TriggerDateInFuture","MultipleSimultaneousOffers","FrequencyCapping","OfferedOutsideSchedule","ServiceLevelThrottling","NoAvailableAgents"]}},"isRecorded":{"type":"boolean","description":"Indicates filtering for recorded"},"hasEvaluation":{"type":"boolean","description":"Indicates filtering for evaluation"},"hasScoredEvaluation":{"type":"boolean","description":"Indicates filtering for scored evaluation"},"emailDeliveryStatusList":{"type":"array","description":"The list of email delivery statuses used to filter views","items":{"type":"string","enum":["DeliveryFailed","DeliverySuccess","Failed","Published","Queued","Read","Received","Sent"]}},"isAgentOwnedCallback":{"type":"boolean","description":"Indicates filtering for agent owned callback interactions"},"agentCallbackOwnerIds":{"type":"array","description":"The list of callback owners used to filter interactions","items":{"type":"string"}},"transcriptTopics":{"type":"array","description":"The list of transcript topics requested in filter","items":{"$ref":"#/definitions/TranscriptTopics"}},"journeyFrequencyCapReasons":{"type":"array","description":"The list of frequency cap reasons to filter offer constraints","items":{"type":"string"}},"journeyBlockingActionMapIds":{"type":"array","description":"The list of blocking action maps to filter offer constraints","items":{"type":"string"}},"journeyActionTargetIds":{"type":"array","description":"The list of action targets to filter offer constraints","items":{"type":"string"}},"journeyBlockingScheduleGroupIds":{"type":"array","description":"The list of blocking schedule groups to filter offer constraints","items":{"type":"string"}},"journeyBlockingEmergencyScheduleGroupIds":{"type":"array","description":"The list of emergency schedule groups to filter offer constraints","items":{"type":"string"}},"journeyUrlEqualConditions":{"type":"array","description":"The list of url equal conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotEqualConditions":{"type":"array","description":"The list of url not equal conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlStartsWithConditions":{"type":"array","description":"The list of url starts with conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlEndsWithConditions":{"type":"array","description":"The list of url ends with conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlContainsAnyConditions":{"type":"array","description":"The list of url contains any conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotContainsAnyConditions":{"type":"array","description":"The list of url not contains any conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlContainsAllConditions":{"type":"array","description":"The list of url contains all conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotContainsAllConditions":{"type":"array","description":"The list of url not contains all conditions to filter offer constraints","items":{"type":"string"}},"flowMilestoneIds":{"type":"array","description":"The list of flow milestones to filter exports","items":{"type":"string"}},"isAssessmentPassed":{"type":"boolean","description":"Filter to indicate if Agent passed assessment or not"},"conversationInitiators":{"type":"array","description":"The list to filter based on Brands (Bot/User/Agent) or End User who initiated the first message in the conversation","items":{"type":"string"}},"hasCustomerParticipated":{"type":"boolean","description":"Indicates if the customer has participated in an initiated conversation"},"isAcdInteraction":{"type":"boolean","description":"Filter to indicate if interaction was ACD or non-ACD"},"hasFax":{"type":"boolean","description":"Filters to indicate if interaction has FAX"},"dataActionIds":{"type":"array","description":"The list of Data Action IDs ","items":{"type":"string"}},"actionCategoryName":{"type":"string","description":"Deprecated - Please use integrationIds instead"},"integrationIds":{"type":"array","description":"The list of integration IDs for Data Action","items":{"type":"string"}},"responseStatuses":{"type":"array","description":"The list of Response codes for Data Action","items":{"type":"string"}},"availableDashboard":{"type":"string","description":"Filter to indicate the availability of the dashboard is public or private.","enum":["Public","Private"]},"favouriteDashboard":{"type":"boolean","description":"Filter to indicate whether the dashboard is favorite or unfavorite."},"myDashboard":{"type":"boolean","description":"Filter to indicate the dashboard owned by the user."},"stationErrors":{"type":"array","description":"The list of agent errors that are related to station","items":{"type":"string"}},"canonicalContactIds":{"type":"array","description":"The canonical contact ids are used to filter the view","items":{"type":"string"}},"alertRuleIds":{"type":"array","description":"The list of Alert Rule IDs","items":{"type":"string"}},"evaluationFormContextIds":{"type":"array","description":"The list of Evaluation Form Context IDs","items":{"type":"string"}},"evaluationStatuses":{"type":"array","description":"The evaluation statuses that are used to filter the view","items":{"type":"string","enum":["Finished","InProgress","InReview","Pending","Retracted"]}},"workbinIds":{"type":"array","description":"The list of Workbin IDs","items":{"type":"string"}},"worktypeIds":{"type":"array","description":"The list of Worktype IDs","items":{"type":"string"}},"workitemIds":{"type":"array","description":"The list of Workitem IDs","items":{"type":"string"}},"workitemAssigneeIds":{"type":"array","description":"The list of Workitem Assignee IDs","items":{"type":"string"}},"workitemStatuses":{"type":"array","description":"The list of Workitem Statuses IDs","items":{"type":"string"}},"isAnalyzedForSensitiveData":{"type":"boolean","description":"Deprecated - Use hasPciData or hasPiiData instead."},"hasSensitiveData":{"type":"boolean","description":"Deprecated. Use hasPciData or hasPiiData instead."},"hasPciData":{"type":"boolean","description":"Filter to indicate the transcript contains Pci data."},"hasPiiData":{"type":"boolean","description":"Filter to indicate the transcript contains Pii data."},"subPath":{"type":"string","description":"Filter for Sub Path"},"userState":{"type":"string","description":"The user supplied state value in the view","enum":["ActiveAndInactive","Active","Inactive","Deleted"]},"isClearedByCustomer":{"type":"boolean","description":"Filter to indicate if the customer cleared the conversation."},"evaluationAssigneeIds":{"type":"array","description":"The evaluation assignee ids that are used to filter the view.","items":{"type":"string"}},"evaluationAssigned":{"type":"boolean","description":"Filter to indicate that the user has no assigned evaluation."},"assistantIds":{"type":"array","description":"The assistant ids that are used to filter the view.","items":{"type":"string"}},"knowledgeBaseIds":{"type":"array","description":"The knowledge base ids that are used to filter the view.","items":{"type":"string"}},"isParked":{"type":"boolean","description":"Filter to indicate if the interactions are parked."},"agentEmpathyScore":{"description":"The agentEmpathyScore is used to filter the view","$ref":"#/definitions/NumericRange"},"surveyTypes":{"type":"array","description":"The surveyTypes is used to filter the view","items":{"type":"string","enum":["Web","Voice"]}},"surveyResponseStatuses":{"type":"array","description":"The list of Survey Response Status","items":{"type":"string","enum":["Unknown","FullResponse","PartialResponse"]}},"botFlowTypes":{"type":"array","description":"The botFlowTypes is used to filter the view","items":{"type":"string","enum":["Unknown","Bot","DigitalBot","VoiceSurvey"]}},"isScreenRecorded":{"type":"boolean","description":"Filter to indicate if the screen is recorded"},"screenMonitorUserIds":{"type":"array","description":"The list of Screen Monitor User Ids","items":{"type":"string"}}}},"Warning":{"type":"object","properties":{"value":{"type":"integer","description":"The value for the warning configuration."},"rangeType":{"type":"string","description":"The range type for the warning configuration.","enum":["OVER","UNDER","BETWEEN"]},"color":{"type":"string","description":"The color for the warning configuration in RGB hexadecimal format (for example \"#FF0000\" represents red)."}}},"Widget":{"type":"object","required":["type"],"properties":{"row":{"type":"integer","description":"The row number for the specific dashboard widget configuration."},"column":{"type":"integer","description":"The column number for the specific dashboard widget configuration."},"title":{"type":"string","description":"The title for the dashboard widget configuration."},"type":{"type":"string","description":"The type of dashboard widget configuration.","enum":["METRIC","CHART","PIE","HEAT_MAP","FREE_TEXT","AGENT_STATUS","REALTIME_ADHERENCE","WEB_CONTENT_URL"]},"metrics":{"type":"array","description":"The list of metrics for the dashboard widget configuration.","items":{"type":"string","enum":["AVG_TALK_TIME","AVG_HOLD_TIME","AVG_ACW_TIME","AVG_WAIT_TIME","AVG_HANDLE_TIME","AVG_ALERT_TIME","AVG_ANSWER_TIME","AVG_ABANDON_TIME","TOTAL_TALK_TIME","TOTAL_HANDLE_TIME","TOTAL_HOLD_TIME","TOTAL_ACW_TIME","TOTAL_ALERT_TIME","MAX_ABANDON_TIME","MAX_WAIT_TIME","MAX_TALK_TIME","MAX_HOLD_TIME","MAX_ACW_TIME","MIN_ABANDON_TIME","MIN_WAIT_TIME","MIN_TALK_TIME","MIN_HOLD_TIME","MIN_ACW_TIME","ALERT_COUNT","OFFERED_COUNT","ABANDONED_COUNT","ABANDONED_PERCENT","SHORT_ABANDONED_COUNT","SHORT_ABANDONED_PERCENT","ABANDONED_NO_SHORT_COUNT","ABANDONED_NO_SHORT_PERCENT","ANSWERED_COUNT","ANSWERED_PERCENT","FLOWOUT_COUNT","FLOWOUT_PERCENT","OUTBOUND_COUNT","OUTBOUND_ATTEMPTED_COUNT","VOICEMAIL_COUNT","HANDLED_COUNT","HELD_COUNT","TRANSFERRED_COUNT","TRANSFERRED_PERCENT","WAITING_CURRENT","INTERACTING_CURRENT","HELD_CURRENT","ALERTING_CURRENT","SERVICE_LEVEL","OVER_SERVICE_LEVEL","ONLINE_AGENTS","AVAILABLE_AGENTS","AWAY_AGENTS","BREAK_AGENTS","MEAL_AGENTS","TRAINING_AGENTS","BUSY_AGENTS","MEETING_AGENTS","SYSTEM_AWAY_AGENTS","OFFLINE_AGENTS","ON_QUEUE_AGENTS","OFF_QUEUE_AGENTS","INTERACTING_AGENTS","ACW_AGENTS","COMMUNICATING_AGENTS","IDLE_AGENTS","NOT_RESPONDING_AGENTS","LONGEST_WAITING","LONGEST_INTERACTING","FLOW_ACTIVE_LONGEST","FLOW_ACTIVE_CURRENT","FLOW_ENTRIES_COUNT","FLOW_TOTAL_DURATION","FLOW_MAX_DURATION","FLOW_AVG_DURATION","FLOW_DISCONNECT_COUNT","FLOW_DISCONNECT_PERCENT","FLOW_TOTAL_DISCONNECT_DURATION","FLOW_AVG_DISCONNECT_DURATION","FLOW_MAX_DISCONNECT_DURATION","FLOW_FLOW_DISCONNECT","FLOW_FLOW_DISCONNECT_PERCENT","FLOW_SYSTEM_ERROR_DISCONNECT","FLOW_SYSTEM_ERROR_DISCONNECT_PERCENT","FLOW_CUSTOMER_DISCONNECT","FLOW_CUSTOMER_DISCONNECT_PERCENT","FLOW_SHORT_DISCONNECT","FLOW_SHORT_DISCONNECT_PERCENT","FLOW_EXIT_COUNT","FLOW_EXIT_PERCENT","FLOW_TOTAL_EXIT_DURATION","FLOW_MAX_EXIT_DURATION","FLOW_AVG_EXIT_DURATION","FLOW_ACD_EXIT_COUNT","FLOW_ACD_EXIT_PERCENT","FLOW_GROUP_EXIT_COUNT","FLOW_GROUP_EXIT_PERCENT","FLOW_NUMBER_EXIT_COUNT","FLOW_NUMBER_EXIT_PERCENT","FLOW_USER_EXIT_COUNT","FLOW_USER_EXIT_PERCENT","FLOW_FLOW_EXIT_COUNT","FLOW_FLOW_EXIT_PERCENT","FLOW_SECURE_FLOW_EXIT_COUNT","FLOW_SECURE_FLOW_EXIT_PERCENT","FLOW_ACD_VOICEMAIL_EXIT_COUNT","FLOW_ACD_VOICEMAIL_EXIT_PERCENT","FLOW_USER_VOICEMAIL_EXIT_COUNT","FLOW_USER_VOICEMAIL_EXIT_PERCENT","FLOW_OUTCOME_COUNT","FLOW_AVG_OUTCOME_DECIMAL","FLOW_OUTCOME_FAILURE_COUNT","FLOW_OUTCOME_FAILURE_PERCENT","FLOW_OUTCOME_SUCCESS_COUNT","FLOW_OUTCOME_SUCCESS_PERCENT","FLOW_OUTCOME_TOTAL_DURATION","FLOW_OUTCOME_MAX_DURATION","FLOW_OUTCOME_AVG_DURATION","FLOW_OUTCOME_MIN_DURATION","OFF_QUEUE_TIME","OFF_QUEUE_PERCENT","AVAILABLE_TIME","AVAILABLE_PERCENT","BUSY_TIME","BUSY_PERCENT","AWAY_TIME","AWAY_PERCENT","BREAK_TIME","BREAK_PERCENT","MEAL_TIME","MEAL_PERCENT","MEETING_TIME","MEETING_PERCENT","TRAINING_TIME","TRAINING_PERCENT","INTERACTING_TIME","INTERACTING_PERCENT","COMMUNICATING_TIME","COMMUNICATING_PERCENT","SYSTEM_AWAY_TIME","SYSTEM_AWAY_PERCENT","ON_QUEUE_TIME","ON_QUEUE_PERCENT","IDLE_TIME","IDLE_PERCENT","NOT_RESPONDING_TIME","NOT_RESPONDING_PERCENT","LOGGED_IN_TIME","OCCUPANCY_PERCENT","MIN_ALERT_TIME","MAX_ALERT_TIME","MIN_HANDLE_TIME","MAX_HANDLE_TIME","MIN_ANSWERED_TIME","MAX_ANSWERED_TIME","MIN_NOT_RESPONDING_TIME","MAX_NOT_RESPONDING_TIME","MET_SERVICE_LEVEL","WFM_ADHERENCE_STATUS","WFM_SCHEDULED_ACTIVITY","WFM_ADHERENCE_DURATION","AGENT_TITLE","AGENT_DEPARTMENT","AGENT_EXTENSION","AGENT_SKILLS","AGENT_LOCATION","AGENT_REPORTS_TO","AGENT_EMAIL","AGENT_ROLE","AGENT_GROUP","AGENT_TIME_IN_STATUS","AGENT_TIME_IN_ROUTING_STATUS","AGENT_STATUS","AGENT_SECONDARY_STATUS","AGENT_ROUTING_STATUS","AGENT_MEDIA_TYPES","ACW_COUNT","ANSWER_TRANSFERRED_PERCENT","FLOW_AVG_MILESTONE_DECIMAL","NOT_RESPONDING_COUNT","AVG_ACW_HANDLED","AVG_CONTACTING_TIME","AVG_DIALING_TIME","AVG_FLOWOUT_TIME","AVG_HOLD_HANDLED","AVG_MONITOR","BLIND_TRANSFER_COUNT","BLIND_TRANSFER_PERCENT","CONNECTED_COUNT","CONSULT_COUNT","CONSULT_TRANSFER_COUNT","CONSULT_TRANSFER_PERCENT","CONTACTING_COUNT","DIALING_COUNT","ERROR_COUNT","EXTERNAL_MEDIA_COUNT","MAX_CONTACTING_TIME","MAX_DIALING_TIME","MAX_FLOWOUT_TIME","FLOW_MILESTONE_COUNT","MIN_FLOWOUT_TIME","MAX_MONITOR","MIN_CONTACTING_TIME","MIN_DIALING_TIME","MIN_MONITOR","MONITOR_COUNT","MEDIA_COUNT","SERVICE_LEVEL_TARGET","SERVICE_LEVEL_TARGET_CURRENT","TALK_COUNT","TOTAL_ABANDON_TIME","TOTAL_NOT_RESPONDING_TIME","TOTAL_CONTACTING","TOTAL_DIALING","TOTAL_MONITOR","TOTAL_WAIT_TIME","WAIT_COUNT","PARK_COUNT","AVG_PARK_TIME","TOTAL_PARK_TIME","MIN_PARK_TIME","MAX_PARK_TIME"]}},"displayText":{"type":"string","description":"The display text for the dashboard widget configuration."},"displayTextColor":{"type":"string","description":"The color of the display text for the dashboard widget configuration in RGB hexadecimal format (for example \"#FF0000\" represents red)."},"webContentUrl":{"type":"string","description":"The external web URL for the dashboard widget configuration."},"splitFilters":{"type":"boolean","description":"Indicates each filter to be displayed individually."},"splitByMediaType":{"type":"boolean","description":"Indicates that data for each media type should be shown individually."},"showLongest":{"type":"boolean","description":"Indicates the display be the longest time."},"displayAsTable":{"type":"boolean","description":"Indicates the widget to be displayed as table."},"showDuration":{"type":"boolean","description":"Indicates the display to include duration."},"sortOrder":{"type":"string","description":"The sort order of the table.","enum":["ascending","descending"]},"sortKey":{"type":"string","description":"The sort key of the table.","enum":["Name","Duration"]},"entityLimit":{"type":"integer","format":"int32","description":"Indicates the limit of displayed entities."},"displayAggregates":{"type":"boolean","description":"Indicates whether to display aggregate across all entity and media type combination."},"isFullWidth":{"type":"boolean","description":"Indicates whether a widget should take the full width of a dashboard or be shown only in a single slot."},"showPercentageChange":{"type":"boolean","description":"Indicates whether a widget should show the percentage diff between two values."},"showProfilePicture":{"type":"boolean","description":"Indicates whether a widget should show the profile picture of an agent."},"filter":{"description":"The filters to be applied for dashboard widget configuration","$ref":"#/definitions/ViewFilter"},"periods":{"type":"array","description":"The list of periods for the dashboard widget configuration","items":{"type":"string","enum":["NONE","CURRENT_HALF_HOUR","TODAY","YESTERDAY","THIS_WEEK","LAST_WEEK","THIS_MONTH","LAST_MONTH","PRIOR_7_DAYS","PAST_7_DAYS_TO_DATE","PRIOR_30_DAYS","PAST_30_DAYS_TO_DATE","PRIOR_3_MONTHS"]}},"mediaTypes":{"type":"array","description":"The list of media types for the dashboard widget configuration","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"warnings":{"type":"array","description":"List of warnings for dashboard widget configuration","items":{"$ref":"#/definitions/Warning"}},"showTimeInStatus":{"type":"boolean","description":"Indicates the show time in status of a widget configuration."},"showOfflineAgents":{"type":"boolean","description":"Indicates to show offline agent widget."},"selectedStatuses":{"type":"array","description":"Indicates the selected statuses used to filter the agent widget in the dashboard.","items":{"type":"string","enum":["Available","Away","Busy","Break","Meeting","Training","Meal","SystemAway","OnQueue","Interacting","NotResponding","Idle","Communicating","OffQueue","Online","Offline"]}}}},"Empty":{"type":"object"},"DashboardConfigurationBulkRequest":{"type":"object","required":["dashboardConfigurationIds"],"properties":{"dashboardConfigurationIds":{"type":"array","description":"The user supplied dashboard configuration ids","items":{"type":"string"}}}},"DashboardConfigurationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DashboardConfiguration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DashboardConfigurationQueryRequest":{"type":"object","required":["dashboardConfigurationIds"],"properties":{"dashboardConfigurationIds":{"type":"array","description":"The user supplied dashboard configuration ids","items":{"type":"string"}},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The order in which response will be sorted","enum":["Asc","Desc"]}}},"DashboardUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dashboardCount":{"type":"integer","format":"int32","description":"The count of dashboards for the user"},"publicDashboardCount":{"type":"integer","format":"int32","description":"The count of public dashboards for the user"},"state":{"type":"string","description":"The state of the user","enum":["active","inactive"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DashboardUserListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DashboardUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportJobResponse":{"type":"object","required":["createdDateTime","exportFormat","filter","interval","locale","modifiedDateTime","percentageComplete","period","read","runId","status","timeZone","viewType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"runId":{"type":"string","description":"The unique run id of the export schedule execute"},"status":{"type":"string","description":"The current status of the export request","enum":["SUBMITTED","RUNNING","CANCELLING","CANCELLED","COMPLETED","COMPLETED_WITH_PARTIAL_RESULTS","FAILED"]},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"downloadUrl":{"type":"string","description":"The url to download the request if it's status is completed"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"exportErrorMessagesType":{"type":"string","description":"The error message in case the export request failed","enum":["FAILED_CONVERTING_EXPORT_JOB","FAILED_NO_DATA_EXPORT_JOB_FOUND","FAILED_GETTING_DATA_FROM_SERVICE","FAILED_GENERATING_TEMP_FILE","FAILED_SAVING_FILE_TO_S3","FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD","FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE","FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB","EXPORT_TYPE_NOT_IMPLEMENTED","REACHED_MAXIMUM_ATTEMPT_OF_RETRY","FAILED_LONG_RUNNING_EXPORT","TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION","FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB","NOT_AUTHORIZED_TO_VIEW_EXPORT","STATIC_LINK_EXPORT_FAILED","TOO_MANY_SEARCH_CRITERIA","SEARCH_CRITERIA_VALUES_EXCEED_LIMIT","EXPORT_EMAIL_FILE_SIZE_EXCEEDED_LIMIT","CIRCUIT_BREAKER_OPEN_FOR_VIEW_TYPE"]},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"createdDateTime":{"type":"string","format":"date-time","description":"The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDateTime":{"type":"string","format":"date-time","description":"The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"percentageComplete":{"type":"number","format":"double","description":"The percentage of the job that has completed processing"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"emailStatuses":{"type":"object","description":"The status of individual email addresses as a map","additionalProperties":{"type":"string","enum":["Sent","Pending","Failed"]}},"emailErrorDescription":{"type":"string","description":"The optional error message in case the export fail to email"},"includeDurationFormatInHeader":{"type":"boolean","description":"Indicates whether to include selected duration format to the column headers"},"durationFormat":{"type":"string","description":"Indicates the duration format for the exports","enum":["Seconds","Milliseconds","Hhmmss","Hms"]},"exportAllowedToRerun":{"type":"boolean","description":"Indicates whether the export run is allowed to rerun"},"enabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SelectedColumns":{"type":"object","properties":{"columnOrder":{"type":"integer","format":"int32","description":"Indicates the order/position of the selected column"},"columnName":{"type":"string","description":"Indicates enum name of the column from the export view"}}},"ReportingExportJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportMetadataJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"viewType":{"type":"string","description":"The view type of the export metadata","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"dateLimitations":{"type":"string","description":"The date limitations of the export metadata"},"requiredFilters":{"type":"array","description":"The list of required filters for the export metadata","items":{"type":"string"}},"supportedFilters":{"type":"array","description":"The list of supported filters for the export metadata","items":{"type":"string"}},"requiredColumnIds":{"type":"array","description":"The list of required column ids for the export metadata","items":{"type":"string"}},"dependentColumnIds":{"type":"object","description":"The list of dependent column ids for the export metadata","additionalProperties":{"type":"array","items":{"type":"string"}}},"availableColumnIds":{"type":"array","description":"The list of available column ids for the export metadata","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportingExportJobRequest":{"type":"object","required":["exportFormat","filter","interval","locale","name","period","timeZone","viewType"],"properties":{"name":{"type":"string","description":"The user supplied name of the export request"},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"locale":{"type":"string","description":"The locale used for localization of the exported data, i.e. en-US, es"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"includeDurationFormatInHeader":{"type":"boolean","description":"Indicates whether to include selected duration format to the column headers"},"durationFormat":{"type":"string","description":"Indicates the duration format for the exports","enum":["Seconds","Milliseconds","Hhmmss","Hms"]}}},"FieldList":{"type":"object","properties":{"customLabels":{"type":"boolean"},"instructionText":{"type":"string"},"key":{"type":"string"},"labelKeys":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":{"type":"object"}},"repeatable":{"type":"boolean"},"state":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"gdpr":{"type":"boolean"}}},"Section":{"type":"object","properties":{"fieldList":{"type":"array","items":{"$ref":"#/definitions/FieldList"}},"instructionText":{"type":"string"},"key":{"type":"string"},"state":{"type":"string"}}},"KnowledgeBaseReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge base."},"languageCode":{"type":"string","description":"Language of the knowledge base","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditQueryEntity":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Entity"},"actions":{"type":"array","description":"List of Actions","items":{"type":"string"}}}},"AuditQueryService":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Service"},"entities":{"type":"array","description":"List of Entities","items":{"$ref":"#/definitions/AuditQueryEntity"}}}},"AuditQueryServiceMapping":{"type":"object","properties":{"services":{"type":"array","description":"List of Services","items":{"$ref":"#/definitions/AuditQueryService"}}}},"AuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"]},"startDate":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Service name for the audit query."},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","ClientId","Action","EntityType","EntityId"]},"value":{"type":"string","description":"Value of the property to filter."}}},"AuditQuerySort":{"type":"object","required":["name","sortOrder"],"properties":{"name":{"type":"string","description":"Name of the property to sort.","enum":["Timestamp"]},"sortOrder":{"type":"string","description":"Sort Order","enum":["ascending","descending"]}}},"AuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIp":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message."},"level":{"type":"string","description":"Level of this audit message, USER or SYSTEM.","enum":["USER","SYSTEM","GENESYS_INTERNAL"]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"message":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place."},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted."},"status":{"type":"string","description":"Status of the event being audited","enum":["SUCCESS","FAILURE","WARNING"]},"application":{"type":"string","description":"Name of the application used to perform the audit's action"},"initiatingAction":{"description":"Id and action of the audit initiating the transaction","$ref":"#/definitions/InitiatingAction"},"transactionInitiator":{"type":"boolean","description":"Whether the current audit is the initiator of the transaction"},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}},"entityChanges":{"type":"array","description":"List of entities that were changed and changes made to those entities.","items":{"$ref":"#/definitions/EntityChange"}}}},"AuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"EntityChange":{"type":"object","properties":{"entityId":{"type":"string","description":"Id of the entity that was changed"},"entityName":{"type":"string","description":"Name of the entity that was changed"},"entityType":{"type":"string","description":"Type of the entity that was changed"},"oldValues":{"type":"array","description":"Previous values for the entity.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the entity.","items":{"type":"string"}}}},"InitiatingAction":{"type":"object","properties":{"transactionId":{"type":"string","description":"Id of the audit initiating the transaction"},"actionContext":{"type":"string","description":"Action of the audit initiating the transaction"}}},"MessageInfo":{"type":"object","properties":{"localizableMessageCode":{"type":"string","description":"Key that can be used to localize the message."},"message":{"type":"string","description":"Description of the message."},"messageWithParams":{"type":"string","description":"Message with template fields for variable replacement."},"messageParams":{"type":"object","description":"Map with fields for variable replacement.","additionalProperties":{"type":"string"}}}},"PropertyChange":{"type":"object","properties":{"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"Previous values for the property.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the property.","items":{"type":"string"}}}},"AuditQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ"},"serviceName":{"type":"string","description":"Name of the service to query audits for."},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditRealtimeQueryResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"AuditRealtimeQueryRequest":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ"},"serviceName":{"type":"string","description":"Name of the service to query audits for."},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}},"pageNumber":{"type":"integer","format":"int32","description":"Page number"},"pageSize":{"type":"integer","format":"int32","description":"Page size"}}},"AuditRealtimeRelatedResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"AuditRealtimeRelatedRequest":{"type":"object","required":["auditId"],"properties":{"auditId":{"type":"string","description":"The id of the audit of which related audits will be retrieved."},"trustorOrgId":{"type":"string","description":"The id of the trustor org to which the audit belongs. Used when searching for audits performed by a trustee user within a trustor org."},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuthzGrant":{"type":"object","properties":{"subjectId":{"type":"string"},"division":{"$ref":"#/definitions/AuthzDivision"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"version":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivisionGrants":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","description":"A list containing pairs of role and division IDs","items":{"$ref":"#/definitions/RoleDivisionPair"}}}},"RoleDivisionPair":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"The ID of the role"},"divisionId":{"type":"string","description":"The ID of the division"}}},"UserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzDivisionGrantEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DivsPermittedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"allDivsPermitted":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthorizationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"analysisEnabled":{"type":"boolean","description":"Boolean showing if organization is opted in or not to unused role/perm analysis"},"analysisDays":{"type":"integer","format":"int32","description":"Integer number of days to analyze user usage"},"dateLastCalculated":{"type":"string","format":"date-time","description":"The date and time of the most recent unused role calculation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateLastActive":{"type":"string","format":"date","description":"The date of the most recent org activity used for analysis. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT","AGENT_REQUESTED"]},"timeoutMs":{"type":"integer","format":"int32","description":"The amount of time the agent can stay in ACW (Min: 1 sec, Max: 15 min). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT."}}},"AgentOwnedRouting":{"type":"object","properties":{"enableAgentOwnedCallbacks":{"type":"boolean","description":"Indicates if Agent Owned Callbacks are enabled for the queue"},"maxOwnedCallbackHours":{"type":"integer","format":"int32","description":"The max amount of time a callback can be owned (in hours); Allowable range 1 - 168 hour(s) (inclusive)"},"maxOwnedCallbackDelayHours":{"type":"integer","format":"int32","description":"The max amount of time a callback can be scheduled out into the future (in hours); Allowable range 1 - 720 hour(s) (inclusive)"}}},"BaseMediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","description":"The bullseye rings configured for this queue.","items":{"$ref":"#/definitions/Ring"}}}},"CallbackMediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."},"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"The alerting timeout for the media type, in seconds"},"serviceLevel":{"description":"The targeted service level for the media type","$ref":"#/definitions/ServiceLevel"},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for an auto-answer interaction"},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for a manual-answer interaction"},"subTypeSettings":{"type":"object","description":"Map of media subtype to media subtype specific settings.","additionalProperties":{"$ref":"#/definitions/BaseMediaSettings"}},"enableAutoDialAndEnd":{"type":"boolean","description":"Flag to enable Auto-Dial and Auto-End automation for callbacks on this queue."},"autoDialDelaySeconds":{"type":"integer","format":"int32","description":"Time in seconds after agent connects to callback before outgoing call is auto-dialed. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds."},"autoEndDelaySeconds":{"type":"integer","format":"int32","description":"Time in seconds after agent disconnects from the outgoing call before the encasing callback is auto-ended. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds."}}},"CannedResponseLibraries":{"type":"object","properties":{"libraryIds":{"type":"array","description":"Set of canned response library IDs associated with the queue only when mode is SelectedOnly.","uniqueItems":true,"items":{"type":"string"}},"mode":{"type":"string","description":"The association mode of canned response libraries to queue","enum":["All","SelectedOnly","None"]}}},"ConditionalGroupRouting":{"type":"object","properties":{"rules":{"type":"array","description":"The set of rules to be executed for each conversation","items":{"$ref":"#/definitions/ConditionalGroupRoutingRule"}}}},"ConditionalGroupRoutingRule":{"type":"object","properties":{"queue":{"description":"The queue being evaluated for this rule. If null, the current queue will be used.","$ref":"#/definitions/DomainEntityRef"},"metric":{"type":"string","description":"The queue metric being evaluated","enum":["EstimatedWaitTime","ServiceLevel"]},"operator":{"type":"string","description":"The operator that compares the actual value against the condition value","enum":["GreaterThan","GreaterThanOrEqualTo","LessThan","LessThanOrEqualTo"]},"conditionValue":{"type":"number","format":"double","description":"The limit value, beyond which a rule evaluates as true"},"groups":{"type":"array","description":"The group(s) to activate if the rule evaluates as true","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"waitSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait in this rule, if it evaluates as true, before evaluating the next rule. For the final rule, this is ignored, so need not be specified."}}},"DirectRouting":{"type":"object","properties":{"callMediaSettings":{"description":"Direct Routing Settings specific to Call media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"emailMediaSettings":{"description":"Direct Routing Settings specific to Email media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"messageMediaSettings":{"description":"Direct Routing Settings specific to Message media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"backupQueueId":{"type":"string","description":"ID of another queue to be used as the default backup if an agent does not have their Backup Settings configured. If not set, the current queue will be used as backup, but with Direct Routing criteria removed from the conversation."},"waitForAgent":{"type":"boolean","description":"Flag indicating if Direct Routing interactions should wait for Direct Routing agent or go immediately to selected backup."},"agentWaitSeconds":{"type":"integer","format":"int32","description":"Time (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000]."}}},"DirectRoutingMediaSettings":{"type":"object","properties":{"useAgentAddressOutbound":{"type":"boolean","description":"Toggle that enables using an agent's Direct Routing address outbound on behalf of queue for this media type."}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"InboundRoute":{"type":"object","required":["fromName","pattern"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/DomainEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/DomainEntityRef"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"flow":{"description":"The flow to use for processing the email.","$ref":"#/definitions/DomainEntityRef"},"replyEmailAddress":{"description":"The route to use for email replies.","$ref":"#/definitions/QueueEmailAddress"},"autoBcc":{"type":"array","description":"The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.","items":{"$ref":"#/definitions/EmailAddress"}},"spamFlow":{"description":"The flow to use for processing inbound emails that have been marked as spam.","$ref":"#/definitions/DomainEntityRef"},"signature":{"description":"The configuration for the canned response signature that will be appended to outbound emails sent via this route","$ref":"#/definitions/Signature"},"historyInclusion":{"type":"string","description":"The configuration to indicate how the history of a conversation has to be included in a draft","enum":["Include","Exclude","Optional"]},"allowMultipleActions":{"type":"boolean","description":"Control if multiple actions are allowed on this route. When true the disconnect has to be done manually. When false a conversation will be disconnected by the system after every action"},"imapFolder":{"type":"string","description":"Imap folder routed to this route"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."},"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"The alerting timeout for the media type, in seconds"},"serviceLevel":{"description":"The targeted service level for the media type","$ref":"#/definitions/ServiceLevel"},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for an auto-answer interaction"},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for a manual-answer interaction"},"subTypeSettings":{"type":"object","description":"Map of media subtype to media subtype specific settings.","additionalProperties":{"$ref":"#/definitions/BaseMediaSettings"}}}},"MemberGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","description":"The group type","enum":["TEAM","GROUP","SKILLGROUP"]},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this group","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PredictiveRouting":{"type":"object","properties":{"respectSkills":{"type":"boolean","description":"A switch used to determine if agent skills will be considered."},"enableConversationScoreBiasing":{"type":"boolean","description":"A switch used to determine if conversations are weighted by conversation score when the system attempts to assign an agent a new conversation."}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueEmailAddress":{"type":"object","properties":{"domain":{"$ref":"#/definitions/DomainEntityRef"},"route":{"$ref":"#/definitions/InboundRoute"}}},"QueueMediaSettings":{"type":"object","properties":{"call":{"description":"The queue media settings for call interactions.","$ref":"#/definitions/MediaSettings"},"callback":{"description":"The queue media settings for callback interactions.","$ref":"#/definitions/CallbackMediaSettings"},"chat":{"description":"The queue media settings for chat interactions.","$ref":"#/definitions/MediaSettings"},"email":{"description":"The queue media settings for email interactions.","$ref":"#/definitions/MediaSettings"},"message":{"description":"The queue media settings for message interactions.","$ref":"#/definitions/MediaSettings"}}},"QueueMessagingAddresses":{"type":"object","properties":{"smsAddress":{"$ref":"#/definitions/DomainEntityRef"},"openMessagingRecipient":{"$ref":"#/definitions/DomainEntityRef"},"whatsAppRecipient":{"$ref":"#/definitions/DomainEntityRef"}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","description":"The conditions that will trigger conversations to move to the next bullseye ring.","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"description":"The actions that will be performed just before moving conversations to the next bullseye ring.","$ref":"#/definitions/Actions"},"memberGroups":{"type":"array","description":"The groups of agents associated with the ring, if any. Ring membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}}}},"RoutingRule":{"type":"object","properties":{"operator":{"type":"string","description":"matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score.","enum":["MEETS_THRESHOLD","ANY"]},"threshold":{"type":"integer","format":"int32","description":"threshold required for routing attempt (generally an agent score). may be null for operator ANY."},"waitSeconds":{"type":"number","format":"double","description":"seconds to wait in this rule before moving to the next"}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double","description":"The desired Service Level. A value between 0 and 1."},"durationMs":{"type":"integer","format":"int64","description":"Service Level target in milliseconds."}}},"Signature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"A toggle to enable the signature on email send."},"cannedResponseId":{"type":"string","description":"The identifier referring to an email signature canned response."},"alwaysIncluded":{"type":"boolean","description":"A toggle that defines if a signature is always included or only set on the first email in an email chain."},"inclusionType":{"type":"string","description":"The configuration to indicate when the signature of a conversation has to be included","enum":["Draft","Send","SendOnce"]}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"SubjectDivisions":{"type":"object","required":["divisionIds","subjectIds"],"properties":{"subjectIds":{"type":"array","description":"A collection of subject IDs to associate with the given divisions","items":{"type":"string"}},"divisionIds":{"type":"array","description":"A collection of division IDs to associate with the given subjects","items":{"type":"string"}}}},"DomainOrganizationRoleUpdate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string","description":"The name of the role"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationRoleCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string","description":"The role name"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"allowsConditions":{"type":"boolean"},"divisionAware":{"type":"boolean"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"OrganizationProductEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"SubjectDivisionGrants":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"divisions":{"type":"array","items":{"$ref":"#/definitions/Division"}},"type":{"type":"string","enum":["PC_USER","PC_GROUP","PC_OAUTH_CLIENT","PC_TRUSTEE_USER","PC_TRUSTEE_GROUP","UNKNOWN"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubjectDivisionGrantsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SubjectDivisionGrants"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"ErrorBody":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}},"limit":{"$ref":"#/definitions/Limit"}}},"Limit":{"type":"object","properties":{"key":{"type":"string"},"namespace":{"type":"string","enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"value":{"type":"integer","format":"int64"}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["COUNT","SUM","AVERAGE","TERM","CONTAINS","STARTS_WITH","ENDS_WITH"]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"SearchSort":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"}}},"SignedData":{"type":"object","properties":{"jwt":{"type":"string"}}},"ScreenRecordingUserAuthenticatedInfo":{"type":"object","required":["backgroundAssistantId"],"properties":{"backgroundAssistantId":{"type":"string","description":"Id of Genesys Cloud Background Assistant"}}},"UrlResponse":{"type":"object","properties":{"url":{"type":"string"}}},"BillingUsage":{"type":"object","required":["name","resources","totalUsage"],"properties":{"name":{"type":"string","description":"Identifies the billable usage."},"totalUsage":{"type":"string","description":"The total amount of usage, expressed as a decimal number in string format."},"resources":{"type":"array","description":"The resources for which usage was observed (e.g. license users, devices).","items":{"$ref":"#/definitions/BillingUsageResource"}}}},"BillingUsageReport":{"type":"object","required":["endDate","startDate","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"Generation status of report","enum":["InProgress","Complete"]},"usages":{"type":"array","description":"The usages for the given period.","items":{"$ref":"#/definitions/BillingUsage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingUsageResource":{"type":"object","required":["date","name"],"properties":{"name":{"type":"string","description":"Identifies the resource (e.g. license user, device)."},"date":{"type":"string","format":"date-time","description":"The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"SubscriptionOverviewUsage":{"type":"object","required":["grouping","name","partNumber","prepayQuantity","unitOfMeasureType","usageQuantity"],"properties":{"name":{"type":"string","description":"Product charge name"},"partNumber":{"type":"string","description":"Product part number"},"grouping":{"type":"string","description":"UI grouping key"},"unitOfMeasureType":{"type":"string","description":"UI unit of measure"},"usageQuantity":{"type":"string","description":"Usage count for specified period"},"overagePrice":{"type":"string","description":"Price for usage / overage charge"},"prepayQuantity":{"type":"string","description":"Items prepaid for specified period"},"prepayPrice":{"type":"string","description":"Price for prepay charge"},"usageNotes":{"type":"string","description":"Notes about the usage/charge item"},"isCancellable":{"type":"boolean","description":"Indicates whether the item is cancellable"},"bundleQuantity":{"type":"string","description":"Quantity multiplier for this charge"},"isThirdParty":{"type":"boolean","description":"A charge from a third party entity"}}},"TrusteeBillingOverview":{"type":"object","required":["currency","enabledProducts","organization","subscriptionType","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"organization":{"description":"Organization","$ref":"#/definitions/NamedEntity"},"currency":{"type":"string","description":"The currency type."},"enabledProducts":{"type":"array","description":"The charge short names for products enabled during the specified period.","items":{"type":"string"}},"subscriptionType":{"type":"string","description":"The subscription type.","enum":["ININ","MONTH_TO_MONTH","FREE_TRIAL_MONTH_TO_MONTH","PREPAY_MONTHLY_COMMITMENT","PREPAY","DEV_ORG_MONTH_TO_MONTH","DEV_ORG_PREPAY_MONTHLY_COMMITMENT","DEV_ORG_PREPAY"]},"rampPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rampPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"usages":{"type":"array","description":"Usages for the specified period.","items":{"$ref":"#/definitions/SubscriptionOverviewUsage"}},"contractAmendmentDate":{"type":"string","format":"date-time","description":"Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEndDate":{"type":"string","format":"date-time","description":"Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"minimumMonthlyAmount":{"type":"string","description":"Minimum amount that will be charged for the month"},"inRampPeriod":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","description":"Whether or not CallForwarding is enabled"},"phoneNumber":{"type":"string","description":"This property is deprecated. Please use the calls property"},"calls":{"type":"array","description":"An ordered list of CallRoutes to be executed when CallForwarding is enabled","items":{"$ref":"#/definitions/CallRoute"}},"voicemail":{"type":"string","description":"The type of voicemail to use with the callForwarding configuration","enum":["PURECLOUD","LASTCALL","NONE"]},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallRoute":{"type":"object","properties":{"targets":{"type":"array","description":"A list of CallTargets to be called when the CallRoute is executed","items":{"$ref":"#/definitions/CallTarget"}}}},"CallTarget":{"type":"object","properties":{"type":{"type":"string","description":"The type of call","enum":["STATION","PHONENUMBER"]},"value":{"type":"string","description":"The id of the station or an E.164 formatted phone number"}}},"EmergencyLocation":{"type":"object","required":["address","did","source"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"address":{"description":"Emergency address","$ref":"#/definitions/LocationAddress"},"did":{"type":"string","description":"Phone number in E164 format"},"source":{"type":"string","description":"source","enum":["Admin","User"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"Organization":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"defaultLanguage":{"type":"string","description":"The default language for this organization. Example: 'en'"},"defaultCountryCode":{"type":"string","description":"The default country code for this organization. Example: 'US'"},"thirdPartyOrgName":{"type":"string","description":"The short name for the organization. This field is globally unique and cannot be changed.","readOnly":true},"thirdPartyURI":{"type":"string","format":"uri"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","description":"The current state. Examples are active, inactive, deleted.","enum":["active","inactive","deleted"]},"defaultSiteId":{"type":"string"},"supportURI":{"type":"string","description":"Email address where support tickets are sent to."},"voicemailEnabled":{"type":"boolean"},"productPlatform":{"type":"string","description":"Organizations Originating Platform.","readOnly":true,"enum":["GenesysCloud","PureCloud","PureEngage","PureEngageCloud","PureConnect","PureConnectCloud","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"features":{"type":"object","description":"The state of features available for the organization.","readOnly":true,"additionalProperties":{"type":"boolean"}}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object"}}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise."},"signatureValid":{"type":"boolean"},"valid":{"type":"boolean"}},"description":"Represents the details of a parsed certificate."},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"ChatSettings":{"type":"object","properties":{"messageRetentionPeriodDays":{"type":"integer","format":"int32","description":"Retention time for messages in days"}}},"ChatMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatMessageResponse"}}}},"ChatMessageResponse":{"type":"object","required":["body","dateCreated","id","jid","thread","toJid"],"properties":{"id":{"type":"string","description":"The id of the message"},"dateCreated":{"type":"string","format":"date-time","description":"Message's created time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Message's last updated time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toJid":{"type":"string","description":"Jid of message's recipient (roomJid or userJid)"},"jid":{"type":"string","description":"Jid of message's sender (userJid)"},"body":{"type":"string","description":"Message's body"},"mentions":{"type":"object","description":"Message's mentions","additionalProperties":{"type":"string"}},"edited":{"type":"boolean","description":"If message was edited"},"attachmentDeleted":{"type":"boolean","description":"If message's attachment was deleted"},"fileUri":{"type":"string","description":"URI of file attachment"},"thread":{"description":"The id for a thread this message corresponds to","$ref":"#/definitions/Entity"},"parentThread":{"description":"Parent thread id for thread replies","$ref":"#/definitions/Entity"},"user":{"description":"The user who sent the message","$ref":"#/definitions/AddressableEntityRef"},"toUser":{"description":"The receiving user of the message","$ref":"#/definitions/AddressableEntityRef"},"reactions":{"type":"array","description":"The emoji reactions to this message","items":{"$ref":"#/definitions/ChatReaction"}}}},"ChatReaction":{"type":"object","required":["emoji","users"],"properties":{"emoji":{"type":"string","description":"The emoji string for the reaction"},"users":{"type":"array","description":"The users that reacted with an emoji","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"MetadataItem":{"type":"object","properties":{"text":{"type":"string","description":"The text contents of the metadata"},"attributes":{"type":"object","description":"The custom attributes for the metadata","additionalProperties":{"type":"string"}}}},"ChatReactionUpdate":{"type":"object","required":["reactions"],"properties":{"reactions":{"type":"array","description":"Reactions to update","items":{"type":"string"}}}},"ChatSendMessageResponse":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the created message"}}},"SendMessageBody":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The body of the message"},"mentions":{"type":"array","description":"user ids to be notified","items":{"type":"string"}},"threadId":{"type":"string","description":"The thread id of the message"}}},"PinnedMessageRequest":{"type":"object","required":["pinnedMessageIds"],"properties":{"pinnedMessageIds":{"type":"array","description":"Ids of the messages to pin","items":{"type":"string"}}}},"RoomParticipant":{"type":"object","required":["participantJid"],"properties":{"participantJid":{"type":"string","description":"participantJid"}}},"RoomParticipantResponse":{"type":"object","properties":{"jid":{"type":"string","description":"jid of the participant"},"user":{"description":"User id of the participant","$ref":"#/definitions/AddressableEntityRef"}}},"RoomParticipantsResponse":{"type":"object","properties":{"participants":{"type":"array","description":"list of room participants","items":{"$ref":"#/definitions/RoomParticipantResponse"}}}},"Room":{"type":"object","properties":{"id":{"type":"string","description":"The jid of the room","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Room's created time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomType":{"type":"string","description":"The type of room","enum":["adhoc","acd","group","oneOnOne","supervisorAssistance"]},"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"participantLimit":{"type":"integer","format":"int32","description":"Room's size limit"},"owners":{"type":"array","description":"Room's owners","items":{"$ref":"#/definitions/UserReference"}},"pinnedMessages":{"type":"array","description":"Room's pinned messages","items":{"$ref":"#/definitions/AddressableEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoomUpdateRequest":{"type":"object","properties":{"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"pinnedMessageIds":{"type":"array","description":"Room's pinned messages","items":{"type":"string"}},"ownerIds":{"type":"array","description":"Room's owners","items":{"type":"string"}}}},"CreateRoomResponse":{"type":"object","required":["jid"],"properties":{"jid":{"type":"string","description":"The jid of the room"}}},"CreateRoomRequest":{"type":"object","required":["subject"],"properties":{"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"userIds":{"type":"array","description":"Users to add to the room","items":{"type":"string"}}}},"CobrowseWebMessagingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"joinCode":{"type":"string","description":"Cobrowse session join code","readOnly":true},"websocketUrl":{"type":"string","description":"WebSocket URL for the JS client","readOnly":true},"dateOfferEnds":{"type":"string","format":"date-time","description":"Date when Cobrowse Offer Expires. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"communicationType":{"type":"string","description":"CommunicationType for Cobrowse Session","readOnly":true,"enum":["Call","Message","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExportScriptResponse":{"type":"object","properties":{"url":{"type":"string"}}},"ExportScriptRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"The final file name (no extension) of the script download: .script"},"versionId":{"type":"string","description":"The UUID version of the script to be exported. Defaults to the current editable version."}},"description":"Creating an exported script via Download Service"},"ImportScriptStatusResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"succeeded":{"type":"boolean"},"message":{"type":"string"}}},"ScriptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishScriptRequestData":{"type":"object","required":["scriptId"],"properties":{"scriptId":{"type":"string","description":"The id of the script to publish"},"versionId":{"type":"string"}}},"ConversationEncryptionConfiguration":{"type":"object","required":["keyConfigurationType","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"keyConfigurationType is always KmsSymmetric, and should be the arn to the key alias for the master key"},"keyConfigurationType":{"type":"string","description":"Type should be 'KmsSymmetric' when create or update Key configurations, 'None' to disable configuration.","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"lastError":{"description":"The error message related to the configuration","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"AiScoringSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if AI scoring feature is configured, false if not."},"prompt":{"type":"string","description":"The prompt text that would be used by a LLM."}}},"AnswerOption":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"value":{"type":"integer","format":"int32"},"assistanceConditions":{"type":"array","description":"List of assistance conditions which are combined together with a logical AND operator. Eg ( assistanceCondtion1 && assistanceCondition2 ) wherein assistanceCondition could be ( EXISTS topic1 || topic2 || ... ) or (NOTEXISTS topic3 || topic4 || ...).","items":{"$ref":"#/definitions/AssistanceCondition"}}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"]}}},"AssistanceCondition":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for the assistance condition. The operator defines whether the listed topicIds should EXIST or NOTEXIST for the condition to be evaluated as true.","enum":["EXISTS","NOTEXISTS"]},"topicIds":{"type":"array","description":"List of topicIds within the assistance condition which would be combined together using logical OR operator. Eg ( topicId_1 || topicId_2 ) .","items":{"type":"string"}}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"},"durationMode":{"type":"string","enum":["Between","Over","Under"]}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","enum":["YES","NO"]}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"EvaluationForm":{"type":"object","required":["name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"publishedVersions":{"description":"A list of the published versions of this form. Not populated by default, its availability depends on the endpoint. Use the 'expand=publishHistory' query parameter to retrieve this data where applicable (refer to the endpoint description to see if it is applicable).","$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"isKill":{"type":"boolean"},"isCritical":{"type":"boolean"}}},"EvaluationQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"EvaluationSettings":{"type":"object","properties":{}},"EvaluationSettingsAssignee":{"type":"object","properties":{}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean"},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"IntegrationExport":{"type":"object","required":["integration"],"properties":{"integration":{"description":"The aws-s3-recording-bulk-actions-integration that the policy uses for exports.","$ref":"#/definitions/DomainEntityRef"},"shouldExportScreenRecordings":{"type":"boolean","description":"True if the policy should export screen recordings in addition to the other conversation media. Default = true"}}},"Language":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The language name."},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["active","inactive","deleted"]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/MessageMediaPolicy"}}},"MediaTranscription":{"type":"object","properties":{"displayName":{"type":"string"},"transcriptionProvider":{"type":"string","enum":["VOCI","CALLJOURNEY"]},"integrationId":{"type":"string"}}},"MessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"MessageMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","enum":["YES","NO"]}}},"MeteredAssignmentByAgent":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"timeInterval":{"$ref":"#/definitions/TimeInterval"},"timeZone":{"type":"string"}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean"},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"assignSurveys":{"type":"array","items":{"$ref":"#/definitions/SurveyAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","description":"This condition is to filter out conversation with and without customer participation.","enum":["YES","NO"]}}},"PolicyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"PublishedSurveyFormReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contextId":{"type":"string","description":"The context id of this form."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"StarrableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyAssignment":{"type":"object","required":["sendingDomain"],"properties":{"surveyForm":{"description":"The survey form used for this survey.","$ref":"#/definitions/PublishedSurveyFormReference"},"flow":{"description":"The URI reference to the flow associated with this survey.","$ref":"#/definitions/DomainEntityRef"},"inviteTimeInterval":{"type":"string","description":"An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days."},"sendingUser":{"type":"string","description":"User together with sendingDomain used to send email, null to use no-reply"},"sendingDomain":{"type":"string","description":"Validated email domain, required"}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean"}}},"TimeInterval":{"type":"object","properties":{"months":{"type":"integer","format":"int32"},"weeks":{"type":"integer","format":"int32"},"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string","description":"start time in xx:xx:xx.xxx format"},"stopTime":{"type":"string","description":"stop time in xx:xx:xx.xxx format"},"day":{"type":"integer","format":"int32","description":"Day for this time slot, Monday = 1 ... Sunday = 7"}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"UserReferenceWithName":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VisibilityCondition":{"type":"object","properties":{"combiningOperation":{"type":"string","enum":["AND","OR"]},"predicates":{"type":"array","description":"A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based","items":{"type":"object"}}}},"WrapupCode":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/StarrableDivision"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","description":"The ID of the user that created the wrap-up code."},"modifiedBy":{"type":"string","description":"The ID of the user that modified the wrap-up code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformCallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CrossPlatformChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"CrossPlatformEmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"CrossPlatformMediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CrossPlatformCallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/CrossPlatformChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/CrossPlatformEmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/CrossPlatformMessageMediaPolicy"}}},"CrossPlatformMessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"CrossPlatformPolicy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"CrossPlatformPolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyUpdate":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"PolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyUpdate":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"keydataSummary":{"type":"string","description":"key data summary (base 64 encoded public key)"},"user":{"description":"user that requested generation of public key","$ref":"#/definitions/User"},"localEncryptionConfiguration":{"description":"Local configuration","$ref":"#/definitions/LocalEncryptionConfiguration"},"keyConfigurationType":{"type":"string","description":"Key type used in this configuration","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"kmsKeyArn":{"type":"string","description":"ARN of internal key to be wrapped by AWS KMS Symmetric key"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocalEncryptionConfiguration":{"type":"object","required":["apiId","apiKey","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The url for decryption. This must specify the path to where Purecloud can requests decryption"},"apiId":{"type":"string","description":"The api id for Hawk Authentication."},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocalEncryptionKeyRequest":{"type":"object","required":["configId","keypairId","publicKey"],"properties":{"configId":{"type":"string","description":"The local configuration id that contains metadata on private local service"},"publicKey":{"type":"string","description":"Base 64 encoded public key, generated by the local service."},"keypairId":{"type":"string","description":"The key pair id from the local service."}}},"RecordingEncryptionConfiguration":{"type":"object","required":["keyConfigurationType","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"When keyConfigurationType is LocalKeyManager, this should be the url for decryption and must specify the path to where GenesysCloud can requests decryption. When keyConfigurationType is KmsSymmetric, this should be the arn to the key alias for the master key"},"apiId":{"type":"string","description":"The api id for Hawk Authentication. Null if keyConfigurationType is KmsSymmetric"},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication. Null if keyConfigurationType is KmsSymmetric"},"keyConfigurationType":{"type":"string","description":"Type should be LocalKeyManager or KmsSymmetric when create or update Key configurations; 'Native' for disabling configuration.","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"lastError":{"description":"The error message related to the configuration","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"BulkDeleteResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultVoidEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkError":{"type":"object","properties":{"message":{"type":"string","description":"Error message of the bulk operation result."},"code":{"type":"string","description":"Error code of the bulk operation result."}}},"BulkErrorDetail":{"type":"object","properties":{"fieldName":{"type":"string"},"value":{"type":"string"},"message":{"type":"string"}}},"BulkErrorEntity":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Entity"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkResponseResultVoidEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Void"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"Void":{"type":"object"},"BulkIdsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContactsEntity"}}}},"ExternalContactsEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"BulkFetchContactsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalContactEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalContactEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"ContactAddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ContactIdentifier":{"type":"object","required":["type","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of this identifier","enum":["SocialLine","SocialFacebook","SocialTwitter","SocialWhatsapp","Email","Phone","Cookie"]},"value":{"type":"string","description":"The string value of the identifier. Will vary in syntax by type."},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataSchema":{"type":"object","required":["jsonSchema","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The schema's version, a positive integer. Required for updates."},"appliesTo":{"type":"array","description":"One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","EXTERNAL_ORGANIZATION","OPEN_ACTION","WORKITEM"]}},"enabled":{"type":"boolean","description":"The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."},"createdBy":{"description":"The URI of the user that created this schema.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"jsonSchema":{"example":"{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}","description":"A JSON schema defining the extension to the built-in entity type.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"firstName":{"type":"string","description":"The first name of the contact."},"middleName":{"type":"string"},"lastName":{"type":"string","description":"The last name of the contact."},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"twitterId":{"$ref":"#/definitions/TwitterId"},"lineId":{"$ref":"#/definitions/LineId"},"whatsAppId":{"$ref":"#/definitions/WhatsAppId"},"facebookId":{"$ref":"#/definitions/FacebookId"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"surveyOptOut":{"type":"boolean"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"type":{"type":"string","description":"The type of contact","readOnly":true,"enum":["Ephemeral","Identified","Curated"]},"canonicalContact":{"description":"The contact at the head of the merge tree. If null, this contact is not a part of any merge.","readOnly":true,"$ref":"#/definitions/ContactAddressableEntityRef"},"mergeSet":{"type":"array","description":"The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.","readOnly":true,"items":{"$ref":"#/definitions/ContactAddressableEntityRef"}},"mergeOperation":{"description":"Information about the merge history of this contact. If null, this contact is not a part of any merge.","readOnly":true,"$ref":"#/definitions/MergeOperation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string","description":"The platform that was the source of the data. Example: a CRM like SALESFORCE.","enum":["SALESFORCE"]},"url":{"type":"string","description":"An URL that links to the source record that contributed data to the associated entity."}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"ExternalId":{"type":"object","properties":{"externalSource":{"$ref":"#/definitions/ExternalSource"},"value":{"type":"string"}}},"ExternalOrganization":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the company."},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"twitterId":{"$ref":"#/definitions/TwitterId"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"trustor":{"$ref":"#/definitions/Trustor"},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalSource":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the external source."},"active":{"type":"boolean"},"linkConfiguration":{"$ref":"#/definitions/LinkConfiguration"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/FacebookScopedId"}},"displayName":{"type":"string","description":"The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API."}},"description":"User information for a Facebook user interacting with a page or app"},"FacebookScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for a Facebook user interacting with a page or app"},"InstagramId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to an Instagram page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/InstagramScopedId"}},"displayName":{"type":"string","description":"The displayName of the person who owns this Instagram account"}},"description":"User information for an Instagram account"},"InstagramScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for an Instagram user interacting with a page or app"},"JsonSchemaDocument":{"type":"object","properties":{"id":{"type":"string"},"$schema":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"additionalProperties":{"type":"object"}},"description":"A JSON Schema document."},"LineId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/LineUserId"}},"displayName":{"type":"string","description":"The displayName of this person's account in Line"}},"description":"User information for a Line account"},"LineUserId":{"type":"object","properties":{"userId":{"type":"string","description":"The unique channel-specific userId for the user"}},"description":"Channel-specific User ID for Line accounts"},"LinkConfiguration":{"type":"object","properties":{"uriTemplate":{"type":"string"}}},"MergeOperation":{"type":"object","properties":{"sourceContact":{"description":"The source contact for the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"targetContact":{"description":"The target contact for the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"resultingContact":{"description":"The contact created as a result of the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"OrgUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"organization":{"$ref":"#/definitions/Organization"}}},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string","description":"The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field."},"extension":{"type":"integer","format":"int64","description":"An optional extension for the provided phone number."},"acceptsSMS":{"type":"boolean","description":"Whether this phone number can accept SMS messages."},"normalizationCountryCode":{"type":"string","description":"The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."},"userInput":{"type":"string","description":"The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."},"e164":{"type":"string","description":"The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."},"countryCode":{"type":"string","description":"The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"TrusteeAuthorization":{"type":"object","properties":{"permissions":{"type":"array","description":"Permissions that the trustee user has in the trustor organization","readOnly":true,"items":{"type":"string"}}}},"Trustor":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"authorization":{"description":"Authorization for the trustee user has in this trustor organization","readOnly":true,"$ref":"#/definitions/TrusteeAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterId":{"type":"object","properties":{"id":{"type":"string","description":"twitter user.id_str"},"name":{"type":"string","description":"twitter user.name"},"screenName":{"type":"string","description":"twitter user.screen_name"},"verified":{"type":"boolean","description":"whether this data has been verified using the twitter API","readOnly":true},"profileUrl":{"type":"string","description":"url of user's twitter profile","readOnly":true}},"description":"User information for a twitter account"},"WhatsAppId":{"type":"object","properties":{"phoneNumber":{"description":"The phone number associated with this WhatsApp account","$ref":"#/definitions/PhoneNumber"},"displayName":{"type":"string","description":"The displayName of this person's account in WhatsApp"}},"description":"User information for a WhatsApp account"},"WritableStarrableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkContactsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalContactExternalContact"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkErrorExternalContact":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkResponseResultExternalContactExternalContact":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"error":{"$ref":"#/definitions/BulkErrorExternalContact"}}},"BulkContactsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}}}},"BulkErrorNote":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkNotesResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultNoteNote"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultNoteNote":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"error":{"$ref":"#/definitions/BulkErrorNote"}}},"Note":{"type":"object","required":["createdBy"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"entityId":{"type":"string","description":"The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs."},"entityType":{"type":"string","description":"This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.","enum":["contact","organization"]},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"When creating or updating a note, only User.id is required. User object is fully populated when expanding a note.","$ref":"#/definitions/User"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkNotesRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}}}},"BulkFetchNotesResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultNoteEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultNoteEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"BulkErrorExternalOrganization":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkOrganizationsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalOrganizationExternalOrganization"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalOrganizationExternalOrganization":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"error":{"$ref":"#/definitions/BulkErrorExternalOrganization"}}},"BulkOrganizationsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"BulkFetchOrganizationsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalOrganizationEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalOrganizationEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"BulkErrorRelationship":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkRelationshipsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultRelationshipRelationship"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultRelationshipRelationship":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"error":{"$ref":"#/definitions/BulkErrorRelationship"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with the external organization. When creating or updating a relationship, only User.id is required. User object is fully populated when expanding a note.","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkRelationshipsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}}}},"BulkFetchRelationshipsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultRelationshipEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultRelationshipEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"NoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IdentifierClaimRequest":{"type":"object","required":["identifier","operation"],"properties":{"operation":{"type":"string","description":"The operation to perform claim/release","enum":["Claim","Release"]},"identifier":{"description":"The identifier that should be claimed/released from a contact","$ref":"#/definitions/ContactIdentifier"}}},"DataSchemaListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DataSchema"}},"selfUri":{"type":"string","format":"uri"}}},"MergeRequest":{"type":"object","required":["sourceContactId","targetContactId"],"properties":{"sourceContactId":{"type":"string","description":"The ID of the source contact for the merge operation"},"targetContactId":{"type":"string","description":"The ID of the target contact for the merge operation"}}},"ContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CursorContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"Cursors":{"type":"object","properties":{"before":{"type":"string"},"after":{"type":"string"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"externalContactId":{"type":"string","description":"An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact."},"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}}},"RelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExternalOrganizationTrustorLink":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"externalOrganizationId":{"type":"string","description":"The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org"},"trustorOrgId":{"type":"string","description":"The id of a PureCloud organization that has granted trust to this PureCloud organization"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganizationUri":{"type":"string","format":"uri","description":"The URI for the External Organization that is linked to the trustor org","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CursorOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"AchievedOutcome":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the outcome achieved."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssignedSegment":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the segment assigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Browser":{"type":"object","required":["family","featuresFlash","featuresJava","featuresPdf","featuresWebrtc","version"],"properties":{"family":{"type":"string","description":"Browser family (e.g. Chrome, Safari, Firefox)."},"version":{"type":"string","description":"Browser version (e.g. 68.0.3440.84)."},"lang":{"type":"string","description":"Language the browser is set to. Must conform to BCP 47."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual browser features."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"viewHeight":{"type":"integer","format":"int32","description":"Browser's viewport height."},"viewWidth":{"type":"integer","format":"int32","description":"Browser's viewport width."},"featuresFlash":{"type":"boolean","description":"Whether Flash is installed."},"featuresJava":{"type":"boolean","description":"Whether Java is installed."},"featuresPdf":{"type":"boolean","description":"Whether the browser recognizes PDFs."},"featuresWebrtc":{"type":"boolean","description":"Whether WebRTC is supported."}}},"ConnectedQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConnectedUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChannel":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type or category of this channel.","enum":["Unknown","Call","Callback","Email","GenericObject","Messaging","Social","Webchat","Voice","Chat","Cobrowse","Video","Screenshare","Message"]},"messageType":{"type":"string","description":"Message type for messaging conversations.","enum":["Unknown","Sms","Twitter","Facebook","Line","WhatsApp","WebMessaging","Open","Instagram"]},"platform":{"type":"string","description":"The source provider for the conversation (e.g. Edge, PureCloud Messaging, PureCloud Email)."}}},"ConversationUserDisposition":{"type":"object","required":["code","user"],"properties":{"code":{"type":"string","description":"User-defined wrap-up code for the conversation."},"notes":{"type":"string","description":"Text entered by the user to describe the call or disposition."},"user":{"description":"The user that wrapped up the conversation.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"CustomEventAttribute":{"type":"object","required":["dataType","value"],"properties":{"dataType":{"type":"string","description":"The data type of the custom attribute."},"value":{"type":"string","description":"The value of the custom attribute."}}},"CustomEventAttributeList":{"type":"object","required":["dataType","values"],"properties":{"dataType":{"type":"string","description":"The data type of the custom attributes."},"values":{"type":"array","description":"The list of custom event attribute values.","items":{"type":"string"}}}},"Device":{"type":"object","required":["category","isMobile","osFamily","osVersion","type"],"properties":{"category":{"type":"string","description":"Device category.","enum":["desktop","mobile","tablet","other"]},"type":{"type":"string","description":"Device type (e.g. iPad, iPhone, Other)."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"screenHeight":{"type":"integer","format":"int32","description":"Device's screen height."},"screenWidth":{"type":"integer","format":"int32","description":"Device's screen width."},"screenDensity":{"type":"integer","format":"int32","description":"Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual device features."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"JourneyApp":{"type":"object","required":["buildNumber","name","namespace","version"],"properties":{"name":{"type":"string","description":"Name of the application (e.g. mybankingapp)."},"namespace":{"type":"string","description":"Namespace of the application (e.g. com.genesys.bancodinero)."},"version":{"type":"string","description":"Version of the application (e.g. 5.9.27)."},"buildNumber":{"type":"string","description":"Build number of the application (e.g. 701)."}}},"JourneyCampaign":{"type":"object","properties":{"content":{"type":"string","description":"Differentiate ads or links that point to the same URL (e.g. textlink)."},"medium":{"type":"string","description":"Identify a medium such as email or cost-per-click (e.g. CPC)."},"name":{"type":"string","description":"Identify a specific product promotion or strategic campaign (e.g. 320banner)."},"source":{"type":"string","description":"Identify a search engine, newsletter name, or other source (e.g. Google)."},"term":{"type":"string","description":"Note the keywords for this ad (e.g. running+shoes)."},"clickId":{"type":"string","description":"The click ID (unique number that is generated when a potential customer clicks on an affiliate link)."},"network":{"type":"string","description":"The ad network to which the click ID belongs."}}},"JourneyGeolocation":{"type":"object","properties":{"country":{"type":"string","description":"Geolocation's ISO 3166-1 alpha-2 country code."},"countryName":{"type":"string","description":"Geolocation's country name."},"latitude":{"type":"number","format":"double","description":"Geolocation's latitude."},"longitude":{"type":"number","format":"double","description":"Geolocation's longitude."},"locality":{"type":"string","description":"Geolocation's locality or city."},"postalCode":{"type":"string","description":"Geolocation's postal code or ZIP code."},"region":{"type":"string","description":"Geolocation's ISO-3166-2 region code."},"regionName":{"type":"string","description":"Geolocation's region name."},"source":{"type":"string","description":"The source that was used to determine the geolocation information."},"timezone":{"type":"string","description":"Geolocation's timezone."}}},"JourneyPage":{"type":"object","required":["breadcrumb","domain","hostname","pathname","url"],"properties":{"url":{"type":"string","description":"The page URL."},"title":{"type":"string","description":"Title of the page."},"domain":{"type":"string","description":"Domain of the page's URL."},"fragment":{"type":"string","description":"Fragment or hash of the page's URL."},"hostname":{"type":"string","description":"Hostname of the page's URL."},"keywords":{"type":"string","description":"Keywords from the HTML {@code } tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the {@code } tag."},"pathname":{"type":"string","description":"Path name of the page for the event."},"queryString":{"type":"string","description":"Query string that is passed to the page in the current event."},"breadcrumb":{"type":"array","description":"Hierarchy of the current page in relation to the website's structure.","items":{"type":"string"}}}},"NetworkConnectivity":{"type":"object","required":["bluetoothEnabled","cellularEnabled","wifiEnabled"],"properties":{"carrier":{"type":"string","description":"The name of the network carrier."},"bluetoothEnabled":{"type":"boolean","description":"Whether Bluetooth is enabled."},"cellularEnabled":{"type":"boolean","description":"Whether Cellular is enabled."},"wifiEnabled":{"type":"boolean","description":"Whether Wi-Fi is enabled."}}},"OutcomeAchievement":{"type":"object","required":["achievedDate","outcome"],"properties":{"outcome":{"description":"The outcome that was achieved.","$ref":"#/definitions/AchievedOutcome"},"achievedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Referrer":{"type":"object","required":["domain","hostname","medium","pathname","url"],"properties":{"url":{"type":"string","description":"Referrer URL."},"domain":{"type":"string","description":"Referrer URL domain."},"hostname":{"type":"string","description":"Referrer URL hostname."},"keywords":{"type":"string","description":"Referrer keywords."},"pathname":{"type":"string","description":"Referrer URL pathname."},"queryString":{"type":"string","description":"Referrer URL querystring."},"fragment":{"type":"string","description":"Referrer URL fragment."},"name":{"type":"string","description":"Name of referrer (e.g. Yahoo!, Google, InfoSpace)."},"medium":{"type":"string","description":"Type of referrer (e.g. search, social).","enum":["internal","search","social","email","unknown","paid"]}}},"SdkLibrary":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the SDK."},"version":{"type":"string","description":"The version of the SDK."}}},"Session":{"type":"object","required":["authenticated","createdDate","eventCount","id","lastEvent","type"],"properties":{"id":{"type":"string","description":"The ID of the session."},"customerId":{"type":"string","description":"Primary identifier of the customer in the source where the events for the session originate from."},"customerIdType":{"type":"string","description":"Type of source customer identifier (e.g. cookie, email, phone)."},"type":{"type":"string","description":"Session types indicate the type or category of sessions (e.g. web, app)."},"externalId":{"type":"string","description":"Unique identifier in the external system where the events for the session originate from."},"externalUrl":{"type":"string","description":"A URL that identifies an external system-of-record resource that may have more detailed information on the session."},"shortId":{"type":"string","description":"Shortened numeric identifier of 4-6 digits."},"outcomeAchievements":{"type":"array","description":"List of the outcome achievements by the customer in this session.","items":{"$ref":"#/definitions/OutcomeAchievement"}},"segmentAssignments":{"type":"array","description":"List of the segment assignments to the customer in this session.","items":{"$ref":"#/definitions/SessionSegmentAssignment"}},"attributes":{"type":"object","description":"Attributes projected from the session's event stream.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"attributeLists":{"type":"object","description":"List-type attributes projected from the session's event stream.","additionalProperties":{"$ref":"#/definitions/CustomEventAttributeList"}},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Customer's IP address."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"lastPage":{"description":"The webpage where the customer's last web interaction occurred.","$ref":"#/definitions/JourneyPage"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"referrer":{"description":"Identifies the page URL that originally generated the request for the current page being viewed.","$ref":"#/definitions/Referrer"},"app":{"description":"Application that the customer is interacting with (for app sessions).","$ref":"#/definitions/JourneyApp"},"sdkLibrary":{"description":"SDK library used to generate the events for the session (for app and web sessions).","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity (for app sessions).","$ref":"#/definitions/NetworkConnectivity"},"searchTerms":{"type":"array","description":"Search terms associated with the session.","items":{"type":"string"}},"userAgentString":{"type":"string","description":"String identifying the user agent."},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the session has been active (valid for an individual device)."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events performed during the session."},"pageviewCount":{"type":"integer","format":"int32","description":"The count of all pageviews performed during the session."},"screenviewCount":{"type":"integer","format":"int32","description":"The count of all screenviews performed during the session."},"lastEvent":{"description":"Information about the most recent event in this session.","$ref":"#/definitions/SessionLastEvent"},"lastConnectedQueue":{"description":"The last queue connected to this session.","$ref":"#/definitions/ConnectedQueue"},"lastConnectedUser":{"description":"The last user connected to this session.","$ref":"#/definitions/ConnectedUser"},"lastUserDisposition":{"description":"The last user disposition connected to this session.","$ref":"#/definitions/ConversationUserDisposition"},"conversationChannels":{"type":"array","description":"Represents the channels used for this conversation.","items":{"$ref":"#/definitions/ConversationChannel"}},"originatingDirection":{"type":"string","description":"The original direction of the conversation.","enum":["Unknown","Inbound","Outbound"]},"conversationSubject":{"type":"string","description":"The subject for the conversation, for example an email subject."},"lastUserDisconnectType":{"type":"string","description":"Disconnect reason for the last user connected to the conversation.","enum":["Unknown","Endpoint","Client","System","Transfer","Error","Peer","Other","Spam","Timeout","TransportFailure","ConferenceTransfer","ConsultTransfer","ForwardTransfer","NoAnswerTransfer","NotAvailableTransfer","Uncallable","DoNotDisturbEndpoint","DoNotDisturbTransfer"]},"lastAcdOutcome":{"type":"string","description":"Last ACD outcome for the conversation.","enum":["Unknown","Abandon","Answered","FlowOut"]},"authenticated":{"type":"boolean","description":"Indicates whether or not the session is authenticated."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalContact":{"description":"The external contact associated with this session.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"awayDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the visitor should be considered as away. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"idleDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the visitor should be considered as idle. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"description":"The conversation for this session.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SessionLastEvent":{"type":"object","required":["createdDate","eventName","id"],"properties":{"id":{"type":"string","description":"The ID of the last event."},"eventName":{"type":"string","description":"The name of the event."},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the event was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"SessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Session"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SessionSegmentAssignment":{"type":"object","required":["assignedDate","segment"],"properties":{"segment":{"description":"The segment that was assigned.","$ref":"#/definitions/AssignedSegment"},"assignedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was assigned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CursorNoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"CursorRelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"ReverseWhitepagesLookupResult":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"externalOrganizations":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"Attribute":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The attribute name."},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"uploadedBy":{"$ref":"#/definitions/DomainEntityRef"},"sharingUri":{"type":"string","format":"uri"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"]},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"]}}},"TagValue":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The workspace tag name."},"inUse":{"type":"boolean"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpdate":{"type":"object","required":["name"],"properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the document"},"read":{"type":"boolean"},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"DocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DocumentUpload":{"type":"object","required":["name","workspace"],"properties":{"name":{"type":"string","description":"The name of the document"},"workspace":{"description":"The workspace the document will be uploaded to","$ref":"#/definitions/DomainEntityRef"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"DomainEntityListingQueryResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SecurityProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareRequest":{"type":"object","required":["sharedEntity","sharedEntityType"],"properties":{"sharedEntityType":{"type":"string","description":"The share entity type","enum":["DOCUMENT"]},"sharedEntity":{"description":"The entity that will be shared","$ref":"#/definitions/SharedEntity"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"description":"The member that will have access to this share. Only required if a list of members is not provided.","$ref":"#/definitions/SharedEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/MemberEntity"}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"ShareEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommandStatusEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagValueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"WorkspaceMember":{"type":"object","required":["memberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","description":"The workspace member type.","enum":["USER","GROUP"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Workspace":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The current name of the workspace."},"type":{"type":"string","enum":["USER","GROUP"]},"isCurrentUserWorkspace":{"type":"boolean"},"user":{"$ref":"#/definitions/DomainEntityRef"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"WorkspaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The workspace name"},"bucket":{"type":"string"},"description":{"type":"string"}}},"Address":{"type":"object","properties":{"name":{"type":"string","description":"This will be nameRaw if present, or a locality lookup of the address field otherwise."},"nameRaw":{"type":"string","description":"The name as close to the bits on the wire as possible."},"addressNormalized":{"type":"string","description":"The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."},"addressRaw":{"type":"string","description":"The address as close to the bits on the wire as possible."},"addressDisplayable":{"type":"string","description":"The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."}}},"AdjustableLiveSpeakerDetection":{"type":"object","properties":{"mode":{"type":"string","description":"Modes to tune between speed to live speaker detection vs accuracy.","enum":["unknown","disabled","low","medium","high"]},"preconnectDuration":{"type":"string","description":"ISO 8601 formatted relative duration (e.g., PT30.8427419S for 30.8 seconds), calculated on line connect."},"eventName":{"type":"string","description":"The name of the event that triggered the ALSD evaluation (e.g., line.connect, speech.generic)."},"isPersonLikely":{"type":"boolean","description":"The output of the ALSD detector, evaluating whether there is likely a person on the call based on the above inputs, and if so, a person is detected early (person disposition name and speech.person analyzer result) and the associated action taken (e.g., speech.person postconnect entry in the disposition table has the action to transfer to a queue)."},"totalRingbacks":{"type":"integer","format":"int32","description":"Number of tone.ring.* analyzer events detected during the call (expected mostly during pre-connect but the last ringback tone detection could potentially complete after line connect, which will increment totalRingbacks still)."},"lineConnected":{"type":"boolean","description":"Protocol line connect received (answered by a person, machine, busy, fax)."}}},"AfterCallWork":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["unknown","notApplicable","skipped","pending","complete"]}}},"AiAnswer":{"type":"object","properties":{"answerId":{"type":"string","description":"The unique identifier of the suggested ai answer."},"explanation":{"type":"string","description":"An explanation providing the reasoning behind the suggested answer."},"failureType":{"type":"string","description":"Describes the type of error associated with the AI answer.","enum":["LowConfidenceError","ParsingError","ServiceError"]}}},"AiScoring":{"type":"object","properties":{}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"name":{"type":"string","description":"The name of the attachment."},"contentUri":{"type":"string","description":"The content uri of the attachment. If set, this is commonly a public api download location."},"contentType":{"type":"string","description":"The type of file the attachment is."},"contentLength":{"type":"integer","format":"int32","description":"The length of the attachment file."},"inlineImage":{"type":"boolean","description":"Whether or not the attachment was attached inline.,"}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","endpoint.donotdisturb","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"Callback":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"callerId":{"type":"string","description":"The phone number displayed to recipients of the phone call. The value should conform to the E164 format."},"callerIdName":{"type":"string","description":"The name displayed to recipients of the phone call."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"Cobrowsesession":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transport.failure","error","peer","other","spam","uncallable"]},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the co-browse session."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"externalTag":{"type":"string","description":"The external tag associated with the conversation."},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"]},"state":{"type":"string","description":"The conversation's state","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"roomId":{"type":"string","description":"The room id for the chat."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"direction":{"type":"string","description":"The direction of the chat","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","error","peer","other","uncallable","timeout"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"ConversationDivisionMembership":{"type":"object","properties":{"division":{"description":"A division the conversation belongs to.","$ref":"#/definitions/DomainEntityRef"},"entities":{"type":"array","description":"The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"ConversationMessageMetadata":{"type":"object","properties":{"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"events":{"type":"array","description":"List of events metadata","items":{"$ref":"#/definitions/ConversationMessageMetadataEvent"}},"content":{"type":"array","description":"List of message content","items":{"$ref":"#/definitions/ConversationMessageMetadataContent"}}},"description":"Metadata information about a message."},"ConversationMessageMetadataContent":{"type":"object","properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","Unknown"]},"subType":{"type":"string","description":"Content subtype","enum":["Image","Video","Audio","File","Link","Mention","Reply","Button","QuickReply","Postback","Unknown"]}},"description":"Metadata information about a message content."},"ConversationMessageMetadataEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Typing","Presence","Unknown"]},"subType":{"type":"string","description":"Event subtype","enum":["On","Join","Offering","OfferingExpired","OfferingAccepted","OfferingRejected","Disconnect","Clear","SignIn","Unknown"]}},"description":"Metadata information about a message event."},"ConversationQueueMediaSettings":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"Specifies the duration of the alerting sound to be played for auto answered interactions."},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"Specifies the duration of the alerting sound to be played for manually answered interactions."},"enableAutoAnswer":{"type":"boolean","description":"Flag to indicate if auto answer is enabled for the given media type or media subtype."}}},"ConversationReference":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ConversationRoutingData":{"type":"object","properties":{"queue":{"description":"The queue to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"language":{"description":"The language to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority of the conversation to use for routing decisions"},"skills":{"type":"array","description":"The skills to use for routing decisions","items":{"$ref":"#/definitions/AddressableEntityRef"}},"scoredAgents":{"type":"array","description":"A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents","items":{"$ref":"#/definitions/ScoredAgent"}},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string","description":"The contact associated with this preview data pop"},"contactListId":{"type":"string","description":"The contactList associated with this preview data pop."},"campaignId":{"type":"string","description":"The campaignId associated with this preview data pop."},"phoneNumberColumns":{"type":"array","description":"The phone number columns associated with this campaign","items":{"$ref":"#/definitions/PhoneNumberColumn"}},"callbackAutoAnswer":{"type":"boolean","description":"Whether or not to auto answer the callback"}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","description":"Disconnect reason protocol type.","enum":["q850","sip"]},"code":{"type":"integer","format":"int32","description":"Protocol specific reason code. See the Q.850 and SIP specs."},"phrase":{"type":"string","description":"Human readable English description of the disconnect reason."}}},"Disposition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the disposition. Either a platform predefined value, or the name of the disposition in the disposition table.."},"analyzer":{"type":"string","description":"The final media analyzer result that triggered the disposition result, if any."},"dispositionParameters":{"description":"Contains various parameters related to call analysis.","$ref":"#/definitions/DispositionParameters"},"detectedSpeechStart":{"type":"string","format":"date-time","description":"Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"detectedSpeechEnd":{"type":"string","format":"date-time","description":"Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"DispositionParameters":{"type":"object","properties":{"adjustableLiveSpeakerDetection":{"description":"ALSD evaluation inputs and output (isPersonalLikely) of the ALSD detector the last time it ran on the call (could be multiple times)","$ref":"#/definitions/AdjustableLiveSpeakerDetection"}}},"Email":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected","none","parked","transmitting"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","connected","disconnected","none","parked","transmitting"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"subject":{"type":"string","description":"The subject for the initial email that started this conversation."},"messagesSent":{"type":"integer","format":"int32","description":"The number of email messages sent by this participant."},"segments":{"type":"array","description":"The time line of the participant's email, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the email","enum":["inbound","outbound"]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"assignee":{"$ref":"#/definitions/User"},"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable."},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"revisionCreatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"assigned":{"type":"boolean","description":"Set to false to unassign the evaluation. This cannot be set to false when assignee is also set."},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"agentTeam":{"description":"Team of the evaluation agent","$ref":"#/definitions/Team"},"isScoringIndex":{"type":"boolean"},"authorizedActions":{"type":"array","description":"List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit","items":{"type":"string"}},"hasAssistanceFailed":{"type":"boolean","description":"Is true when evaluation assistance didn't execute successfully"},"evaluationSource":{"description":"The source that created the evaluation.","readOnly":true,"$ref":"#/definitions/EvaluationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float","description":"Score of all questions in the group"},"maxTotalScore":{"type":"number","format":"float","description":"Maximum possible score of all questions in the group"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"totalCriticalScore":{"type":"number","format":"float","description":"Score of only the critical questions in the group"},"maxTotalCriticalScore":{"type":"number","format":"float","description":"Maximum possible score of only the critical questions in the group"},"totalNonCriticalScore":{"type":"number","format":"float","description":"Score of only the non critical questions in the group"},"maxTotalNonCriticalScore":{"type":"number","format":"float","description":"Maximum possible score of only the non critical questions in the group"},"totalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of all questions in the group"},"maxTotalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of all questions in the group"},"totalCriticalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of only the critical questions in the group"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of only the critical questions in the group"},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of only the non critical questions in the group"},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of only the non critical questions in the group"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionScore"}}}},"EvaluationQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32","description":"Unweighted score of the question"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"assistedAnswerId":{"type":"string","description":"AnswerId found with evaluation assistance conditions"},"failedKillQuestion":{"type":"boolean","description":"Applicable only on fatal questions. Indicates that the answer selected was not the highest score available for the question"},"comments":{"type":"string","description":"Comments from the evaluator specific to this question"}}},"EvaluationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float","description":"Score of all questions"},"totalCriticalScore":{"type":"number","format":"float","description":"Score of only the critical questions"},"totalNonCriticalScore":{"type":"number","format":"float","description":"Score of only the non-critical questions"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean","description":"Indicates that at least one fatal question was answered without having the highest score available for the question"},"comments":{"type":"string","description":"Overall comments from the evaluator"},"privateComments":{"type":"string","description":"Overall private comments from the evaluator"},"agentComments":{"type":"string","description":"Comments from the agent while reviewing evaluation results"},"transcriptTopics":{"type":"array","description":"List of topics found within the conversation's transcripts","items":{"$ref":"#/definitions/TranscriptTopic"}}}},"EvaluationSource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Type of the evaluation source.","enum":["Policy","User","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxStatus":{"type":"object","properties":{"direction":{"type":"string","description":"The fax direction, either \"send\" or \"receive\"."},"expectedPages":{"type":"integer","format":"int64","description":"Total number of expected pages, if known."},"activePage":{"type":"integer","format":"int64","description":"Active page of the transmission."},"linesTransmitted":{"type":"integer","format":"int64","description":"Number of lines that have completed transmission."},"bytesTransmitted":{"type":"integer","format":"int64","description":"Number of bytes that have competed transmission."},"baudRate":{"type":"integer","format":"int64","description":"Current signaling rate of transmission, baud rate."},"pageErrors":{"type":"integer","format":"int64","description":"Number of page errors."},"lineErrors":{"type":"integer","format":"int64","description":"Number of line errors."}}},"JourneyAction":{"type":"object","required":["actionMap","id"],"properties":{"id":{"type":"string","description":"The ID of an action from the Journey System (an action is spawned from an actionMap)"},"actionMap":{"description":"Details about the action map from the Journey System which triggered this action","$ref":"#/definitions/JourneyActionMap"}}},"JourneyActionMap":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The ID of the actionMap in the Journey System which triggered this action"},"version":{"type":"integer","format":"int32","description":"The version number of the actionMap in the Journey System at the time this action was triggered"}}},"JourneyContext":{"type":"object","required":["customer"],"properties":{"customer":{"description":"A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomerSession"},"triggeringAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"}}},"JourneyCustomer":{"type":"object","required":["id","idType"],"properties":{"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable."},"idType":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie)."}}},"JourneyCustomerSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"An ID of a Customer/User's session within the Journey System at a point-in-time"},"type":{"type":"string","description":"The type of the Customer/User's session within the Journey System (e.g. web, app)"}}},"Message":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","connected","disconnected"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"segments":{"type":"array","description":"The time line of the participant's message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this message."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the message."},"authenticated":{"type":"boolean","description":"If true, the participant member is authenticated."},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging","open","instagram"]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"toAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/MessageDetails"}},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"byoSmsIntegrationId":{"type":"string","description":"The internal id representing the customer supplied sms integration message."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"MessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the message media."},"messageURI":{"type":"string","format":"uri","description":"A URI for this message entity."},"messageStatus":{"type":"string","description":"Indicates the delivery status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read","removed","published"]},"messageSegmentCount":{"type":"integer","format":"int32","description":"The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits."},"messageTime":{"type":"string","format":"date-time","description":"The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"media":{"type":"array","description":"The media (images, files, etc) associated with this message, if any","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"One or more stickers associated with this message, if any","items":{"$ref":"#/definitions/MessageSticker"}},"messageMetadata":{"description":"Information that describes the content of the message, if any","$ref":"#/definitions/ConversationMessageMetadata"},"errorInfo":{"description":"Provider specific error information for a communication.","$ref":"#/definitions/ErrorBody"}}},"MessageMedia":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object. If null then the media type should be dictated by the url"},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The optional name of the the media object."},"id":{"type":"string","description":"The optional id of the the media object."}}},"MessageSticker":{"type":"object","properties":{"url":{"type":"string","description":"The location of the sticker, useful for retrieving it"},"id":{"type":"string","description":"The unique id of the the sticker object."}}},"PagelessDomainEntityListingEvaluationVersion":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationVersion"}},"selfUri":{"type":"string","format":"uri"}}},"Participant":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc.","items":{"type":"string"}},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."}}},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"ScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/DomainEntityRef"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"Screenshare":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"sharing":{"type":"boolean","description":"Indicates whether this participant is sharing their screen."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the screen share."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Segment":{"type":"object","required":["endTime","startTime"],"properties":{"startTime":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The activity taking place for the participant in the segment."},"howEnded":{"type":"string","description":"A description of the event that ended the segment."},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment"}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"socialMediaId":{"type":"string","description":"A globally unique identifier for the social media."},"socialMediaHub":{"type":"string","description":"The social network of the communication"},"socialUserName":{"type":"string","description":"The user name for the communication."},"previewText":{"type":"string","description":"The text preview of the communication contents"},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the social expression."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"TopicDuration":{"type":"object","properties":{"totalMilliseconds":{"type":"integer","format":"int64","description":"The total duration of the topic phrase within the conversation","readOnly":true}}},"TopicOffset":{"type":"object","properties":{"wordCount":{"type":"integer","format":"int64","description":"Count of words before the topic ","readOnly":true},"characterCount":{"type":"integer","format":"int64","description":"Count of characters before the topic ","readOnly":true}}},"TranscriptTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"topicPhrase":{"type":"string","description":"The phrase which detected the topic. ","readOnly":true},"transcriptPhrase":{"type":"string","description":"The transcript phrase which detected the topic.","readOnly":true},"confidence":{"type":"integer","format":"int32","description":"The detection confidence of the topic.","readOnly":true},"startTimeMilliseconds":{"type":"integer","format":"int64","description":"The start time of the topic phrase.","readOnly":true},"duration":{"$ref":"#/definitions/TopicDuration"},"offset":{"description":"Location of the phrase","readOnly":true,"$ref":"#/definitions/TopicOffset"},"recordingLocation":{"type":"integer","format":"int64","description":"Location of the phrase in the recording in milliseconds","readOnly":true}}},"TransferDestination":{"type":"object","properties":{"userId":{"type":"string","description":"The id of the user if the command destination is a user."},"address":{"type":"string","description":"The destination address if the command destination is an endpoint."}}},"TransferInitiator":{"type":"object","properties":{"userId":{"type":"string","description":"The id of the user who initiated the command if it was initiated by a user."}}},"TransferResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the command."},"state":{"type":"string","description":"The state of the command.","enum":["Pending","Active","Complete","Canceled","Failed","Timeout","Unknown"]},"dateIssued":{"type":"string","format":"date-time","description":"The date/time that this command was issued. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiator":{"description":"The initiator of the command.","$ref":"#/definitions/TransferInitiator"},"modifiedBy":{"description":"The user or entity that modified the command.","$ref":"#/definitions/TransferResponseModifiedBy"},"destination":{"description":"The destination of the command.","$ref":"#/definitions/TransferDestination"},"transferType":{"type":"string","description":"The type of transfer to perform.","enum":["Attended","Unattended"]}}},"TransferResponseModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Video":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"audioMuted":{"type":"boolean","description":"Indicates whether this participant has muted their outgoing audio."},"videoMuted":{"type":"boolean","description":"Indicates whether this participant has muted/paused their outgoing video."},"sharingScreen":{"type":"boolean","description":"Indicates whether this participant is sharing their screen to the session."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the video."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"msids":{"type":"array","description":"List of media stream ids","items":{"type":"string"}},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Voicemail":{"type":"object","properties":{"id":{"type":"string","description":"The voicemail id"},"uploadStatus":{"type":"string","description":"current state of the voicemail upload","enum":["pending","complete","failed","timeout","none"]}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."}}},"ArrayNode":{"type":"object"},"JsonCursorSearchResponse":{"type":"object","required":["results","types"],"properties":{"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"},"cursor":{"type":"string","description":"The page cursor"}}},"ConversationParticipantSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/ConversationParticipantSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","DATE_RANGE"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"ConversationParticipantSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/ConversationParticipantSearchCriteria"}},"cursor":{"type":"string"}}},"ConversationUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"ConversationTagsUpdate":{"type":"object","required":["externalTag"],"properties":{"externalTag":{"type":"string","description":"The external tag associated with the conversation."}}},"ConversationSecureAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The version used to detect conflicting updates when using PUT. Not used for PATCH."}}},"ConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"headers":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"FaxSendRequest":{"type":"object","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$ref":"#/definitions/CoverSheet"},"timeZoneOffsetMinutes":{"type":"integer","format":"int32","description":"Time zone offset minutes from GMT"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Settings":{"type":"object","properties":{"communicationBasedACW":{"type":"boolean","description":"Communication Based ACW"},"includeNonAgentConversationSummary":{"type":"boolean","description":"Display communication summary"},"allowCallbackQueueSelection":{"type":"boolean","description":"Allow Callback Queue Selection"},"callbacksInheritRoutingFromInboundCall":{"type":"boolean","description":"Inherit callback routing data from inbound calls"},"completeAcwWhenAgentTransitionsOffline":{"type":"boolean","description":"Complete ACW When Agent Transitions Offline"},"totalActiveCallback":{"type":"boolean","description":"Exclude the 'interacting' duration from the handle calculations of callbacks"}}},"AfterCallWorkUpdate":{"type":"object","required":["afterCallWorkRequired"],"properties":{"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not after-call work must be completed for the communication. Can only be updated for connected communications."}}},"BulkCallbackPatchResponse":{"type":"object","properties":{"results":{"type":"array","description":"A list of the results from the bulk operation.","items":{"$ref":"#/definitions/BulkResult"}},"errorCount":{"type":"integer","format":"int32","description":"The number of errors from the bulk operation."},"errorIndexes":{"type":"array","description":"An index of where the errors are in the listing.","items":{"type":"integer","format":"int32"}}}},"BulkResult":{"type":"object","properties":{"error":{"description":"Error details if the operation failed.","$ref":"#/definitions/BulkError"},"entity":{"type":"object","description":"The result of the operation if it succeeded."}}},"BulkCallbackPatchRequest":{"type":"object","required":["patchCallbackRequests"],"properties":{"patchCallbackRequests":{"type":"array","description":"The list of requests to update callbacks in bulk","items":{"$ref":"#/definitions/PatchCallbackRequest"}}}},"PatchCallbackRequest":{"type":"object","required":["agentId","conversationId"],"properties":{"conversationId":{"type":"string","description":"The conversationId."},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback."},"agentId":{"type":"string","description":"The agentId."},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BulkCallbackDisconnectRequest":{"type":"object","required":["callbackDisconnectIdentifiers"],"properties":{"callbackDisconnectIdentifiers":{"type":"array","description":"The list of requests to disconnect callbacks in bulk","items":{"$ref":"#/definitions/CallbackDisconnectIdentifier"}}}},"CallbackDisconnectIdentifier":{"type":"object","required":["callbackId","conversationId"],"properties":{"conversationId":{"type":"string","description":"The Conversation Id."},"callbackId":{"type":"string","description":"The callback id."}}},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"recordingState":{"type":"string","enum":["none","active","paused"]},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"muted":{"type":"boolean","description":"Value is true when the call is muted."},"confined":{"type":"boolean","description":"Value is true when the call is confined."},"recording":{"type":"boolean","description":"Value is true when the call is being recorded."},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["none","active","paused"]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/DomainEntityRef"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"faxStatus":{"description":"Extra fax information if the call is a fax.","$ref":"#/definitions/FaxStatus"},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"coachedParticipantId":{"type":"string","description":"The ID of the participant being coached when performing a call coach."},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."},"uuiData":{"type":"string","description":"User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567."},"bargedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the barge conference in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"TransferRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"CreateCallResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callerId":{"type":"string","description":"The caller id phone number for this outbound call."},"callerIdName":{"type":"string","description":"The caller id name for this outbound call."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"externalContactId":{"type":"string","description":"The external contact with which to associate the call."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"}}},"Destination":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"}}},"SetRecordingState":{"type":"object","properties":{"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings.","enum":["ACTIVE","PAUSED","NONE"]}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}}}},"AssignedWrapupCode":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The duration in seconds of the wrap-up segment."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/WrapupInput"},"state":{"type":"string","description":"The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording."},"muted":{"type":"boolean","description":"True to mute this conversation participant."},"confined":{"type":"boolean","description":"True to confine this conversation participant. Should only be used for ad-hoc conferences"},"held":{"type":"boolean","description":"True to hold this conversation participant."},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant."}}},"WrapupInput":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."},"disableEndTimeUpdates":{"type":"boolean","description":"Prevent updates to wrapup end time when set to true."}}},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32","description":"The maximum number of participants that are allowed on a conversation."}}},"ConsultTransfer":{"type":"object","required":["destination","speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"ConsultTransferToAgent":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"userId":{"type":"string","description":"The id of the internal user."},"userDisplayName":{"type":"string","description":"The name of the internal user."}}},"ConsultTransferToQueue":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"queueId":{"type":"string","description":"The id of the queue."},"queueName":{"type":"string","description":"The name of the queue."}}},"ConsultTransferToExternal":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"address":{"type":"string","description":"The address (like phone number) of the external contact."}}},"CallCommand":{"type":"object","required":["callNumber"],"properties":{"callNumber":{"type":"string","description":"The phone number to dial for this call."},"phoneColumn":{"type":"string","description":"For a dialer preview or scheduled callback, the phone column associated with the phone number"}}},"CallHistoryConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallHistoryParticipant"}},"direction":{"type":"string","description":"The direction of the call relating to the current user","enum":["inbound","outbound"]},"wentToVoicemail":{"type":"boolean","description":"Did the call end in the current user's voicemail"},"missedCall":{"type":"boolean","description":"Did the user not answer this conversation"},"startTime":{"type":"string","format":"date-time","description":"The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"wasConference":{"type":"boolean","description":"Was this conversation a conference"},"wasCallback":{"type":"boolean","description":"Was this conversation a callback"},"hadScreenShare":{"type":"boolean","description":"Did this conversation have a screen share session"},"hadCobrowse":{"type":"boolean","description":"Did this conversation have a cobrowse session"},"wasOutboundCampaign":{"type":"boolean","description":"Was this conversation associated with an outbound campaign"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallHistoryConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallHistoryConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallHistoryParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/User"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/Queue"},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/Group"},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"externalContact":{"description":"The PureCloud external contact","$ref":"#/definitions/ExternalContact"},"externalOrganization":{"description":"The PureCloud external organization","$ref":"#/definitions/ExternalOrganization"},"didInteract":{"type":"boolean","description":"Indicates whether the contact ever connected"},"sipResponseCodes":{"type":"array","description":"Indicates SIP Response codes associated with the participant","items":{"type":"integer","format":"int64"}},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"outboundCampaign":{"description":"The outbound campaign associated with the participant","$ref":"#/definitions/Campaign"}}},"Campaign":{"type":"object","required":["callerAddress","callerName","contactList","dialingMode","name","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The ContactList for this Campaign to dial.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"dialingMode":{"type":"string","description":"The strategy this Campaign will use for dialing.","enum":["agentless","preview","power","predictive","progressive","external"]},"script":{"description":"The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The EdgeGroup that will place the calls. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"site":{"description":"The identifier of the site to be used for dialing; can be set in place of an edge group.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.","enum":["on","stopping","off","complete","invalid","forced_off","forced_stopping"]},"phoneColumns":{"type":"array","description":"The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"The targeted compliance abandon rate percentage. Required for power and predictive campaigns."},"dncLists":{"type":"array","description":"DncLists for this Campaign to check before placing a call.","items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"The callable time set for this campaign to check before placing a call.","$ref":"#/definitions/DomainEntityRef"},"callAnalysisResponseSet":{"description":"The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"errors":{"type":"array","description":"A list of current error conditions associated with the campaign.","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"The caller id name to be displayed on the outbound call."},"callerAddress":{"type":"string","example":"(555) 555-5555","description":"The caller id phone number to be displayed on the outbound call."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."},"ruleSets":{"type":"array","description":"Rule sets to be applied while this campaign is dialing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"skipPreviewDisabled":{"type":"boolean","description":"Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."},"alwaysRunning":{"type":"boolean","description":"Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."},"contactSort":{"description":"The order in which to sort contacts for dialing, based on a column.","$ref":"#/definitions/ContactSort"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"noAnswerTimeout":{"type":"integer","format":"int32","description":"How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."},"callAnalysisLanguage":{"type":"string","description":"The language the edge will use to analyze the call."},"priority":{"type":"integer","format":"int32","description":"The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."},"contactListFilters":{"type":"array","description":"Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.","items":{"$ref":"#/definitions/DomainEntityRef"}},"division":{"description":"The division this campaign belongs to.","$ref":"#/definitions/DomainEntityRef"},"dynamicContactQueueingSettings":{"description":"Settings for dynamic queueing of contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on this campaign"},"callbackAutoAnswer":{"type":"boolean","description":"The option manages the auto-answer callback calls"},"dynamicLineBalancingSettings":{"description":"Dynamic line balancing settings","$ref":"#/definitions/DynamicLineBalancingSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","description":"The direction in which to sort contacts.","enum":["ASC","DESC"]},"numeric":{"type":"boolean","description":"Whether or not the column contains numeric data."}}},"DynamicContactQueueingSettings":{"type":"object","properties":{"sort":{"type":"boolean","description":"Whether to sort contacts dynamically"}}},"DynamicLineBalancingSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates that this campaign is subject of dynamic line balancing"},"relativeWeight":{"type":"integer","format":"int32","description":"Relative weight of this campaign in dynamic line balancing"}}},"PhoneColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"The type of the phone column. For example, 'cell' or 'home'."}}},"RestErrorDetail":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"SetUuiDataRequest":{"type":"object","properties":{"uuiData":{"type":"string","description":"The value of the uuiData to set."}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outboundPreview":{"description":"The outbound preview associated with this callback.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail associated with this callback.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The list of phone number to use for this callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the callback target."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"If true, the callback can be skipped."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Duration in seconds before the callback will be auto-dialed."},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal."},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"]},"id":{"type":"string","description":"The identifier of the callback"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"CreateCallbackCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}},"callerId":{"type":"string","description":"The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."},"callerIdName":{"type":"string","description":"The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."}}},"RoutingData":{"type":"object","required":["queueId"],"properties":{"queueId":{"type":"string","description":"The identifier of the routing queue"},"languageId":{"type":"string","description":"The identifier of a language to be considered in routing"},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"priority":{"type":"integer","format":"int32","description":"The priority for routing"},"skillIds":{"type":"array","description":"A list of skill identifiers to be considered in routing","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"A list of agents to be preferred in routing","items":{"type":"string"}},"scoredAgents":{"type":"array","description":"A list of scored agents for routing decisions. For Agent Owned Callbacks use one scored agent with a score of 100.","items":{"$ref":"#/definitions/ScoredAgent"}},"routingFlags":{"type":"array","description":"An array of flags indicating how the conversation should be routed. Use \"AGENT_OWNED_CALLBACK\" when creating an Agent Owned Callback.","items":{"type":"string"}}}},"PatchCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"WebChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMemberInfo":{"type":"object","required":["role"],"properties":{"id":{"type":"string","description":"The communicationId of this member."},"displayName":{"type":"string","description":"The display name of the member."},"firstName":{"type":"string","description":"The first name of the member."},"lastName":{"type":"string","description":"The last name of the member."},"email":{"type":"string","description":"The email address of the member."},"phoneNumber":{"type":"string","description":"The phone number of the member."},"avatarImageUrl":{"type":"string","format":"uri","description":"The url to the avatar image of the member."},"role":{"type":"string","description":"The role of the member, one of [agent, customer, acd, workflow]","enum":["AGENT","CUSTOMER","WORKFLOW","ACD"]},"joinDate":{"type":"string","format":"date-time","description":"The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"leaveDate":{"type":"string","format":"date-time","description":"The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"authenticatedGuest":{"type":"boolean","description":"If true, the guest member is an authenticated guest."},"customFields":{"type":"object","description":"Any custom fields of information pertaining to this member.","additionalProperties":{"type":"string"}},"state":{"type":"string","description":"The connection state of this member.","enum":["CONNECTED","DISCONNECTED","ALERTING"]}}},"WebChatMessage":{"type":"object","required":["body","bodyType","conversation","sender","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"body":{"type":"string","description":"The message body."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMessageEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMessage"}},"previousPage":{"type":"string"},"next":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"CreateWebChatMessageRequest":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message body. Note that message bodies are limited to 4,000 characters."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"]}}},"WebChatTyping":{"type":"object","required":["conversation","id","sender","timestamp"],"properties":{"id":{"type":"string","description":"The event identifier of this typing indicator event (useful to guard against event re-delivery"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"}}},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomId":{"type":"string","description":"The ID of the chat room."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."}}},"CreateWebChatRequest":{"type":"object","required":["provider","queueId"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the chat conversation."},"provider":{"type":"string","description":"The name of the provider that is sourcing the web chat."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the langauge to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"customerName":{"type":"string","description":"The name of the customer participating in the web chat."}}},"CobrowseConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CobrowseMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CobrowseConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CobrowseConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EmailMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"state":{"type":"string","description":"The state of the current draft.","enum":["Created","Ready","Edited"]},"draftType":{"type":"string","description":"The type of draft that need to be treated.","enum":["Reply","ReplyAll","Forward"]},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."}}},"EmailMessagePreview":{"type":"object","required":["from","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBodyPreview":{"type":"string","description":"A truncated version of the textBody"},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"state":{"type":"string","description":"The state of the current draft.","enum":["Created","Ready","Edited"]},"draftType":{"type":"string","description":"The type of draft that need to be treated.","enum":["Reply","ReplyAll","Forward"]},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessagePreviewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessagePreview"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateEmailRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"},"direction":{"type":"string","description":"Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.","enum":["OUTBOUND","INBOUND"]},"htmlBody":{"type":"string","description":"An HTML body content of the email."},"textBody":{"type":"string","description":"A text body content of the email."},"externalContactId":{"type":"string","description":"The external contact with which the email should be associated. This field is only valid for OUTBOUND email."}}},"DraftManipulationRequest":{"type":"object","properties":{"translate":{"description":"A set of definitions to translate email attributes and correctly display date and time, for a given language","$ref":"#/definitions/HistoryHeadersTranslation"},"draftType":{"type":"string","description":"The kind of draft that as to be treated. Used to prefix response subject or auto-include information","enum":["Reply","ReplyAll","Forward"]}}},"HistoryHeadersTranslation":{"type":"object","required":["cc","forwardPrefix","from","language","replyPrefix","sent","subject","to"],"properties":{"from":{"type":"string","description":"A translation for the word \"from\", for the expected language"},"to":{"type":"string","description":"A translation for the word \"to\", for the expected language"},"cc":{"type":"string","description":"A translation for the word \"cc\", for the expected language"},"subject":{"type":"string","description":"A translation for the word \"subject\", for the expected language"},"replyPrefix":{"type":"string","description":"A translation for the subject prefix \"Reply\", for the expected language"},"forwardPrefix":{"type":"string","description":"A translation for the subject prefix \"Forward\", for the expected language"},"sent":{"type":"string","description":"A translation for the word \"sent\", for the expected language"},"language":{"type":"string","description":"The code of the expected language"},"timeZone":{"type":"string","description":"Timezone used by the agent, used to format the sent email date and time. If not defined, will default to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"}}},"EmailMessageReply":{"type":"object","required":["from","textBody","to"],"properties":{"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true}}},"EmailsSettings":{"type":"object","properties":{"sendingSizeLimit":{"type":"integer","format":"int32"}}},"CopyAttachmentsRequest":{"type":"object","required":["attachments","sourceMessage"],"properties":{"sourceMessage":{"description":"A reference to the email message within the current conversation that owns the attachments to be copied","$ref":"#/definitions/DomainEntityRef"},"attachments":{"type":"array","description":"A list of attachments that will be copied from the source message to the current draft","items":{"$ref":"#/definitions/Attachment"}}}},"InboundMessageRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the email such as Oracle, Salesforce, etc."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"}}},"AgentlessEmailSendResponseDto":{"type":"object","required":["conversationId","dateCreated","fromAddress","senderType","toAddresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"senderType":{"type":"string","description":"The identifier of the external participant of the given conversation.","enum":["Outbound","Inbound","Integration"]},"fromAddress":{"description":"The sender of the message.","$ref":"#/definitions/EmailAddress"},"toAddresses":{"type":"array","description":"The recipient of the message. We currently support one recipient only.","items":{"$ref":"#/definitions/EmailAddress"}},"replyToAddress":{"description":"The address to use for reply.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the message."},"dateCreated":{"type":"string","format":"date-time","description":"The message creation timestamp. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentlessEmailSendRequestDto":{"type":"object","required":["fromAddress","senderType","toAddresses"],"properties":{"senderType":{"type":"string","description":"The direction of the message.","enum":["Outbound","Inbound","Integration"]},"conversationId":{"type":"string","description":"The identifier of the conversation. This must be an email interaction."},"fromAddress":{"description":"The sender of the message.","$ref":"#/definitions/EmailAddress"},"toAddresses":{"type":"array","description":"The recipient of the message. We currently support one recipient only.","items":{"$ref":"#/definitions/EmailAddress"}},"replyToAddress":{"description":"The address to use for reply.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the message."},"textBody":{"type":"string","description":"The Content of the message, in plain text."},"htmlBody":{"type":"string","description":"The Content of the message, in HTML. Links, images and styles are allowed"}}},"EmailSettings":{"type":"object","properties":{"multipleRouteDestinationsOnInboundEmailEnabled":{"type":"boolean","description":"This setting allows a single inbound email that contains multiple routes configured in Genesys Cloud to create a conversation per route. When this setting is disabled only a single conversation will be created"}}},"CachedMediaItem":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the cached media.","readOnly":true},"url":{"type":"string","description":"The URL that represents the external media that has been cached","readOnly":true},"downloadUrl":{"type":"string","description":"A URL to fetch the cached media","readOnly":true},"mediaType":{"type":"string","description":"The media type for the URL","readOnly":true},"contentLengthBytes":{"type":"integer","format":"int32","description":"The content length of the media represented by the URL, in bytes.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the cached item was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateExpires":{"type":"string","format":"date-time","description":"The date the cached item expires and will be removed from the cache. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines an external media that has been ingested and cached by Genesys Cloud for conversation messaging"},"CachedMediaItemEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CachedMediaItem"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationChannelMetadata":{"type":"object","properties":{},"description":"Information about the channel."},"ConversationContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, a LINE sticker ID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."},"contentSizeBytes":{"type":"integer","format":"int64","description":"Size in bytes of the attachment content."}},"description":"Attachment object."},"ConversationContentButtonResponse":{"type":"object","required":["payload","text"],"properties":{"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"ConversationContentCard":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"defaultAction":{"description":"The default button action.","$ref":"#/definitions/ConversationContentCardAction"},"actions":{"type":"array","description":"An array of action objects.","items":{"$ref":"#/definitions/ConversationContentCardAction"}}},"description":"Card content object."},"ConversationContentCardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback","Unknown"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."},"url":{"type":"string","description":"A URL of a web page to direct the user to."}},"description":"A card action that a user can take."},"ConversationContentCarousel":{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","description":"An array of card objects.","items":{"$ref":"#/definitions/ConversationContentCard"}}},"description":"Carousel content object."},"ConversationContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"URL of the Location."},"address":{"type":"string","description":"Location postal address."},"text":{"type":"string","description":"Location name."},"latitude":{"type":"number","format":"double","description":"Latitude of the location."},"longitude":{"type":"number","format":"double","description":"Longitude of the location."}},"description":"Location object."},"ConversationContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The identifier of the message template in 'your-namespace@your-template-id/name' format. For External vendor (e.g WhatsApp), 'your-namespace@your-template-name'. For GenesysCloud canned response message template use 'cannedresponse' as your-namespace and use response ID as your-template-id (e.g. response ID=1234 then 'cannedresponse@1234')"},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/ConversationNotificationTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/ConversationNotificationTemplateBody"},"footer":{"description":"The template footer.","$ref":"#/definitions/ConversationNotificationTemplateFooter"}},"description":"Template notification object."},"ConversationContentQuickReply":{"type":"object","required":["payload","text"],"properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object."},"ConversationContentQuickReplyV2":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show as the title of the quick reply."},"actions":{"type":"array","description":"An array of quick reply objects.","items":{"$ref":"#/definitions/ConversationContentQuickReply"}}},"description":"Quick reply object V2."},"ConversationContentStory":{"type":"object","properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"An ephemeral story."},"ConversationContentText":{"type":"object","required":["body"],"properties":{"type":{"type":"string","description":"Type of text content (Deprecated).","enum":["Text"]},"body":{"type":"string","description":"Text to be shown for this content element."}},"description":"Message content element containing text only."},"ConversationEventCoBrowse":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of CoBrowse event.","enum":["Offering","OfferingExpired","OfferingAccepted","OfferingRejected"]},"sessionId":{"type":"string","description":"The CoBrowse session ID."},"sessionJoinToken":{"type":"string","description":"The CoBrowse session join token."}},"description":"A CoBrowse event."},"ConversationEventPresence":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Presence event.","enum":["Join","Disconnect","Clear","SignIn"]}},"description":"A Presence event."},"ConversationEventTyping":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Typing event.","enum":["On"]},"duration":{"type":"integer","format":"int64","description":"The duration of the Typing event in milliseconds.","readOnly":true}},"description":"A Typing event."},"ConversationMessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","Unknown"]},"location":{"description":"Location content.","$ref":"#/definitions/ConversationContentLocation"},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ConversationContentAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/ConversationContentQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ConversationContentButtonResponse"},"template":{"description":"Template notification content.","$ref":"#/definitions/ConversationContentNotificationTemplate"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/ConversationContentStory"},"card":{"description":"Card content","$ref":"#/definitions/ConversationContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ConversationContentCarousel"},"text":{"description":"Text content.","$ref":"#/definitions/ConversationContentText"},"quickReplyV2":{"description":"Quick reply V2 content.","$ref":"#/definitions/ConversationContentQuickReplyV2"}},"description":"Message content element. If contentType = \"Attachment\" only one item is allowed."},"ConversationMessageEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Typing","Presence","Unknown"]},"coBrowse":{"description":"CoBrowse event.","$ref":"#/definitions/ConversationEventCoBrowse"},"typing":{"description":"Typing event.","$ref":"#/definitions/ConversationEventTyping"},"presence":{"description":"Presence event.","$ref":"#/definitions/ConversationEventPresence"}},"description":"Message event element. Examples include: system messages, typing indicators, cobrowse offerings."},"ConversationMessagingChannel":{"type":"object","properties":{"id":{"type":"string","description":"The integration ID.","readOnly":true},"platform":{"type":"string","description":"The provider type.","readOnly":true,"enum":["Twitter","Facebook","Instagram","Line","Whatsapp","WebMessaging","Open","Sms"]},"messageId":{"type":"string","description":"Unique provider ID of the message such as a Facebook message ID.","readOnly":true},"to":{"description":"Information about the recipient the message is sent to.","readOnly":true,"$ref":"#/definitions/ConversationMessagingToRecipient"},"from":{"description":"Information about the recipient the message is received from.","readOnly":true,"$ref":"#/definitions/ConversationMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Time the message was edited. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateDeleted":{"type":"string","format":"date-time","description":"Time the message was deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Channel-specific information that describes the message and the message channel/provider."},"ConversationMessagingFromRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient."},"firstName":{"type":"string","description":"First name of the recipient."},"lastName":{"type":"string","description":"Last name of the recipient."},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/ConversationRecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is received from."},"ConversationMessagingToRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/ConversationRecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to."},"ConversationNormalizedMessage":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"Unique ID of the message. Message receipts will have the same ID as the message they reference.","readOnly":true},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","readOnly":true,"$ref":"#/definitions/ConversationMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/ConversationMessageContent"}},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/ConversationMessageEvent"}},"status":{"type":"string","description":"Message receipt status, only used with type Receipt.","readOnly":true,"enum":["Sent","Delivered","Read","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","readOnly":true,"items":{"$ref":"#/definitions/ConversationReason"}},"originatingEntity":{"type":"string","description":"Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.","enum":["Human","Bot"]},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected.","readOnly":true},"direction":{"type":"string","description":"The direction of the message.","readOnly":true,"enum":["Inbound","Outbound"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}},"byoSmsIntegrationId":{"type":"string","description":"The internal id representing the customer supplied sms integration message."}},"description":"General rich media message structure with normalized feature support across many messaging channels."},"ConversationNotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored."},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template body object."},"ConversationNotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored."}},"description":"Template footer object."},"ConversationNotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored."},"media":{"description":"Media template header image.","$ref":"#/definitions/ConversationContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template header object."},"ConversationNotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name."},"text":{"type":"string","description":"Parameter text value."}},"description":"Template parameters for placeholders in template."},"ConversationReason":{"type":"object","required":["message"],"properties":{"code":{"type":"string","description":"The reason code for the failed message receipt.","enum":["MessageExpired","RateLimited","MessageNotAllowed","GeneralError","UnsupportedMessage","UnknownMessage","InvalidMessageStructure","InvalidDestination","ServerError","MediaTypeNotAllowed","InvalidMediaContentLength","RecipientOptedOut"]},"message":{"type":"string","description":"Description of the reason for the failed message receipt."}},"description":"Reasons for a failed message receipt."},"ConversationRecipientAdditionalIdentifier":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the Identifier","readOnly":true,"enum":["Deployment","Subject","Unknown"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"MessageData":{"type":"object","required":["status","textBody","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerMessageId":{"type":"string","description":"The unique identifier of the message from provider"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"]},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"textBody":{"type":"string","description":"The body of the text message. (Deprecated - Instead use normalizedMessage.text)"},"status":{"type":"string","description":"The status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read","removed","published"]},"media":{"type":"array","description":"The media details associated to a message. (Deprecated - Instead use normalizedMessage.content[index].attachment)","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"The sticker details associated to a message. (Deprecated - Instead use normalizedMessage.content[index].attachment","items":{"$ref":"#/definitions/MessageSticker"}},"normalizedMessage":{"description":"The message into normalized format","readOnly":true,"$ref":"#/definitions/ConversationNormalizedMessage"},"normalizedReceipts":{"type":"array","description":"The delivery event associated with this message in normalized format, if the message direction was outbound","readOnly":true,"items":{"$ref":"#/definitions/ConversationNormalizedMessage"}},"createdBy":{"description":"User who sent this message.","$ref":"#/definitions/User"},"conversationId":{"type":"string","description":"The id of the conversation of this message."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/MessageMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toAddress":{"description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"Message instance details on the communication.","items":{"$ref":"#/definitions/MessageDetails"}},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging","open","instagram"]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"authenticated":{"type":"boolean","description":"If true, the participant member is authenticated."},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a message monitor."},"monitoredParticipant":{"description":"The participant being monitored when performing a message monitor.","$ref":"#/definitions/AddressableEntityRef"}}},"AdditionalMessage":{"type":"object","required":["textBody"],"properties":{"textBody":{"type":"string","description":"The body of the text message. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."},"mediaIds":{"type":"array","description":"The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","items":{"type":"string"}},"stickerIds":{"type":"array","description":"The sticker ids associated with the text message.","items":{"type":"string"}},"messagingTemplate":{"description":"The messaging template use to send a predefined canned response with the message","$ref":"#/definitions/MessagingTemplateRequest"}}},"MessagingTemplateRequest":{"type":"object","properties":{"responseId":{"type":"string","description":"A Response Management response identifier for a messaging template defined response"},"parameters":{"type":"array","description":"A list of Response Management response substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}}}},"TemplateParameter":{"type":"object","properties":{"id":{"type":"string","description":"Response substitution identifier"},"value":{"type":"string","description":"Response substitution value"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}}}},"OpenMessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","enum":["Attachment"]},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ConversationContentAttachment"}},"description":"Message content element."},"OpenMessagingChannel":{"type":"object","required":["from","time","to"],"properties":{"id":{"type":"string","description":"The Messaging Platform integration ID.","readOnly":true},"platform":{"type":"string","description":"The provider type.","readOnly":true,"enum":["Open"]},"type":{"type":"string","description":"Specifies if this message is part of a private or public conversation.","enum":["Private"]},"messageId":{"type":"string","description":"Unique provider ID of the message such as a Facebook message ID."},"to":{"description":"Information about the recipient the message is sent to.","$ref":"#/definitions/OpenMessagingToRecipient"},"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Information about the channel.","$ref":"#/definitions/ConversationChannelMetadata"}},"description":"Channel-specific information that describes the message and the message channel/provider."},"OpenMessagingFromRecipient":{"type":"object","required":["id","idType"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient."},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","enum":["Email","Phone","Opaque"]},"firstName":{"type":"string","description":"First name of the recipient."},"lastName":{"type":"string","description":"Last name of the recipient."},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient."}},"description":"Information about the recipient the message is received from."},"OpenMessagingToRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient."}},"description":"Information about the recipient the message is sent to."},"OpenNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference, as such should only be set when sending a message receipt."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Receipt"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenMessageContent"}},"status":{"type":"string","description":"Message receipt status, only used with type Receipt.","enum":["Sent","Delivered","Read","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."},"direction":{"type":"string","description":"The direction of the message.","enum":["Inbound","Outbound"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"CreateOutboundMessagingConversationRequest":{"type":"object","required":["queueId","toAddress","toAddressMessengerType"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to be associated with the message. This will determine the fromAddress of the message."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. For whatsapp messenger type, use a Whatsapp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a Whatsapp ID would be 13175555555"},"toAddressMessengerType":{"type":"string","description":"The messaging address messenger type.","enum":["sms","open","whatsapp"]},"useExistingConversation":{"type":"boolean","description":"An override to use an existing conversation. \nIf set to true, an existing conversation will be used if there is one within the conversation window. \nIf set to false, create request fails if there is a conversation within the conversation window."},"externalContactId":{"type":"string","description":"The external contact with which the message will be associated."}}},"MessageMediaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The detected internet media type of the the media object. If null then the media type should be dictated by the url."},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"uploadUrl":{"type":"string","description":"The URL returned to upload an attachment"},"status":{"type":"string","description":"The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid","readOnly":true,"enum":["uploading","valid","invalid"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SendAgentlessOutboundMessageResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"fromAddress":{"type":"string","description":"The sender of the message."},"toAddress":{"type":"string","description":"The recipient of the message."},"messengerType":{"type":"string","description":"Type of messenger.","enum":["sms","whatsapp","open"]},"textBody":{"type":"string","description":"The body of the text message."},"messagingTemplate":{"description":"The messaging template sent","$ref":"#/definitions/MessagingTemplateRequest"},"useExistingActiveConversation":{"type":"boolean","description":"Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false"},"message":{"description":"Sent agentless outbound message in normalized format","$ref":"#/definitions/MessageData"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SendAgentlessOutboundMessageRequest":{"type":"object","required":["fromAddress","toAddress","toAddressMessengerType"],"properties":{"fromAddress":{"type":"string","description":"The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID"},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555"},"toAddressMessengerType":{"type":"string","description":"The recipient messaging address messenger type.","enum":["sms","whatsapp","open"]},"textBody":{"type":"string","description":"The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."},"messagingTemplate":{"description":"The messaging template to use in the case of WhatsApp messenger type. This field is required when using WhatsApp messenger type","$ref":"#/definitions/MessagingTemplateRequest"},"useExistingActiveConversation":{"type":"boolean","description":"Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false"}}},"OpenEventNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message generated by Messaging Platform."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Event"]},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/OpenMessageEvent"}}},"description":"Open Messaging rich media message structure"},"OpenMessageEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["Typing"]},"typing":{"description":"Typing event.","$ref":"#/definitions/ConversationEventTyping"}},"description":"Message event element."},"OpenEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["Typing"]}},"description":"Message event element."},"OpenInboundMessagingChannel":{"type":"object","required":["from","time"],"properties":{"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Open Channel-specific information that describes the message and the message channel/provider."},"OpenInboundNormalizedEvent":{"type":"object","required":["channel","events"],"properties":{"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessagingChannel"},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/OpenEvent"}}},"description":"Open Event Messaging rich media message structure"},"OpenMessageNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message generated by Messaging Platform."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenMessageContent"}},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"OpenContentAttachment":{"type":"object","required":["mediaType","mime","url"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, middleware media UUID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."}},"description":"Attachment object."},"OpenInboundMessageContent":{"type":"object","properties":{"attachment":{"description":"Attachment content.","$ref":"#/definitions/OpenContentAttachment"}},"description":"Message content element."},"OpenInboundMessageMessagingChannel":{"type":"object","required":["from","time"],"properties":{"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageId":{"type":"string","description":"Unique provider ID of the message."},"metadata":{"description":"Additional Custom Information about the channel.","$ref":"#/definitions/ConversationChannelMetadata"}},"description":"Open Channel-specific information that describes the message and the message channel/provider, with additional message information"},"OpenInboundNormalizedMessage":{"type":"object","required":["channel"],"properties":{"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessageMessagingChannel"},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenInboundMessageContent"}},"metadata":{"type":"object","description":"Additional metadata about this message to capture non-channel specific data.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"ContentButtonResponse":{"type":"object","required":["payload","text","type"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"OpenReceiptNormalizedMessage":{"type":"object","required":["channel","direction","id","status","type"],"properties":{"id":{"type":"string","description":"The original unique message Id generated by the messaging platform, that this receipt message is referencing."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Receipt"]},"status":{"type":"string","description":"Message receipt status.","enum":["Sent","Delivered","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."},"direction":{"type":"string","description":"The direction of the message.","enum":["Inbound","Outbound"]}},"description":"Open Messaging rich media message structure"},"OpenInboundMessagingReceiptChannel":{"type":"object","required":["time","to"],"properties":{"to":{"description":"Information about the recipient the message is intended for.","$ref":"#/definitions/OpenMessagingToRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Open Channel-specific information that describes the message and the message channel/provider."},"OpenInboundNormalizedReceipt":{"type":"object","required":["channel","id","status"],"properties":{"id":{"type":"string","description":"The original unique message Id generated by the messaging platform, that this receipt message is referencing."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessagingReceiptChannel"},"status":{"type":"string","description":"Message receipt status.","enum":["Sent","Delivered","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."}},"description":"Open Messaging rich media message structure"},"MessageTypingEventRequest":{"type":"object","required":["typing"],"properties":{"typing":{"description":"Typing event","$ref":"#/definitions/ConversationEventTyping"},"dateSent":{"type":"string","format":"date-time","description":"The time when the message typing event was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ContentSetting":{"type":"object","properties":{"story":{"description":"Settings relating to facebook and instagram stories feature","$ref":"#/definitions/StorySetting"}}},"EventSetting":{"type":"object","properties":{"typing":{"description":"Settings regarding typing events","$ref":"#/definitions/TypingSetting"}}},"InboundOnlySetting":{"type":"object","properties":{"inbound":{"type":"string","enum":["Enabled","Disabled"]}}},"MediaType":{"type":"object","properties":{"type":{"type":"string","description":"The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types."}},"description":"Media type definition"},"MediaTypeAccess":{"type":"object","properties":{"inbound":{"type":"array","description":"List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.","items":{"$ref":"#/definitions/MediaType"}},"outbound":{"type":"array","description":"List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.","items":{"$ref":"#/definitions/MediaType"}}},"description":"Media type access definitions"},"MediaTypes":{"type":"object","properties":{"allow":{"description":"Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.","$ref":"#/definitions/MediaTypeAccess"}},"description":"Media types"},"MessagingIntegration":{"type":"object","required":["id","messengerType","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Integration","readOnly":true},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"status":{"type":"string","description":"The status of the Integration","readOnly":true,"enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"recipient":{"description":"The recipient associated to the Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSettingReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration"},"name":{"type":"string","description":"The messaging Setting profile name","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The messaging Setting profile URI","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Date this messaging Setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this messaging Setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"string","description":"Version number"},"createdBy":{"description":"User reference that created this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"updatedBy":{"description":"User reference that modified this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"}},"description":"Messaging Setting for messaging platform integrations"},"SettingDirection":{"type":"object","properties":{"inbound":{"type":"string","description":"Status for the Inbound Direction","enum":["Enabled","Disabled"]},"outbound":{"type":"string","description":"Status for the Outbound Direction","enum":["Enabled","Disabled"]}}},"StorySetting":{"type":"object","properties":{"mention":{"description":"Setting relating to Story Mentions","$ref":"#/definitions/InboundOnlySetting"},"reply":{"description":"Setting relating to Story Replies","$ref":"#/definitions/InboundOnlySetting"}}},"SupportedContentReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The SupportedContent unique identifier associated with this integration"},"name":{"type":"string","description":"The SupportedContent profile name","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The SupportedContent profile URI","readOnly":true},"mediaTypes":{"description":"Media types definition for the supported content","readOnly":true,"$ref":"#/definitions/MediaTypes"}},"description":"Reference to supported content profile associated with the integration"},"TypingSetting":{"type":"object","properties":{"on":{"description":"Should typing indication Events be sent","$ref":"#/definitions/SettingDirection"}}},"MessagingSticker":{"type":"object","required":["messengerType","providerStickerId","stickerType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerStickerId":{"type":"integer","format":"int32","description":"The sticker Id of the sticker, assigned by the sticker provider."},"providerPackageId":{"type":"integer","format":"int32","description":"The package Id of the sticker, assigned by the sticker provider."},"packageName":{"type":"string","description":"The package name of the sticker, assigned by the sticker provider."},"messengerType":{"type":"string","description":"The type of the messenger provider.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"stickerType":{"type":"string","description":"The type of the sticker.","enum":["standard","free","paid"]},"providerVersion":{"type":"integer","format":"int64","description":"The version of the sticker, assigned by the provider."},"uriLocation":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingStickerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingSticker"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationThreadingWindow":{"type":"object","required":["settings"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"settings":{"type":"array","description":"The conversation threading window timeout (Minutes) for each messaging type","items":{"$ref":"#/definitions/ConversationThreadingWindowSetting"}},"defaultTimeoutMinutes":{"type":"integer","format":"int64","description":"The default conversation threading window timeout (Minutes)","readOnly":true}}},"ConversationThreadingWindowSetting":{"type":"object","required":["messengerType","timeoutInMinutes"],"properties":{"messengerType":{"type":"string","description":"The type of messenger","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"timeoutInMinutes":{"type":"integer","format":"int64","description":"The conversation threading window timeout (Minutes) of specified messenger type"}}},"FacebookAppCredentials":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Genesys Cloud Facebook App Id","readOnly":true}}},"FacebookIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"appId":{"type":"string","description":"The App Id from Facebook messenger"},"pageId":{"type":"string","description":"The Page Id from Facebook messenger"},"pageName":{"type":"string","description":"The name of the Facebook page","readOnly":true},"pageProfileImageUrl":{"type":"string","description":"The url of the profile image of the Facebook page","readOnly":true},"status":{"type":"string","description":"The status of the Facebook Integration"},"recipient":{"description":"The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingSettingRequestReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration"}},"description":"Messaging Setting for messaging platform integrations"},"FacebookIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page Id of Facebook page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app Id of Facebook app. The appId is required when a customer wants to use their own approved Facebook app."},"appSecret":{"type":"string","description":"The app Secret of Facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacebookPermission":{"type":"object","properties":{"name":{"type":"string","description":"Facebook permission name","readOnly":true},"type":{"type":"string","description":"Facebook permission type","readOnly":true,"enum":["FacebookPrivate","FacebookPublic","InstagramPrivate","WhatsAppPrivate"]}},"description":"Facebook Permissions Model"},"FacebookPermissionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookPermission"}}}},"InstagramIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration ID.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"appId":{"type":"string","description":"The App ID from Facebook"},"pageId":{"type":"string","description":"The Page ID from Instagram messenger"},"instagramId":{"type":"string","description":"The ID from Instagram messenger"},"instagramUsername":{"type":"string","description":"The Username from Instagram messenger"},"instagramName":{"type":"string","description":"The name from Instagram messenger"},"instagramProfileImageUrl":{"type":"string","description":"The url of the profile image from Instagram messenger"},"status":{"type":"string","description":"The status of the Instagram Integration"},"recipient":{"description":"The recipient reference associated to the Instagram Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InstagramIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Instagram user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InstagramIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of Instagram user logged into Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page ID of Instagram page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app ID of Facebook app. The appId is required when a customer wants to use their own approved Facebook app."},"appSecret":{"type":"string","description":"The app Secret of Facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InstagramIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InstagramIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OpenIntegration":{"type":"object","required":["id","name","outboundNotificationWebhookSignatureSecretToken","outboundNotificationWebhookUrl"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"status":{"type":"string","description":"The status of the Open Integration"},"recipient":{"description":"The recipient associated to the Open messaging Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationUpdateRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationRequest":{"type":"object","required":["name","outboundNotificationWebhookSignatureSecretToken","outboundNotificationWebhookUrl"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token. This token must be longer than 15 characters."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OpenIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSetting":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"dateCreated":{"type":"string","format":"date-time","description":"Date this messaging setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this messaging setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"string","description":"Version number","readOnly":true},"createdBy":{"description":"User reference that created this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"updatedBy":{"description":"User reference that modified this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"content":{"description":"Configuration relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Configuration relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"MessagingSettingDefaultRequest":{"type":"object","required":["settingId"],"properties":{"settingId":{"type":"string","description":"Messaging Setting ID to be used as the default for this Organization."}}},"MessagingConfigListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingSetting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSettingRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"MessagingSettingPatchRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"SupportedContent":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"A unique supported content Id.","readOnly":true},"name":{"type":"string","description":"The name of the supported content profile"},"dateCreated":{"type":"string","format":"date-time","description":"Date this supported content profile was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this supported content profile was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this supported content profile","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that modified this supported content profile","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number","readOnly":true},"mediaTypes":{"description":"Defines the allowable media that may be accepted for an inbound message or to be sent in an outbound message. The following is an example of allowing all inbound media, and for outbound all images and only mpeg video: {\n \"mediaTypes\": {\n \"allow\": {\n \"inbound\": [{\"type\": \"*/*\"}],\n \"outbound\": [{\"type\": \"image/*\"}, {\"type\": \"video/mpeg\"}]\n }\n }\n}","$ref":"#/definitions/MediaTypes"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Supported content profile for inbound and outbound messages"},"SupportedContentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SupportedContent"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppAvailablePhoneNumberDetails":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","description":"The verified name associated with this phone number.","readOnly":true},"phoneNumber":{"type":"string","description":"The display name associated with this phone number. It's typically the E.164 representation of the number.","readOnly":true},"status":{"type":"string","description":"The status of this phone number.","readOnly":true}}},"WhatsAppAvailablePhoneNumberDetailsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppAvailablePhoneNumberDetails"}}}},"WhatsAppIntegration":{"type":"object","required":["id","name","phoneNumber","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"phoneNumber":{"type":"string","description":"The phone number associated to the WhatsApp integration."},"availablePhoneNumbers":{"description":"The list of available WhatsApp phone numbers for this account. Please select one phone number from this list to use with the created integration.","readOnly":true,"$ref":"#/definitions/WhatsAppAvailablePhoneNumberDetailsListing"},"status":{"type":"string","description":"The status of the WhatsApp Integration","enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"]},"recipient":{"description":"The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"activationStatusCode":{"type":"string","description":"The status code of WhatsApp Integration activation process","readOnly":true,"enum":["CodeSent","WaitRequired","ActivationFailed","CodeConfirmed","ConfirmationFailed","ResendCode"]},"activationErrorInfo":{"description":"The error information of WhatsApp Integration activation process","readOnly":true,"$ref":"#/definitions/ErrorBody"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppEmbeddedSignupIntegrationActivationRequest":{"type":"object","required":["phoneNumber","pin"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name","readOnly":true},"phoneNumber":{"type":"string","description":"Phone number to associate with the WhatsApp integration"},"pin":{"type":"string","description":"Specify the two-step verification PIN for that phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppEmbeddedSignupIntegrationRequest":{"type":"object","required":["embeddedSignupAccessToken","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"embeddedSignupAccessToken":{"type":"string","description":"The access token returned from the embedded signup flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationRequest":{"type":"object","required":["name","phoneNumber","wabaCertificate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration"},"wabaCertificate":{"type":"string","description":"The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Digits":{"type":"object","properties":{"digits":{"type":"string","description":"A string representing the digits pressed on phone."}}},"CreateCallbackOnConversationCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}},"callerId":{"type":"string","description":"The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."},"callerIdName":{"type":"string","description":"The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."}}},"TransferToAgentRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"userId":{"type":"string","description":"The id of the internal user."},"userName":{"type":"string","description":"The userName (like user’s email) of the internal user."},"userDisplayName":{"type":"string","description":"The name of the internal user."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"TransferToQueueRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"queueId":{"type":"string","description":"The id of the queue."},"queueName":{"type":"string","description":"The name of the queue."}}},"TransferToExternalRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"address":{"type":"string","description":"The address (like phone number) of the external contact."}}},"SecureSession":{"type":"object","required":["flow","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"The flow to execute securely","$ref":"#/definitions/DomainEntityRef"},"userData":{"type":"string","description":"Customer-provided data"},"state":{"type":"string","description":"The current state of a secure session","enum":["PENDING","COMPLETED","FAILED"]},"sourceParticipantId":{"type":"string","description":"Unique identifier for the participant initiating the secure session."},"disconnect":{"type":"boolean","description":"If true, disconnect the agent after creating the session"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateSecureSession":{"type":"object","required":["flowId","userData"],"properties":{"sourceParticipantId":{"type":"string","description":"requesting participant"},"flowId":{"type":"string","description":"the flow id to execute in the secure session"},"userData":{"type":"string","description":"user data for the secure session"},"disconnect":{"type":"boolean","description":"if true, disconnect the agent after creating the session"}}},"SecureSessionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecureSession"}}}},"FeedbackAddRequest":{"type":"object","required":["summary"],"properties":{"summary":{"type":"string","example":"Customer wants to cancel the ticket and he is happy with the service.","description":"Agent's summary for the conversation"},"rating":{"type":"string","description":"Agent’s rating for the system-generated summary.","enum":["Positive","Negative"]}}},"Credential":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"description":"The type of credential.","$ref":"#/definitions/CredentialType"},"credentialFields":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"properties":{"type":"object","description":"Properties describing credentials of this type.","readOnly":true},"displayOrder":{"type":"array","description":"Order in which properties should be displayed in the UI.","readOnly":true,"items":{"type":"string"}},"required":{"type":"array","description":"Properties that are required fields.","readOnly":true,"items":{"type":"string"}}}},"CredentialInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date the credentials were created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date credentials were last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"description":"Type of the credentials.","$ref":"#/definitions/CredentialType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialTypeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialInfoListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UploadUrlResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"LearningCoverArtUploadUrlRequest":{"type":"object","required":["contentType"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"contentType":{"type":"string","description":"The content type of the file to upload.","enum":["image/bmp","image/gif","image/jpeg","image/jpg","image/png"]},"serverSideEncryption":{"type":"string","enum":["AES256"]}}},"UploadUrlRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"contentType":{"type":"string","description":"The content type of the file to upload. Allows all MIME types"},"serverSideEncryption":{"type":"string","enum":["AES256"]}}},"Coretype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"A positive integer denoting the core type's version"},"dateCreated":{"type":"string","format":"date-time","description":"The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schema":{"description":"The core type's built-in schema","$ref":"#/definitions/Schema"},"current":{"type":"boolean","description":"A boolean indicating if the core type's version is the current one in use by the system"},"validationFields":{"type":"array","description":"An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type.","items":{"type":"string"}},"validationLimits":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/ValidationLimits"},"itemValidationFields":{"type":"array","description":"Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation","items":{"type":"string"}},"itemValidationLimits":{"example":"\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.","$ref":"#/definitions/ItemValidationLimits"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ItemValidationLimits":{"type":"object","required":["maxLength","minLength"],"properties":{"minLength":{"example":"\"minLength\": {\"min\": 0, \"max\": 100}","description":"A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MinLength"},"maxLength":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MaxLength"}}},"Items":{"type":"object","properties":{"type":{"type":"string"},"pattern":{"type":"string"}}},"MaxLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance."}}},"MinLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance."}}},"Schema":{"type":"object","properties":{"title":{"type":"string","description":"A core type's title","readOnly":true},"description":{"type":"string","description":"A core type's description","readOnly":true},"type":{"type":"array","example":"[\"string\"] for a text-based core type, [\"integer\"] for a numeric core type, or [\"boolean\", \"null\"] for the checkbox core type","description":"An array of fundamental JSON Schema primitive types on which the core type is based","readOnly":true,"items":{"type":"string"}},"items":{"example":"{\ntype\": \"string\",\n\"pattern\": \"^[\\\\S]+$\"\n}","description":"Denotes the type and pattern of the items in an enum core type","readOnly":true,"$ref":"#/definitions/Items"},"pattern":{"type":"string","description":"For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format","readOnly":true}}},"ValidationLimits":{"type":"object","properties":{"minLength":{"$ref":"#/definitions/MinLength"},"maxLength":{"$ref":"#/definitions/MaxLength"},"minItems":{"$ref":"#/definitions/MinLength"},"maxItems":{"$ref":"#/definitions/MaxLength"},"minimum":{"$ref":"#/definitions/MinLength"},"maximum":{"$ref":"#/definitions/MaxLength"}}},"CoretypeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Coretype"}},"selfUri":{"type":"string","format":"uri"}}},"SchemaQuantityLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":1","description":"The minimum number of schema field name characters allowed.","readOnly":true},"maxFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":100","description":"The maximum number of schema field name characters allowed.","readOnly":true},"minFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minFieldDescriptionCharacters\":0","description":"The minimum number of schema field description characters allowed.","readOnly":true},"maxFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxFieldDescriptionCharacters\":200","description":"The maximum number of schema field description characters allowed.","readOnly":true},"minSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"minSchemaNameCharacters\":1","description":"The minimum number of schema name characters allowed.","readOnly":true},"maxSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaNameCharacters\":50","description":"The maximum number of schema name characters allowed.","readOnly":true},"minSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minSchemaDescriptionCharacters\":0","description":"The minimum number of schema description characters allowed.","readOnly":true},"maxSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaDescriptionCharacters\":200","description":"The maximum number of schema description characters allowed.","readOnly":true},"maxNumberOfSchemasPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfSchemasPerOrg\":20","description":"The maximum number of schema allowed per org.","readOnly":true},"maxNumberOfFieldsPerSchema":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerSchema\":25","description":"The maximum number of schema fields allowed per schema.","readOnly":true},"maxNumberOfFieldsPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerOrg\":500","description":"The maximum number of schema fields allowed per organization across all of their schemas.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataTable":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The description from the JSON schema (equates to the Description field on the JSON schema.)"},"schema":{"description":"the schema as stored in the system.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself"},"DataTableExportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the export job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the export job","enum":["Processing","Failed","Succeeded"]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"downloadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can download the export file, when available"},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an export job of rows from a datatable"},"DataTableImportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the import job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the import job","enum":["WaitingForUpload","Processing","Failed","Succeeded"]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can upload the file to be imported"},"importMode":{"type":"string","description":"The indication of whether the processing should remove rows that don't appear in the import file","enum":["ReplaceAll","Append"]},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsUpdated":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"countRecordsDeleted":{"type":"integer","format":"int32","description":"The current count of the number of records deleted"},"countRecordsFailed":{"type":"integer","format":"int32","description":"The current count of the number of records that failed to import"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an import job of rows to a datatable"},"DataTableImportEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTableImportJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DataTablesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTable"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataTableRowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string","description":"The current stage for this agent"}}},"AttemptLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxAttemptsPerContact":{"type":"integer","format":"int32","description":"The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."},"maxAttemptsPerNumber":{"type":"integer","format":"int32","description":"The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."},"timeZoneId":{"type":"string","description":"If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY."},"resetPeriod":{"type":"string","description":"After how long the number of attempts will be set back to 0. Defaults to NEVER.","enum":["NEVER","TODAY"]},"recallEntries":{"type":"object","description":"Configuration for recall attempts.","additionalProperties":{"$ref":"#/definitions/RecallEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecallEntry":{"type":"object","properties":{"nbrAttempts":{"type":"integer","format":"int32"},"minutesBetweenAttempts":{"type":"integer","format":"int32"}}},"AttemptLimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttemptLimits"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Reaction":{"type":"object","required":["reactionType"],"properties":{"data":{"type":"string","description":"Parameter for this reaction. For transfer_flow, this would be the outbound flow id."},"name":{"type":"string","description":"Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name."},"reactionType":{"type":"string","description":"The reaction to take for a given call analysis result.","enum":["hangup","transfer","transfer_flow","play_file"]}}},"ResponseSet":{"type":"object","required":["name","responses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the ResponseSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}.","additionalProperties":{"$ref":"#/definitions/Reaction"}},"beepDetectionEnabled":{"type":"boolean","description":"Whether to enable answering machine beep detection"},"amdSpeechDistinguishEnabled":{"type":"boolean","description":"Whether to enable answering machine detection"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallableTime":{"type":"object","required":["timeSlots","timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"The time intervals for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the time slots; for example, Africa/Abidjan"}}},"CallableTimeSet":{"type":"object","required":["callableTimes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CallableTimeSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"The list of CallableTimes for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignTimeSlot":{"type":"object","required":["day","startTime","stopTime"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"stopTime":{"type":"string","example":"08:00:00","description":"The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"day":{"type":"integer","format":"int32","example":1,"description":"The day of the interval. Valid values: [1-7], representing Monday through Sunday"}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactCallbackRequest":{"type":"object","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"CampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","endpoint.donotdisturb","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"CallbackBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"callerId":{"type":"string","description":"The phone number displayed to recipients of the phone call. The value should conform to the E164 format."},"callerIdName":{"type":"string","description":"The name displayed to recipients of the phone call."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"CampaignInteraction":{"type":"object","properties":{"id":{"type":"string"},"campaign":{"$ref":"#/definitions/DomainEntityRef"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"contact":{"$ref":"#/definitions/DomainEntityRef"},"destinationAddress":{"type":"string"},"activePreviewCall":{"type":"boolean","description":"Boolean value if there is an active preview call on the interaction"},"lastActivePreviewWrapupTime":{"type":"string","format":"date-time","description":"The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callPlacedTime":{"type":"string","format":"date-time","description":"The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callRoutedTime":{"type":"string","format":"date-time","description":"The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"previewConnectedTime":{"type":"string","format":"date-time","description":"The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/DomainEntityRef"},"script":{"$ref":"#/definitions/DomainEntityRef"},"disposition":{"type":"string","description":"Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer","enum":["DISCONNECT","LIVE_VOICE","BUSY","MACHINE","NO_ANSWER","SIT_CALLABLE","SIT_UNCALLABLE","FAX"]},"callerName":{"type":"string"},"callerAddress":{"type":"string"},"previewPopDeliveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"$ref":"#/definitions/ConversationBasic"},"dialerSystemParticipantId":{"type":"string","description":"conversation participant id that is the dialer system participant to monitor the call from dialer perspective"},"dialingMode":{"type":"string"},"skills":{"type":"array","description":"Any skills that are attached to the call for routing","uniqueItems":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignInteractions":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/DomainEntityRef"},"pendingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"proceedingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"previewingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"interactingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"scheduledInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}}}},"ConversationBasic":{"type":"object","required":["startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"externalTag":{"type":"string","description":"The external tag associated with the conversation."},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"participants":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ParticipantBasic"}}}},"ParticipantBasic":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc.","items":{"type":"string"}},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/CallBasic"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/CallbackBasic"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."}}},"CampaignOutboundLinesAllocation":{"type":"object","properties":{"campaign":{"description":"The Campaign","$ref":"#/definitions/DomainEntityRef"},"campaignWeight":{"type":"integer","format":"int32","description":"The relative weight of the campaign"},"linesAssigned":{"type":"integer","format":"int32","description":"The number of lines dynamically assigned to the campaign"},"legacyWeight":{"type":"boolean","description":"true if relative weight of the campaign is not explicitly specified, false otherwise"}}},"CampaignOutboundLinesDistribution":{"type":"object","properties":{"campaign":{"description":"The Campaign for which dialing group distribution information was requested","$ref":"#/definitions/AddressableEntityRef"},"maxOutboundLineCount":{"type":"integer","format":"int32","description":"Maximum outbound calls that can be placed for Campaign's Edge Group or Site"},"maxLineUtilization":{"type":"number","description":"Maximum ratio of dialer calls to Campaign's Edge Group or Site capacity"},"availableOutboundLines":{"type":"integer","format":"int32","description":"Number of available outbound lines in Campaign's Edge Group or Site"},"reservedLines":{"type":"integer","format":"int32","description":"Number of reserved outbound lines in Campaign's Edge Group or Site"},"campaignsWithReservedLines":{"type":"array","description":"Information about campaigns with reserving lines in Campaign's Edge Group or Site","items":{"$ref":"#/definitions/CampaignOutboundLinesReservation"}},"campaignsWithDynamicallyAllocatedLines":{"type":"array","description":"Information about campaigns using dynamic lines allocation in Campaign's Edge Group or Site","items":{"$ref":"#/definitions/CampaignOutboundLinesAllocation"}}},"description":"Lines distribution information or Campaign's Edge Group or Site"},"CampaignOutboundLinesReservation":{"type":"object","properties":{"campaign":{"description":"The Campaign","$ref":"#/definitions/DomainEntityRef"},"linesReserved":{"type":"integer","format":"int32","description":"The number of lines reserved for the campaign"}}},"CampaignProgress":{"type":"object","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/DomainEntityRef"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts called during the campaign","readOnly":true},"numberOfContactsMessaged":{"type":"integer","format":"int64","description":"Number of contacts messaged during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true},"numberOfContactsSkipped":{"type":"object","description":"Number of contacts skipped during the campaign","readOnly":true,"additionalProperties":{"type":"integer","format":"int32"}}}},"AgentOwnedMappingPreview":{"type":"object","properties":{"agentOwnedColumn":{"type":"string","description":"The raw value of the agent-owned column","readOnly":true},"email":{"type":"string","description":"The email address of the user, if it exists","readOnly":true},"userId":{"type":"string","description":"The id of the user, if it exists","readOnly":true},"exists":{"type":"boolean","description":"Whether the user exists","readOnly":true},"isQueueMember":{"type":"boolean","description":"Whether the user is a member of the campaign's queue","readOnly":true},"recordCount":{"type":"integer","format":"int32","description":"The number of contact records whose agent-owned column matches the raw value","readOnly":true}}},"AgentOwnedMappingPreviewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentOwnedMappingPreview"}}}},"CallableContactsDiagnostic":{"type":"object","properties":{"attemptLimits":{"description":"Attempt limits for the campaign's contact list","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"ruleSetDiagnostics":{"type":"array","description":"Information regarding the campaign's rule sets","readOnly":true,"items":{"$ref":"#/definitions/RuleSetDiagnostic"}},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","readOnly":true},"scheduledInteractionsCount":{"type":"integer","format":"int32","description":"Current number of scheduled interactions on the campaign","readOnly":true},"timeZoneRescheduledCallsCount":{"type":"integer","format":"int32","description":"Current number of time zone rescheduled calls on the campaign","readOnly":true},"campaignSkillStatistics":{"description":"Information regarding the campaign's skills","readOnly":true,"$ref":"#/definitions/CampaignSkillStatistics"}}},"CampaignSkillStatistics":{"type":"object","properties":{"skillCombinations":{"type":"integer","format":"int32","description":"Number of available skill combinations for the campaign","readOnly":true},"eligibleSkilledAgents":{"type":"integer","format":"int32","description":"Number of eligible agents with skills for campaign","readOnly":true}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"RuleSetDiagnostic":{"type":"object","properties":{"ruleSet":{"description":"A campaign rule set","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"warnings":{"type":"array","description":"Diagnostic warnings for the rule set","readOnly":true,"items":{"type":"string","enum":["WRAPUP_CODE_NOT_IN_QUEUE","CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST","NO_DNC_LIST_FOR_APPEND","PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"]}}}},"CampaignRule":{"type":"object","required":["campaignRuleActions","campaignRuleConditions","campaignRuleEntities","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CampaignRule."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaignRuleEntities":{"description":"The list of entities that this CampaignRule monitors.","$ref":"#/definitions/CampaignRuleEntities"},"campaignRuleConditions":{"type":"array","description":"The list of conditions that are evaluated on the entities.","items":{"$ref":"#/definitions/CampaignRuleCondition"}},"campaignRuleActions":{"type":"array","description":"The list of actions that are executed if the conditions are satisfied.","items":{"$ref":"#/definitions/CampaignRuleAction"}},"matchAnyConditions":{"type":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this CampaignRule is currently enabled. Required on updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignRuleAction":{"type":"object","required":["actionType","campaignRuleActionEntities"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleAction. Required for certain actionTypes.","$ref":"#/definitions/CampaignRuleParameters"},"actionType":{"type":"string","description":"The action to take on the campaignRuleActionEntities.","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode","setCampaignAbandonRate","setCampaignNumberOfLines","setCampaignWeight","setCampaignMaxCallsPerAgent","changeCampaignQueue"]},"campaignRuleActionEntities":{"description":"The list of entities that this action will apply to.","$ref":"#/definitions/CampaignRuleActionEntities"}}},"CampaignRuleActionEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}},"useTriggeringEntity":{"type":"boolean","description":"If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition."}}},"CampaignRuleCondition":{"type":"object","required":["conditionType","parameters"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleCondition.","$ref":"#/definitions/CampaignRuleParameters"},"conditionType":{"type":"string","description":"The type of condition to evaluate.","enum":["campaignProgress","campaignAgents"]}}},"CampaignRuleEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignRuleParameters":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for comparison. Required for a CampaignRuleCondition.","enum":["equals","greaterThan","greaterThanEqualTo","lessThan","lessThanEqualTo"]},"value":{"type":"string","description":"The value for comparison. Required for a CampaignRuleCondition."},"priority":{"type":"string","description":"The priority to set a campaign to. Required for the 'setCampaignPriority' action.","enum":["1","2","3","4","5"]},"dialingMode":{"type":"string","description":"The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action.","enum":["agentless","preview","power","predictive","progressive","external"]}}},"CampaignRuleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Alteration":{"type":"object","properties":{"type":{"type":"string","description":"Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)","enum":["Exclusion","Inclusion"]},"start":{"type":"string","example":"2023-12-21T16:30:25","description":"The start date of an alteration range as an ISO-8601 string"},"end":{"type":"string","example":"2023-12-21T16:30:25","description":"The end date of an alteration range as an ISO-8601 string"}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this CampaignSchedule. For example, Africa/Abidjan."},"campaign":{"description":"The Campaign that this CampaignSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NextOccurrenceDetails":{"type":"object","properties":{"startOccurrenceDetails":{"description":"The details for the next start occurrence for the recurrence.","$ref":"#/definitions/OccurrenceDetails"},"endOccurrenceDetails":{"description":"The details for the next end occurrence for the recurrence.","$ref":"#/definitions/OccurrenceDetails"}}},"OccurrenceDetails":{"type":"object","properties":{"dateOfNextOccurrence":{"type":"string","format":"date-time","example":"2023-12-21T16:30:25.00Z","description":"The date of the next start or end occurrence for the recurrence as an ISO-8601 string"},"numberOfOccurrences":{"type":"integer","format":"int32","description":"The number of start or end occurrences that have been processed for the recurrence."}}},"Pattern":{"type":"object","required":["interval","type"],"properties":{"type":{"type":"string","description":"Pattern type (Daily/Weekly)","enum":["Daily","Weekly"]},"interval":{"type":"integer","format":"int32","description":"The interval of days between the occurrences for Daily pattern type, and weeks between the occurrences for Weekly"},"daysOfWeek":{"type":"array","description":"The day(s) of week the occurrence should be repeated. Required to set for Weekly pattern type. E.g. [\"Monday\", \"Wednesday\"]","items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"Range":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Range type (NoEnd: without an end date. EndDate: with an end date. Numbered: with a specific number of occurrences)","enum":["NoEnd","EndDate","Numbered"]},"end":{"type":"string","example":"2023-12-21T16:30:25","description":"The end date time of the last occurrence of the range as an ISO-8601 string. Required for EndDate range type."},"numberOfOccurrences":{"type":"integer","format":"int32","description":"The number of times the schedule will be repeated, e.g: 2. Required to set for Numbered range type."}}},"Reoccurrence":{"type":"object","required":["end","pattern","range","start","timeZone"],"properties":{"id":{"type":"string"},"start":{"type":"string","example":"2023-11-21T16:30:25","description":"The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"},"end":{"type":"string","example":"2023-11-21T16:30:25","description":"The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"},"timeZone":{"type":"string","description":"The time zone of the schedule e.g.: America/New_York"},"pattern":{"description":"The schedule pattern e.g.: Daily/Weekly","$ref":"#/definitions/Pattern"},"range":{"description":"The schedule range e.g.: EndDate/NoEnd/Numbered","$ref":"#/definitions/Range"},"alterations":{"type":"array","description":"Modifications to the original recurrence schedule (Exclusions/Inclusions)","items":{"$ref":"#/definitions/Alteration"}},"nextOccurrenceDetails":{"description":"The next occurrence details for the next start and end occurrences for the recurrence","readOnly":true,"$ref":"#/definitions/NextOccurrenceDetails"}}},"ScheduleInterval":{"type":"object","required":["end","start"],"properties":{"start":{"type":"string","description":"The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"CampaignLinesUtilization":{"type":"object","properties":{"assignedOutboundLines":{"type":"integer","format":"int32","description":"Number of outbound lines assigned to the campaign"},"totalAvailableOutboundLines":{"type":"integer","format":"int32","description":"Total number of available outbound lines in Campaign's Edge Group or Site"}}},"CampaignStats":{"type":"object","properties":{"contactRate":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"effectiveIdleAgents":{"type":"number","format":"double","description":"Number of effective available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true},"scheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently scheduled","readOnly":true},"timeZoneRescheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently timezone rescheduled","readOnly":true},"linesUtilization":{"description":"Information on the campaign's lines utilization","readOnly":true,"$ref":"#/definitions/CampaignLinesUtilization"}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"CampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommonCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["email","sms","voice"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommonCampaign":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["email","sms","voice"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListDivisionView":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses.","items":{"$ref":"#/definitions/EmailColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"Indicates the type of the phone column. For example, 'cell' or 'home'."},"callableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."}}},"EmailColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the email column."},"type":{"type":"string","description":"Indicates the type of the email column. For example, 'work' or 'personal'."},"contactableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking contactable times."}}},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true},"targetContactListIds":{"type":"array","description":"The contact list Ids for target contact lists.","readOnly":true,"items":{"type":"string"}},"listNamePrefix":{"type":"string","description":"The prefix for the contact list name","readOnly":true}}},"ContactListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactBulkSearchCriteria":{"type":"object","properties":{"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"]}}},"ContactListFilterClause":{"type":"object","properties":{"filterType":{"type":"string","description":"How to join predicates together.","enum":["AND","OR"]},"predicates":{"type":"array","description":"Conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterPredicate"}}}},"ContactListFilterPredicate":{"type":"object","properties":{"column":{"type":"string","description":"Contact list column from the ContactListFilter's contactList."},"columnType":{"type":"string","description":"The type of data in the contact column.","enum":["numeric","alphabetic"]},"operator":{"type":"string","description":"The operator for this ContactListFilterPredicate.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","BETWEEN","IN"]},"value":{"type":"string","description":"Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."},"range":{"description":"A range of values. Required for operators BETWEEN and IN.","$ref":"#/definitions/ContactListFilterRange"},"inverted":{"type":"boolean","description":"Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."}}},"ContactListFilterRange":{"type":"object","properties":{"min":{"type":"string","description":"The minimum value of the range. Required for the operator BETWEEN."},"max":{"type":"string","description":"The maximum value of the range. Required for the operator BETWEEN."},"minInclusive":{"type":"boolean","description":"Whether or not to include the minimum in the range."},"maxInclusive":{"type":"boolean","description":"Whether or not to include the maximum in the range."},"inSet":{"type":"array","description":"A set of values that the contact data should be in. Required for the IN operator.","uniqueItems":true,"items":{"type":"string"}}}},"ContactsExportRequest":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"contactIds":{"type":"array","description":"Contact IDs to be exported.","items":{"type":"string"}}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","readOnly":true}}},"ColumnStatus":{"type":"object","properties":{"contactable":{"type":"boolean","description":"Indicates whether or not an individual contact method column is contactable."}}},"ConfigurationOverrides":{"type":"object","properties":{"priority":{"type":"boolean","description":"Indicates whether or not the contact will be placed in front of the queue or at the end of the queue."}}},"ContactColumnTimeZone":{"type":"object","properties":{"timeZone":{"type":"string","description":"Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"columnType":{"type":"string","description":"Column Type will be either PHONE or ZIP","readOnly":true,"enum":["PHONE","ZIP"]}}},"ContactableStatus":{"type":"object","properties":{"contactable":{"type":"boolean","description":"Indicates whether or not the entire contact is contactable for the associated media type."},"columnStatus":{"type":"object","description":"A map of individual contact method columns to whether the individual column is contactable for the associated media type.","additionalProperties":{"$ref":"#/definitions/ColumnStatus"}}}},"DialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","example":"{ 'firstname': 'name', 'surname': 'name2', 'phone': '123456789'}","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"string"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"latestSmsEvaluations":{"type":"object","description":"A map of SMS records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"latestEmailEvaluations":{"type":"object","description":"A map of email records for the contact email columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactableStatus":{"type":"object","description":"A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type.","additionalProperties":{"$ref":"#/definitions/ContactableStatus"}},"contactColumnTimeZones":{"type":"object","description":"Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip","readOnly":true,"additionalProperties":{"$ref":"#/definitions/ContactColumnTimeZone"}},"configurationOverrides":{"description":"the priority property within ConfigurationOverides indicates whether or not the contact to be placed in front of the queue or at the end of the queue","readOnly":true,"$ref":"#/definitions/ConfigurationOverrides"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FilterPreviewResponse":{"type":"object","properties":{"filteredContacts":{"type":"integer","format":"int64"},"totalContacts":{"type":"integer","format":"int64"},"preview":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}}},"MessageEvaluation":{"type":"object","properties":{"contactColumn":{"type":"string","description":"The name of the contact column that was wrapped up"},"contactAddress":{"type":"string","description":"The address (phone or email) that was wrapped up"},"messageType":{"type":"string","description":"The type of message sent","enum":["Sms","Email"]},"wrapupCodeId":{"type":"string","description":"The id of the wrap-up code"},"timestamp":{"type":"string","format":"date-time","description":"The time that the wrap-up was applied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"Indicates whether or not a phone number is callable."}}},"ContactListFilter":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the list."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The contact list the filter is based on. Required if sourceType is ContactList","$ref":"#/definitions/DomainEntityRef"},"contactListTemplate":{"description":"The contact list template the filter is based on. Required if sourceType is ContactListTemplate","$ref":"#/definitions/DomainEntityRef"},"sourceType":{"type":"string","description":"The source type the filter is based on.","enum":["ContactList","ContactListTemplate"]},"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListFilterEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListFilterBulkRetrieveBody":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The IDs of the Contact List Filters to retrieve.","items":{"type":"string"}}}},"ColumnDataTypeSpecification":{"type":"object","properties":{"columnName":{"type":"string","description":"The column name of a column selected for dynamic queueing"},"columnDataType":{"type":"string","description":"The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)","enum":["NUMERIC","TEXT","TIMESTAMP"]},"min":{"type":"integer","format":"int32","description":"The minimum length of the numeric column selected for dynamic queueing"},"max":{"type":"integer","format":"int32","description":"The maximum length of the numeric column selected for dynamic queueing"},"maxLength":{"type":"integer","format":"int32","description":"The maximum length of the text column selected for dynamic queueing"}}},"ContactList":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses","items":{"$ref":"#/definitions/EmailColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"attemptLimits":{"description":"AttemptLimits for this ContactList.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactList."},"zipCodeColumnName":{"type":"string","description":"The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"columnDataTypeSpecifications":{"type":"array","description":"The settings of the columns selected for dynamic queueing","items":{"$ref":"#/definitions/ColumnDataTypeSpecification"}},"trimWhitespace":{"type":"boolean","description":"Whether to trim white space when importing a contactlist csv file, default value = true"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneMappingPreview":{"type":"object","properties":{"contactList":{"description":"The associated ContactList","$ref":"#/definitions/DomainEntityRef"},"contactsPerTimeZone":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedUsingZipCode":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedToASingleZone":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone"},"contactsMappedToASingleZoneUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone and were mapped using the zip code column"},"contactsMappedToMultipleZones":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones"},"contactsMappedToMultipleZonesUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones and were mapped using the zip code column"},"contactsInDefaultWindow":{"type":"integer","format":"int64","description":"The total number of contacts that will be dialed during the default window"},"contactListSize":{"type":"integer","format":"int64","description":"The total number of contacts in the contact list"}}},"ContactListTemplate":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses","items":{"$ref":"#/definitions/EmailColumn"}},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"attemptLimits":{"description":"AttemptLimits for this ContactListTemplate.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactListTemplate."},"zipCodeColumnName":{"type":"string","description":"The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"columnDataTypeSpecifications":{"type":"array","description":"The settings of the columns selected for dynamic queueing","items":{"$ref":"#/definitions/ColumnDataTypeSpecification"}},"trimWhitespace":{"type":"boolean","description":"Whether to trim white space when importing a ContactListTemplate csv file, default value = true"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListTemplateBulkRetrieveBody":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The IDs of the Contact List Templates to retrieve.","items":{"type":"string"}}}},"ContactListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactsBulkOperationJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique job identifier.","readOnly":true},"state":{"type":"string","description":"The job state.","readOnly":true,"enum":["InProgress","Complete","Failed"]},"type":{"type":"string","description":"The job type.","readOnly":true,"enum":["BulkDelete","BulkEdit"]},"totalRecords":{"type":"integer","format":"int64","description":"Total records that will be impacted by the bulk operation.","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"Amount of records that have been impacted by the bulk operation.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"Percentage of records that have been impacted by the bulk operation.","readOnly":true},"failureReason":{"description":"Information on failure reason.","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"downloadURI":{"type":"string","description":"URI to download the original backup contacts.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactBulkEditRequest":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"contactIds":{"type":"array","description":"Contact IDs to be bulk edited.","items":{"type":"string"}},"contact":{"description":"Contact object with details of fields used for patching.","$ref":"#/definitions/DialerContact"}}},"ContactBulkSearchParameters":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID. Either this property or criteria is required."},"criteria":{"description":"Criteria to filter the contacts by. Either this property or contactListFilterId is required.","$ref":"#/definitions/ContactBulkSearchCriteria"}}},"ContactListingResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"contactsCount":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListingRequest":{"type":"object","required":["pageNumber","pageSize"],"properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"pageNumber":{"type":"integer","format":"int32","description":"Page number."},"pageSize":{"type":"integer","format":"int32","description":"Page size. The max that will be returned is 50."},"contactSorts":{"type":"array","description":"The order in which to sort contacts.","items":{"$ref":"#/definitions/ContactSort"}}}},"WritableDialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","example":"{ 'firstname': 'name', 'surname': 'name2', 'phone': '123456789'}","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"string"}},"latestSmsEvaluations":{"type":"object","description":"A map of SMS records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"latestEmailEvaluations":{"type":"object","description":"A map of email records for the contact email columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactableStatus":{"type":"object","description":"A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type.","additionalProperties":{"$ref":"#/definitions/ContactableStatus"}},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"AuditEntity":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the entity the action of this AuditEntity targeted."},"id":{"type":"string","description":"The id of the entity the action of this AuditEntity targeted."},"name":{"type":"string","description":"The name of the entity the action of this AuditEntity targeted."},"selfUri":{"type":"string","description":"The selfUri for this entity."}}},"AuditMessage":{"type":"object","required":["id","level","receivedTimestamp","serviceName","status"],"properties":{"id":{"type":"string","description":"AuditMessage ID."},"user":{"$ref":"#/definitions/AuditUser"},"correlationId":{"type":"string","description":"Correlation ID."},"transactionId":{"type":"string","description":"Transaction ID."},"transactionInitiator":{"type":"boolean","description":"Whether or not this audit can be considered the initiator of the transaction it is a part of."},"application":{"type":"string","description":"The application through which the action of this AuditMessage was initiated."},"serviceName":{"type":"string","description":"The name of the service which sent this AuditMessage."},"level":{"type":"string","description":"The level of this audit. USER or SYSTEM."},"timestamp":{"type":"string","description":"The time at which the action of this AuditMessage was initiated."},"receivedTimestamp":{"type":"string","description":"The time at which this AuditMessage was received."},"status":{"type":"string","description":"The status of the action of this AuditMessage"},"actionContext":{"type":"string","description":"The context of a system-level action"},"action":{"type":"string","description":"A string representing the action that took place"},"changes":{"type":"array","description":"Details about any changes that occurred in this audit","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"},"serviceContext":{"description":"The service-specific context associated with this AuditMessage.","$ref":"#/definitions/ServiceContext"}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"Which page was returned."},"pageSize":{"type":"integer","format":"int32","description":"The number of results in a page."},"total":{"type":"integer","format":"int32","description":"The total number of results."},"pageCount":{"type":"integer","format":"int32","description":"The number of pages of results."},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"AuditUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the user who initiated the action of this AuditMessage."},"name":{"type":"string","description":"The full username of the user who initiated the action of this AuditMessage."},"display":{"type":"string","description":"The display name of the user who initiated the action of this AuditMessage."}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"The old values which were modified and/or removed by this action.","items":{"type":"string"}},"newValues":{"type":"array","description":"The new values which were modified and/or added by this action.","items":{"type":"string"}}}},"Entry":{"type":"object","properties":{"value":{"type":"string","description":"A value included in this facet."},"count":{"type":"integer","format":"int32","description":"The number of results with this value."}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that was faceted on."},"entries":{"type":"array","description":"The entries resulting from this facet.","items":{"$ref":"#/definitions/Entry"}}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string","description":"Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members."}}},"AuditFacet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"AuditFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"The word or words to search for."},"queryFields":{"type":"array","description":"The fields in which to search for the queryPhrase.","items":{"type":"string"}},"facets":{"type":"array","description":"The fields to facet on.","items":{"$ref":"#/definitions/AuditFacet"}},"filters":{"type":"array","description":"The fields to filter on.","items":{"$ref":"#/definitions/AuditFilter"}}}},"DncPatchCustomExclusionColumnsRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"customExclusionColumnEntries":{"type":"array","description":"The list of custom exclusion column entries to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC customExclusionColumnEntries in yyyy-MM-ddTHH:mmZ format"}}},"DncListDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncPatchEmailsRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"emailAddresses":{"type":"array","description":"The list of email addresses to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC email addresses in yyyy-MM-ddTHH:mmZ format"}}},"DncPatchPhoneNumbersRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"phoneNumbers":{"type":"array","description":"The list of phone numbers to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format"}}},"DncList":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"campaignId":{"type":"string","description":"A dnc.com campaignId. Optional if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"customExclusionColumn":{"type":"string","description":"The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListCreate":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"campaignId":{"type":"string","description":"A dnc.com campaignId. Optional if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"customExclusionColumn":{"type":"string","description":"The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EventLog":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"errorEntity":{"$ref":"#/definitions/DomainEntityRef"},"relatedEntity":{"$ref":"#/definitions/DomainEntityRef"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"level":{"type":"string","enum":["INFO","WARNING","ERROR"]},"category":{"type":"string","enum":["CALLBACK","CALL_RESTRICTION","CALL_RULE","CAMPAIGN","CAMPAIGN_RULE","CONTACT","CONTACT_LIST_FILTER","DIGITAL_RULE","DNC_LIST","ENTITY_LIMIT","IMPORT_ERROR","MESSAGE_RESTRICTION","MESSAGING_CAMPAIGN","IMPORT_TEMPLATE","ORGANIZATION_CONFIGURATION","SCHEDULE","MESSAGING_CAMPAIGN_SCHEDULE","EMAIL_CAMPAIGN_SCHEDULE"]},"correlationId":{"type":"string"},"eventMessage":{"$ref":"#/definitions/EventMessage"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventMessage":{"type":"object","properties":{"code":{"type":"string","enum":["ACTIVE_CAMPAIGNS_LIMIT_EXCEEDED","ALL_CAMPAIGNS_BLACKLISTED","APPROACHING_CONTACT_LIMIT","APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT","APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT","APPROACHING_ENTITY_LIMIT","AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID","CAMPAIGN_BLACKLISTED","CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH","CAMPAIGN_EMAIL_BODY_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_EMAIL_SUBJECT_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_INVALIDATED","CAMPAIGN_FORCE_STOPPED","CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_START_ERROR","CAMPAIGN_RULE_START_ERROR","CAMPAIGN_SET_DIALING_MODE_ERROR","CAMPAIGN_STOPPED","CAMPAIGN_THROTTLED","CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED","INVALID_CALLABLE_TIME_ZONE","CALLBACK_CREATION_INVALID_NUMBER","CALL_RULE_INVALID_CONTACT_COLUMN","CALL_RULE_MISSING_DATA_ACTION_INPUT","CALL_RULE_MISMATCH_TYPE","CALL_RULE_INVALID_OPERATOR","CALL_RULE_NO_DNC_LISTS_CONFIGURED","CALL_RULE_UPDATED_PHONE_COLUMN","CONTACT_LIST_FILTER_EVALUATION_FAILED","CONTACT_LIST_FILTER_INTERNAL_ERROR","CONTACT_COLUMNS_LIMIT_EXCEEDED","CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED","CONTACT_ID_LENGTH_LIMIT_EXCEEDED","CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED","CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","DATA_ACTION_EXECUTION_FAILED","DATA_ACTION_AUTHENTICATION_FAILURE","DATA_ACTION_NOT_FOUND","DATA_ACTION_TOO_MANY_REQUESTS","DATA_ACTION_TOO_MANY_REQUESTS_REMOTE","ACTION_EXECUTION_FAILED","ACTION_EXECUTION_FAILED_INVALID_PARAMETER","DIGITAL_RULE_EVALUATION_FAILED","DIGITAL_RULE_INTERNAL_ERROR","DIGITAL_RULE_NO_DNC_LISTS_CONFIGURED","DIGITAL_RULE_UPDATED_CONTACT_ADDRESS","DIGITAL_RULE_SMS_PHONE_NUMBER_TYPE_MISMATCH","DIGITAL_RULE_ERROR_SKIPPED","DNC_AUTHENTICATION_FAILURE","EXCEEDED_CONTACT_LIMIT","EXCEEDED_DNC_RECORD_LIMIT","EXCEEDED_DNC_PHONE_NUMBER_LENGTH","INACTIVE_EDGES_FAILED_PLACE_CALLS","INACTIVE_EDGES_TURNED_CAMPAIGN_OFF","INVALID_AGENT","INVALID_EMAIL_ADDRESS","INVALID_PHONE_NUMBER","IMPORT_FAILED_TO_READ_HEADERS","IMPORT_COULD_NOT_PARSE_AN_ENTRY","IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT","IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS","IMPORT_INVALID_CUSTOM_ID","IMPORT_INVALID_DATA","IMPORT_INVALID_EMAIL_ADDRESSES","IMPORT_INVALID_PHONE_NUMBERS","IMPORT_INVALID_EXPIRATION_DATE","IMPORT_EXPIRATION_DATE_EXCEEDS_MAX_DAYS","IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT","IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT","IMPORT_MISSING_CUSTOM_ID","IMPORT_NO_COLUMNS_DEFINED","IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST","IMPORT_LIST_NO_LONGER_EXISTS","IMPORT_NO_LISTS_CREATED_NO_CONTACTS_MATCH_FILTER","IMPORT_TARGET_CONTACT_LIST_NAME_EXISTS","IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","IMPORT_FAILED_CONTACT_DATA_GREATER_THAN_MAX_LENGTH","IMPORT_FAILED_CONTACT_DATA_NOT_WITHIN_MIN_MAX_RANGE","IMPORT_FAILED_CONTACT_DATA_INVALID_DATATYPE","IMPORT_TOO_MANY_COLUMNS","IMPORT_TOO_MANY_EXTRA_COLUMNS","IMPORT_CONTACT_LIST_NAME_LENGTH_EXCEEDED","ORGANIZATION_HAS_NO_DOMAIN_SET","RECYCLE_CAMPAIGN","SCHEDULED_CAMPAIGN_INVALID","SCHEDULE_UNKNOWN_ERROR"]},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"object"}},"documentationUri":{"type":"string"},"resourceURIs":{"type":"array","items":{"type":"string"}}}},"DialerEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventLog"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Column":{"type":"object","properties":{"columnName":{"type":"string","description":"Column name. Mandatory for Fixed position/length file format."},"columnNumber":{"type":"integer","format":"int32","description":"0 based column number in delimited file format"},"startPosition":{"type":"integer","format":"int32","description":"Zero-based position of the first column's character. Mandatory for Fixed position/length file format."},"length":{"type":"integer","format":"int32","description":"Column width. Mandatory for Fixed position/length file format."}}},"FileSpecificationTemplate":{"type":"object","required":["format","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the File Specification template."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"description":{"type":"string","description":"Description of the file specification template"},"format":{"type":"string","description":"File format","enum":["FixedLength","Delimited"]},"numberOfHeadingLinesSkipped":{"type":"integer","format":"int32","description":"Number of heading lines to be skipped"},"numberOfTrailingLinesSkipped":{"type":"integer","format":"int32","description":"Number of trailing lines to be skipped"},"header":{"type":"boolean","description":"If true indicates that delimited file has a header row, which can provide column names"},"delimiter":{"type":"string","description":"Kind of delimiter","enum":["Comma","Pipe","Colon","Tab","Semicolon","Custom"]},"delimiterValue":{"type":"string","description":"Delimiter character, used only when delimiter=\"Custom\""},"columnInformation":{"type":"array","description":"Columns specification","items":{"$ref":"#/definitions/Column"}},"preprocessingRules":{"type":"array","description":"Preprocessing rules","items":{"$ref":"#/definitions/PreprocessingRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PreprocessingRule":{"type":"object","properties":{"find":{"type":"string","description":"The regular expression to which file lines are to be matched."},"replaceWith":{"type":"string","description":"The string to be substituted for each match."},"global":{"type":"boolean","description":"Replaces all matching substrings in every line."},"ignoreCase":{"type":"boolean","description":"Enables case-insensitive matching"}}},"FileSpecificationTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FileSpecificationTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ImportTemplate":{"type":"object","required":["contactListTemplate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the import template."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactListTemplate":{"description":"ContactListTemplate for this ImportTemplate.","$ref":"#/definitions/DomainEntityRef"},"contactListFilter":{"description":"ContactListFilter for this ImportTemplate.","$ref":"#/definitions/DomainEntityRef"},"useSplittingCriteria":{"type":"boolean","description":"Whether or not to use splitting criteria. Default is false."},"splittingInformation":{"description":"How to split contact records, required if useSplittingCriteria is true.","$ref":"#/definitions/SplittingInformation"},"listNameFormat":{"type":"string","description":"The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.","enum":["ListNamePrefix","ListNamePrefixMonthDayYear","ListNamePrefixMonthDayYearHourMinuteSecond","ListNamePrefixPart","ListNamePrefixMonthDayYearPart","ListNamePrefixMonthDayYearHourMinuteSecondPart","Custom"]},"customListNameFormatValue":{"type":"string","description":"Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second."},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SplittingInformation":{"type":"object","properties":{"criteria":{"type":"string","description":"The splitting criteria type","enum":["Percentage","Quantity","Column","Custom"]},"criteriaValue":{"type":"string","description":"The criteria value for the specified criteria type"},"createRemainderContactList":{"type":"boolean","description":"Whether to create remainder contact list"},"useWaterfallRule":{"type":"boolean","description":"Whether to use waterfall rule"}}},"ImportTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ImportTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AtzmTimeSlot":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"}}},"AtzmTimeSlotWithTimeZone":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"},"timeZoneId":{"type":"string","example":"America/New York","description":"The time zone to use for contacts that cannot be mapped."}}},"AutomaticTimeZoneMappingSettings":{"type":"object","properties":{"callableWindows":{"type":"array","description":"The time intervals to use for automatic time zone mapping.","items":{"$ref":"#/definitions/CallableWindow"}},"supportedCountries":{"type":"array","description":"The countries that are supported for automatic time zone mapping.","items":{"type":"string"}}}},"CallableWindow":{"type":"object","properties":{"mapped":{"description":"The time interval to place outbound calls, for contacts that can be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlot"},"unmapped":{"description":"The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlotWithTimeZone"}}},"OutboundSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on any campaign"},"maxConfigurableCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be configured to be placed per agent on any campaign","readOnly":true},"maxLineUtilization":{"type":"number","format":"double","description":"The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]"},"abandonSeconds":{"type":"number","format":"double","description":"The number of seconds used to determine if a call is abandoned"},"complianceAbandonRateDenominator":{"type":"string","description":"The denominator to be used in determining the compliance abandon rate","enum":["ALL_CALLS","CALLS_THAT_REACHED_QUEUE"]},"automaticTimeZoneMapping":{"description":"The settings for automatic time zone mapping. Note that changing these settings will change them for both voice and messaging campaigns.","$ref":"#/definitions/AutomaticTimeZoneMappingSettings"},"rescheduleTimeZoneSkippedContacts":{"type":"boolean","description":"Whether or not to reschedule time-zone blocked contacts"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Condition":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition.","enum":["wrapupCondition","systemDispositionCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition","contactPropertyCondition","dataActionCondition"]},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Condition. Default is false."},"attributeName":{"type":"string","description":"An attribute name associated with this Condition. Required for a contactAttributeCondition."},"value":{"type":"string","description":"A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."},"valueType":{"type":"string","description":"The type of the value associated with this Condition. Not used for a DataActionCondition.","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","description":"An operation with which to evaluate the Condition. Not used for a DataActionCondition.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","IN"]},"codes":{"type":"array","description":"List of wrap-up code identifiers. Required for a wrapupCondition.","items":{"type":"string"}},"property":{"type":"string","description":"A value associated with the property type of this Condition. Required for a contactPropertyCondition."},"propertyType":{"type":"string","description":"The type of the property associated with this Condition. Required for a contactPropertyCondition.","enum":["LAST_ATTEMPT_BY_COLUMN","LAST_ATTEMPT_OVERALL","LAST_WRAPUP_BY_COLUMN","LAST_WRAPUP_OVERALL"]},"dataAction":{"description":"The Data Action to use for this condition. Required for a dataActionCondition.","$ref":"#/definitions/DomainEntityRef"},"dataNotFoundResolution":{"type":"boolean","description":"The result of this condition if the data action returns a result indicating there was no data. Required for a DataActionCondition."},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionCondition."},"callAnalysisResultField":{"type":"string","description":"The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionCondition."},"agentWrapupField":{"type":"string","description":"The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionCondition."},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionCondition.","items":{"$ref":"#/definitions/ContactColumnToDataActionFieldMapping"}},"predicates":{"type":"array","description":"A list of predicates defining the comparisons to use for this condition. Required for a dataActionCondition.","items":{"$ref":"#/definitions/DataActionConditionPredicate"}}}},"ContactColumnToDataActionFieldMapping":{"type":"object","required":["contactColumnName","dataActionField"],"properties":{"contactColumnName":{"type":"string","description":"The name of a contact column whose data will be passed to the data action"},"dataActionField":{"type":"string","description":"The name of an input field from the data action that the contact column data will be passed to"}}},"DataActionConditionPredicate":{"type":"object","required":["comparisonValue","inverted","outputField","outputFieldMissingResolution","outputOperator"],"properties":{"outputField":{"type":"string","description":"The name of an output field from the data action's output to use for this condition"},"outputOperator":{"type":"string","description":"The operation with which to evaluate this condition","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"comparisonValue":{"type":"string","description":"The value to compare against for this condition"},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Predicate. Default is false."},"outputFieldMissingResolution":{"type":"boolean","description":"The result of this predicate if the requested output field is missing from the data action's result"}}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"The type of this DialerAction.","enum":["Action","modifyContactAttribute","dataActionBehavior"]},"actionTypeName":{"type":"string","description":"Additional type specification for this DialerAction.","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","APPEND_CUSTOM_ENTRY_TO_DNC_LIST","SCHEDULE_CALLBACK","CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","SET_CALLER_ID","SET_SKILLS","DATA_ACTION"]},"updateOption":{"type":"string","description":"Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"]},"properties":{"type":"object","description":"A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).","additionalProperties":{"type":"string"}},"dataAction":{"description":"The Data Action to use for this action. Required for a dataActionBehavior.","$ref":"#/definitions/DomainEntityRef"},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionBehavior.","items":{"$ref":"#/definitions/ContactColumnToDataActionFieldMapping"}},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionBehavior."},"callAnalysisResultField":{"type":"string","description":"The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionBehavior."},"agentWrapupField":{"type":"string","description":"The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionBehavior."}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["DIALER_PRECALL","DIALER_WRAPUP"]},"conditions":{"type":"array","description":"A list of Conditions. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of actions to be taken if the conditions are true.","items":{"$ref":"#/definitions/DialerAction"}}}},"RuleSet":{"type":"object","required":["name","rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the RuleSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DialerRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignSequence":{"type":"object","required":["campaigns","currentCampaign","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"The ordered list of Campaigns that this CampaignSequence will run.","items":{"$ref":"#/definitions/DomainEntityRef"}},"currentCampaign":{"type":"integer","format":"int32","description":"A zero-based index indicating which Campaign this CampaignSequence is currently on.","readOnly":true},"status":{"type":"string","description":"The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.","enum":["on","off","complete"]},"stopMessage":{"type":"string","description":"A message indicating if and why a CampaignSequence has stopped unexpectedly.","readOnly":true},"repeat":{"type":"boolean","description":"Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated CampaignSequence.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this SequenceSchedule. For example, Africa/Abidjan."},"sequence":{"description":"The CampaignSequence that this SequenceSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","description":"A map from wrap-up code identifiers to a set of wrap-up flags.","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AppendToDncActionSettings":{"type":"object","required":["expire"],"properties":{"expire":{"type":"boolean","description":"Whether to expire the record appended to the DNC list."},"expirationDuration":{"type":"string","example":"P19DT15H13M","description":"If 'expire' is set to true, how long to keep the record."},"listType":{"type":"string","description":"The Dnc List Type to append entries to","enum":["Rds","RdsCustom"]}}},"ContactAddressConditionSettings":{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","description":"The operator to use when comparing address values.","enum":["Equals","Contains","BeginsWith","EndsWith"]},"value":{"type":"string","example":"+1555, outlook.com","description":"The value to compare against the contact's address."}}},"ContactAddressTypeConditionSettings":{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","description":"The operator to use when comparing the address types.","enum":["Equals","Contains","BeginsWith","EndsWith"]},"value":{"type":"string","description":"The type value to compare against the contact column type."}}},"ContactColumnConditionSettings":{"type":"object","required":["columnName","operator","value","valueType"],"properties":{"columnName":{"type":"string","description":"The name of the contact list column to evaluate."},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Equals","LessThan","LessThanEquals","GreaterThan","GreaterThanEquals","Contains","BeginsWith","EndsWith","Before","After"]},"value":{"type":"string","example":"For Numeric: '1234', '1234.56', '$1,234.56'. For DateTime: '2022-01-01T12:01:23.456-0000'. For Period: 'P1DT1H1M'. ","description":"The value to compare against the contact's data."},"valueType":{"type":"string","description":"The data type the value should be treated as.","enum":["DateTime","Numeric","Period","String"]}}},"DataActionConditionSettings":{"type":"object","required":["dataActionId","dataNotFoundResolution"],"properties":{"dataActionId":{"type":"string","description":"The Data Action Id to use for this condition."},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed into."},"dataNotFoundResolution":{"type":"boolean","description":"The result of this condition if the data action returns a result indicating there was no data."},"predicates":{"type":"array","description":"A list of predicates defining the comparisons to use for this condition.","items":{"$ref":"#/definitions/DigitalDataActionConditionPredicate"}},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields.","items":{"$ref":"#/definitions/DataActionContactColumnFieldMapping"}}}},"DataActionContactColumnFieldMapping":{"type":"object","required":["contactColumnName","dataActionField"],"properties":{"contactColumnName":{"type":"string","description":"The name of a contact column whose data will be passed to the data action"},"dataActionField":{"type":"string","description":"The name of an input field from the data action that the contact column data will be passed to"}}},"DigitalAction":{"type":"object","properties":{"updateContactColumnActionSettings":{"description":"The settings for an 'update contact column' action.","$ref":"#/definitions/UpdateContactColumnActionSettings"},"doNotSendActionSettings":{"description":"The settings for a 'do not send' action.","$ref":"#/definitions/DoNotSendActionSettings"},"appendToDncActionSettings":{"description":"The settings for an 'Append to DNC' action.","$ref":"#/definitions/AppendToDncActionSettings"},"markContactUncontactableActionSettings":{"description":"The settings for a 'mark contact uncontactable' action.","$ref":"#/definitions/MarkContactUncontactableActionSettings"},"markContactAddressUncontactableActionSettings":{"description":"The settings for an 'mark contact address uncontactable' action.","$ref":"#/definitions/MarkContactAddressUncontactableActionSettings"},"setContentTemplateActionSettings":{"description":"The settings for a 'Set content template' action.","$ref":"#/definitions/SetContentTemplateActionSettings"},"setSmsPhoneNumberActionSettings":{"description":"The settings for a 'set sms phone number' action.","$ref":"#/definitions/SetSmsPhoneNumberActionSettings"}}},"DigitalCondition":{"type":"object","properties":{"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this condition. Default is false."},"contactColumnConditionSettings":{"description":"The settings for a 'contact list column' condition.","$ref":"#/definitions/ContactColumnConditionSettings"},"contactAddressConditionSettings":{"description":"The settings for a 'contact address' condition.","$ref":"#/definitions/ContactAddressConditionSettings"},"contactAddressTypeConditionSettings":{"description":"The settings for a 'contact address type' condition.","$ref":"#/definitions/ContactAddressTypeConditionSettings"},"lastAttemptByColumnConditionSettings":{"description":"The settings for a 'last attempt by column' condition.","$ref":"#/definitions/LastAttemptByColumnConditionSettings"},"lastAttemptOverallConditionSettings":{"description":"The settings for a 'last attempt overall' condition.","$ref":"#/definitions/LastAttemptOverallConditionSettings"},"lastResultByColumnConditionSettings":{"description":"The settings for a 'last result by column' condition.","$ref":"#/definitions/LastResultByColumnConditionSettings"},"lastResultOverallConditionSettings":{"description":"The settings for a 'last result overall' condition.","$ref":"#/definitions/LastResultOverallConditionSettings"},"dataActionConditionSettings":{"description":"The settings for a 'data action' condition.","$ref":"#/definitions/DataActionConditionSettings"}}},"DigitalDataActionConditionPredicate":{"type":"object","required":["comparisonValue","inverted","outputField","outputFieldMissingResolution","outputOperator"],"properties":{"outputField":{"type":"string","description":"The name of an output field from the data action's output to use for this condition"},"outputOperator":{"type":"string","description":"The operation with which to evaluate this condition","enum":["Equals","LessThan","LessThanEquals","GreaterThan","GreaterThanEquals","Contains","BeginsWith","EndsWith","Before","After"]},"comparisonValue":{"type":"string","description":"The value to compare against for this condition"},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Predicate. Default is false."},"outputFieldMissingResolution":{"type":"boolean","description":"The result of this predicate if the requested output field is missing from the data action's result"}}},"DigitalRule":{"type":"object","required":["actions","category","conditions","name","order"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["PreContact","PostContact"]},"conditions":{"type":"array","description":"A list of conditions to evaluate. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/DigitalCondition"}},"actions":{"type":"array","description":"The list of actions to be taken if all conditions are true.","items":{"$ref":"#/definitions/DigitalAction"}}}},"DigitalRuleSet":{"type":"object","required":["rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DigitalRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DoNotSendActionSettings":{"type":"object"},"LastAttemptByColumnConditionSettings":{"type":"object","required":["operator","value"],"properties":{"emailColumnName":{"type":"string","description":"The name of the contact column to evaluate for Email."},"smsColumnName":{"type":"string","description":"The name of the contact column to evaluate for SMS."},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Before","After"]},"value":{"type":"string","example":"P1DT1H1M","description":"The period value to compare against the contact's data."}}},"LastAttemptOverallConditionSettings":{"type":"object","required":["mediaTypes","operator","value"],"properties":{"mediaTypes":{"type":"array","description":"A list of media types to evaluate.","items":{"type":"string","enum":["Voice","Email","Sms"]}},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Before","After"]},"value":{"type":"string","example":"P1DT1H1M","description":"The period value to compare against the contact's data."}}},"LastResultByColumnConditionSettings":{"type":"object","properties":{"emailColumnName":{"type":"string","description":"The name of the contact column to evaluate for Email."},"emailWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for Email.","items":{"type":"string"}},"smsColumnName":{"type":"string","description":"The name of the contact column to evaluate for SMS."},"smsWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for SMS.","items":{"type":"string"}}}},"LastResultOverallConditionSettings":{"type":"object","properties":{"emailWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for Email.","items":{"type":"string"}},"smsWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for SMS.","items":{"type":"string"}}}},"MarkContactAddressUncontactableActionSettings":{"type":"object"},"MarkContactUncontactableActionSettings":{"type":"object","required":["mediaTypes"],"properties":{"mediaTypes":{"type":"array","description":"A list of media types to evaluate.","items":{"type":"string","enum":["Voice","Email","Sms"]}}}},"SetContentTemplateActionSettings":{"type":"object","required":["emailContentTemplateId","smsContentTemplateId"],"properties":{"smsContentTemplateId":{"type":"string","description":"A string of sms contentTemplateId."},"emailContentTemplateId":{"type":"string","description":"A string of email contentTemplateId."}}},"SetSmsPhoneNumberActionSettings":{"type":"object","required":["senderSmsPhoneNumber"],"properties":{"senderSmsPhoneNumber":{"type":"string","description":"The string address for the sms phone number."}}},"UpdateContactColumnActionSettings":{"type":"object","required":["properties","updateOption"],"properties":{"properties":{"type":"object","example":"{\"phoneNumber\":\"+11234567890\"}, {\"lastContactedTime\":\"\"","description":"A mapping of contact columns to their new values.","additionalProperties":{"type":"string"}},"updateOption":{"type":"string","description":"The type of update to make to the specified contact column(s).","enum":["Set","Increment","Decrement","CurrentTime"]}}},"DigitalRuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DigitalRuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailConfig":{"type":"object","required":["emailColumns","fromAddress"],"properties":{"emailColumns":{"type":"array","description":"The contact list columns specifying the email address(es) of the contact.","items":{"type":"string"}},"contentTemplate":{"description":"The content template used to formulate the email to send to the contact.","$ref":"#/definitions/DomainEntityRef"},"fromAddress":{"description":"The email address that will be used as the sender of the email.","$ref":"#/definitions/FromEmailAddress"},"replyToAddress":{"description":"The email address from which any reply will be sent.","$ref":"#/definitions/ReplyToEmailAddress"}}},"FromEmailAddress":{"type":"object","required":["domain"],"properties":{"domain":{"description":"The OutboundDomain used for the email address.","$ref":"#/definitions/DomainEntityRef"},"friendlyName":{"type":"string","description":"The friendly name of the email address."},"localPart":{"type":"string","description":"The local part of the email address."}}},"MessagingCampaign":{"type":"object","required":["contactList","messagesPerMinute"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.","enum":["on","stopping","off","complete","invalid","forced_off"]},"callableTimeSet":{"description":"The callable time set for this messaging campaign.","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"The contact list that this messaging campaign will send messages for.","$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"The dnc lists to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"alwaysRunning":{"type":"boolean","description":"Whether this messaging campaign is always running"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"messagesPerMinute":{"type":"integer","format":"int32","description":"How many messages this messaging campaign will send per minute."},"ruleSets":{"type":"array","description":"Rule Sets to be applied while this campaign is sending messages","items":{"$ref":"#/definitions/DomainEntityRef"}},"contactListFilters":{"type":"array","description":"The contact list filter to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"errors":{"type":"array","description":"A list of current error conditions associated with this messaging campaign.","items":{"$ref":"#/definitions/RestErrorDetail"}},"dynamicContactQueueingSettings":{"description":"Indicates (when true) that the campaign supports dynamic queueing of the contact list at the time of a request for contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"emailConfig":{"description":"Configuration for this messaging campaign to send Email messages.","$ref":"#/definitions/EmailConfig"},"smsConfig":{"description":"Configuration for this messaging campaign to send SMS messages.","$ref":"#/definitions/SmsConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplyToEmailAddress":{"type":"object","required":["domain","route"],"properties":{"domain":{"description":"The InboundDomain used for the email address.","$ref":"#/definitions/DomainEntityRef"},"route":{"description":"The InboundRoute used for the email address.","$ref":"#/definitions/DomainEntityRef"}}},"SmsConfig":{"type":"object","required":["messageColumn","phoneColumn","senderSmsPhoneNumber"],"properties":{"messageColumn":{"type":"string","description":"The Contact List column specifying the message to send to the contact."},"phoneColumn":{"type":"string","description":"The Contact List column specifying the phone number to send a message to."},"senderSmsPhoneNumber":{"description":"A reference to the SMS Phone Number that will be used as the sender of a message.","$ref":"#/definitions/SmsPhoneNumberRef"},"contentTemplate":{"description":"The content template used to formulate the message to send to the contact.","$ref":"#/definitions/DomainEntityRef"}}},"SmsPhoneNumberRef":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"selfUri":{"type":"string","format":"uri"}}},"MessagingCampaignDiagnostics":{"type":"object","properties":{"timeZoneRescheduledContactsCount":{"type":"integer","format":"int32","description":"Current number of time zone rescheduled messages on the campaign","readOnly":true}}},"MessagingCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailCampaignSchedule":{"type":"object","required":["emailCampaign","intervals"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this email campaign schedule."},"emailCampaign":{"description":"The Campaign that this email campaign schedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailCampaignScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailCampaignSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingCampaignSchedule":{"type":"object","required":["intervals","messagingCampaign"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this messaging campaign schedule."},"messagingCampaign":{"description":"The Campaign that this messaging campaign schedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"UserDevice":{"type":"object","required":["acceptNotifications","deviceToken","make","model","notificationId","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"deviceToken":{"type":"string","description":"device token sent by mobile clients."},"notificationId":{"type":"string","description":"notification id of the device."},"make":{"type":"string","description":"make of the device."},"model":{"type":"string","description":"Device model"},"acceptNotifications":{"type":"boolean","description":"if the device accepts notifications"},"type":{"type":"string","description":"type of the device; ios or android","enum":["android","ios"]},"sessionHash":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DirectoryUserDevicesListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserDevice"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FieldConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entityType":{"type":"string","enum":["person","group","org","externalContact"]},"state":{"type":"string"},"sections":{"type":"array","items":{"$ref":"#/definitions/Section"}},"version":{"type":"string"},"schemaVersion":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupMembersUpdate":{"type":"object","required":["memberIds","version"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add.","items":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The current group version."}}},"GroupProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GroupProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupUpdate":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"state":{"type":"string","description":"State of the group.","enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","ownerIds","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupCreate":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Group"}}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["description","id","name","state"]}}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"LanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationUpdateDefinition":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"LocationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationCreateDefinition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"LocationsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/LocationDefinition"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["id","name","notes","addressFields.city","addressFields.country","addressFields.state","addressFields.street1","addressFields.street2","addressFields.zipcode","addressVerified","emergencyNumber"]}}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"OrganizationFeatures":{"type":"object","properties":{"realtimeCIC":{"type":"boolean"},"purecloud":{"type":"boolean"},"hipaa":{"type":"boolean"},"ucEnabled":{"type":"boolean"},"pci":{"type":"boolean"},"purecloudVoice":{"type":"boolean"},"xmppFederation":{"type":"boolean"},"chat":{"type":"boolean"},"informalPhotos":{"type":"boolean"},"directory":{"type":"boolean"},"contactCenter":{"type":"boolean"},"unifiedCommunications":{"type":"boolean"},"custserv":{"type":"boolean"}}},"FeatureState":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Adjacents":{"type":"object","properties":{"superiors":{"type":"array","items":{"$ref":"#/definitions/User"}},"siblings":{"type":"array","items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"AvailableTranslations":{"type":"object","properties":{"orgSpecific":{"type":"array","items":{"type":"string"}},"builtin":{"type":"array","items":{"type":"string"}}}},"UserExpands":{"type":"object","properties":{"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Active 3rd party presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"}}},"UserProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"expands":{"description":"User information expansions","readOnly":true,"$ref":"#/definitions/UserExpands"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExternalMetricDataProcessedItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]},"totalValue":{"type":"number","description":"The total value of the metric data."},"totalCount":{"type":"integer","format":"int32","description":"The total number of data points."}}},"ExternalMetricDataUnprocessedItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]},"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"}}},"ExternalMetricDataWriteResponse":{"type":"object","properties":{"processedEntities":{"type":"array","description":"The list of processed entities","items":{"$ref":"#/definitions/ExternalMetricDataProcessedItem"}},"unprocessedEntities":{"type":"array","description":"The list of unprocessed entities","items":{"$ref":"#/definitions/ExternalMetricDataUnprocessedItem"}}},"description":"External metric data write response"},"ExternalMetricDataItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]}}},"ExternalMetricDataWriteRequest":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"A list of external metric data items. A maximum of 100 items are allowed.","items":{"$ref":"#/definitions/ExternalMetricDataItem"}}}},"ExternalMetricDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the External Metric Definition"},"unit":{"type":"string","description":"The unit of the External Metric Definition","enum":["Seconds","Percent","Number","Currency"]},"unitDefinition":{"type":"string","description":"The unit definition of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition"},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"retentionMonths":{"type":"integer","format":"int32","description":"The retention in months of the External Metric Definition"},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"},"inUse":{"type":"boolean","description":"True if the External Metric Definition is in use","readOnly":true},"dateLastRefreshed":{"type":"string","format":"date-time","description":"The last date and time that the metric data was refreshed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalMetricDefinitionCreateRequest":{"type":"object","required":["defaultObjectiveType","enabled","name","precision","unit"],"properties":{"name":{"type":"string","description":"The name of the External Metric Definition"},"unit":{"type":"string","description":"The unit of the External Metric Definition","enum":["Seconds","Percent","Number","Currency"]},"unitDefinition":{"type":"string","description":"The unit definition of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition. Must be at least 0 and at most 5","minimum":0,"maximum":5},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"}}},"ExternalMetricDefinitionUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition. Must be at least 0 and at most 5","minimum":0,"maximum":5},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"}}},"ExternalMetricDefinitionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalMetricDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExecutionDataEntity":{"type":"object","properties":{"id":{"type":"string","description":"The id of the execution requested"},"downloadUri":{"type":"string","description":"A downloadable link to the execution data file."},"failed":{"type":"boolean","description":"If the retrieval failed (not found, no permission, etc;), this will be set true."},"statusCode":{"type":"string","description":"This will contain the http status code for the failure"}},"description":"Represents an individual result of an execution data lookup"},"ExecutionDataRequest":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"A list of ids to retrieve","items":{"type":"string"}}},"description":"Used to retrieve a set of executionData history by the respective ids"},"CriteriaCategoryInfo":{"type":"object","properties":{"categoryId":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"}}},"QueryCriteria":{"type":"object","properties":{"criteriaKey":{"type":"string","description":"The is the name of the criteria that can be queried.","enum":["FlowStartDateTime","FlowEndDateTime","ConversationId","FlowType","FlowId","FlowErrorReason","FlowWarningReason","FlowAlternateExecutionId","FlowObjectExecutionId","FlowActionId","FlowActionType","FlowActionOutputPathId","FlowActionOutputPathName","FlowActionIdOutputPathId","FlowActionIdOutputPathName","FlowActionTypeOutputPathId","FlowActionTypeOutputPathName","BotId","BotErrorReason","BotFlowExecutionId","BotObjectExecutionId"]},"criteriaGroups":{"type":"array","description":"The executionData type that this criteria item can be used on.","items":{"type":"string","enum":["flow","bot"]}},"description":{"type":"string","description":"The is the description of the criteria."},"operators":{"type":"array","description":"A list of operators that can be used on this criteria.","items":{"type":"string"}},"dataType":{"type":"string","description":"The type of data for the criteria (string, int, etc).","enum":["string","guid","dateTime"]},"categoryInfo":{"description":"A logical grouping and display order for this item.","$ref":"#/definitions/CriteriaCategoryInfo"}},"description":"A criteria type that can be used in tandem with other criteria type to create queries of executionData"},"CriteriaGroup":{"type":"object","properties":{"and":{"type":"array","description":"These criteriaItems will be AND'd together to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"or":{"type":"array","description":"These criteriaItems will be OR'd together to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"not":{"type":"array","description":"These criteriaItems must all be false to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"criteria":{"description":"A singular critieriaItem to match.","$ref":"#/definitions/CriteriaItem"}},"description":"A group of logical or a singular criteria used to create a query of executionData"},"CriteriaItem":{"type":"object","properties":{"key":{"type":"string","description":"The id of the criteria to be checked.","enum":["FlowStartDateTime","FlowEndDateTime","ConversationId","FlowType","FlowId","FlowErrorReason","FlowWarningReason","FlowAlternateExecutionId","FlowObjectExecutionId","FlowActionId","FlowActionType","FlowActionOutputPathId","FlowActionOutputPathName","FlowActionIdOutputPathId","FlowActionIdOutputPathName","FlowActionTypeOutputPathId","FlowActionTypeOutputPathName","BotId","BotErrorReason","BotFlowExecutionId","BotObjectExecutionId"]},"operator":{"type":"string","description":"The operator used to check on the criteria id.","enum":["eq","gt","gte","lt","lte","not","begins","not_null"]},"value":{"type":"string","description":"The target value used to query on."}},"description":"A singular criteria used to query executionData."},"CriteriaQuery":{"type":"object","required":["query"],"properties":{"query":{"type":"array","description":"A list of CriteriaGroups which will be AND'd together to generate a result set.","items":{"$ref":"#/definitions/CriteriaGroup"}}},"description":"Used to retrieve executionData based upon certain criteria"},"GetFlowExecutionDataJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entities":{"type":"array","description":"On jobState = Success this field will be populated with the list of results of files for download.","items":{"$ref":"#/definitions/ExecutionDataEntity"}},"jobState":{"type":"string","description":"The state of the backend process to prep the files for download.","enum":["Registered","Running","Success","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is a list of executionData links that can be used to download the complete executionData"},"FlowsQueryCriteriaResponse":{"type":"object","properties":{"criteria":{"type":"array","description":"The is a list of allowed criteria to query on.","items":{"$ref":"#/definitions/QueryCriteria"}},"flowTypes":{"type":"array","description":"The is a list of flow types the organization has access to.","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]}},"actionTypes":{"type":"array","description":"The is a list of action types the organization has access to.","items":{"type":"string","enum":["actionAbortSurveyInvite","actionAddFlowMilestone","actionAskForBoolean","actionAskForNLUIntent","actionAskForNLUNextIntent","actionAskForSlot","actionCallBotConnector","actionCallBotFlow","actionCallCommonModule","actionCallData","actionCallDataSecure","actionCallDialogEngineBot","actionCallDialogflowBot","actionCallDialogflowCxBot","actionCallDigitalBotFlow","actionCallLexBot","actionCallLexV2Bot","actionCallNuanceMixBot","actionCallTask","actionChangeState","actionClearSlot","actionClearVoicemailSnippet","actionCollectInput","actionCommunicate","actionCompleteSurveyInvite","actionCreateCallback","actionDataTableLookup","actionDecision","actionDecryptData","actionDetectSilence","actionDialExtension","actionDialName","actionDigitalMenu","actionDisconnect","actionEnableParticipantRecord","actionEncryptData","actionEndState","actionEndTask","actionEndWorkflow","actionEvaluateSchedule","actionEvaluateScheduleGroup","actionExitBotFlow","actionExitLoop","actionExtractSecureData","actionFindEmergencyGroup","actionFindGroup","actionFindLanguageSkill","actionFindQueue","actionFindQueueById","actionFindSchedule","actionFindScheduleGroup","actionFindSkill","actionFindSystemPrompt","actionFindUser","actionFindUserById","actionFindUserPrompt","actionFindUsersById","actionFlushAudio","actionGetConversationData","actionGetExternalContact","actionGetExternalOrganization","actionGetJourneyOutcome","actionGetJourneyOutcomeScoresBySession","actionGetJourneySegment","actionGetJourneySession","actionGetJourneySessionsByCustomer","actionGetJourneySessionsByExternalContact","actionGetParticipantData","actionGetResponse","actionGetSecuredData","actionHoldMusic","actionInitializeFlowOutcome","actionJumpToMenu","actionJumpToTask","actionLoop","actionLoopUntil","actionNextLoop","actionPlayAudio","actionPlayAudioOnSilence","actionPlayEstimatedWaitTime","actionPlayPositionInQueue","actionPlayUserGreeting","actionPlayUserName","actionPreviousMenu","actionProcessVoicemailInput","actionRepeatMenu","actionReturnToAgent","actionSaveWorkitem","actionScreenPop","actionSearchExternalContacts","actionSendAutoReply","actionSendResponse","actionSetActiveIntent","actionSetConversationData","actionSetExternalTag","actionSetFlowOutcome","actionSetLocale","actionSetParticipantData","actionSetPriority","actionSetSecuredData","actionSetSkills","actionSetUUIData","actionSetWhisperAudio","actionSetWrapupCode","actionShowKnowledgeArticle","actionSubmitVoicemailSnippet","actionSwitch","actionTranscription","actionTransferExternal","actionTransferFlow","actionTransferFlowSecure","actionTransferGroup","actionTransferToAcd","actionTransferUser","actionTransferVoicemail","actionUpdateData","actionWait","actionWaitForInput","menuDialExtension","menuDialName","menuDisconnect","menuJumpToMenu","menuJumpToTask","menuMenu","menuPreviousMenu","menuRepeatMenu","menuShowKnowledgeArticle","menuTask","menuTransferToAcd","menuTransferFlow","menuTransferGroup","menuTransferExternal","menuTransferFlowSecure","menuTransferUser","menuTransferVoicemail"]}},"errorCodes":{"type":"array","description":"The is a list of potential error codes the organization may encounter.","items":{"type":"string"}},"warningCodes":{"type":"array","description":"The is a list of potential warning codes the organization may encounter.","items":{"type":"string"}}},"description":"The response for QueryCapabilities which contains the allowed criteria, flow types and action types for the organization."},"FlowExecutionDataQueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDateTime":{"type":"string","format":"date-time","description":"The start time for the execution of this flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDateTime":{"type":"string","format":"date-time","description":"The end time for the execution of this flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"flowId":{"type":"string","description":"The id of the flow that was executed."},"flowVersion":{"type":"string","description":"The version of the flow that was executed."},"conversationId":{"type":"string","description":"The id of the conversation that executed this flow."},"flowType":{"type":"string","description":"The type of flow.","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"flowErrorReason":{"type":"string","description":"If the flow errored out this is the reason."},"flowName":{"type":"string","description":"The name of the flow."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is the metadata of an executionData entry for a flow."},"FlowResultEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionDataQueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxConfig":{"type":"object","required":["disableEmailPii","sendEmailNotifications"],"properties":{"sendEmailNotifications":{"type":"boolean","description":"Whether to enable email notifications for this organization"},"disableEmailPii":{"type":"boolean","description":"Whether to disable PII for email notifications"}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"sharingUri":{"type":"string","format":"uri"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean"},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxDocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"GamificationStatus":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Gamification status of the organization."},"dateStart":{"type":"string","format":"date","description":"Gamification start date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"automaticUserAssignment":{"type":"boolean","description":"Automatic assignment of users to the default profile"},"dateStartPersonalBest":{"type":"string","format":"date","description":"Personal best aggregation starting date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"Leaderboard":{"type":"object","properties":{"division":{"description":"The targeted division for this leaderboard","readOnly":true,"$ref":"#/definitions/Division"},"metric":{"description":"The metric id if the leaderboard is about a specific metric","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"leaders":{"type":"array","description":"The list of leaders generated.","readOnly":true,"items":{"$ref":"#/definitions/LeaderboardItem"}},"userRank":{"description":"The requesting user's rank","readOnly":true,"$ref":"#/definitions/LeaderboardItem"},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LeaderboardItem":{"type":"object","properties":{"user":{"description":"The user object for this leaderboard rank","readOnly":true,"$ref":"#/definitions/UserReference"},"rank":{"type":"integer","format":"int32","description":"The rank of the user","readOnly":true},"points":{"type":"integer","format":"int64","description":"The points collected by the user","readOnly":true}}},"OverallBestPoints":{"type":"object","properties":{"division":{"description":"The requested division","readOnly":true,"$ref":"#/definitions/Division"},"bestPoints":{"type":"array","description":"List of gamification best point items","readOnly":true,"items":{"$ref":"#/definitions/OverallBestPointsItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"OverallBestPointsItem":{"type":"object","properties":{"granularityType":{"type":"string","description":"Best points aggregation interval granularity","readOnly":true,"enum":["Daily","Weekly","Monthly"]},"users":{"type":"array","description":"List of associated users with the equal points.","readOnly":true,"items":{"$ref":"#/definitions/UserReference"}},"count":{"type":"integer","format":"int32","description":"The count of the user IDs in the list","readOnly":true},"points":{"type":"integer","format":"int32","description":"Gamification points","readOnly":true},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true}}},"DefaultObjective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queues":{"type":"array","description":"A list of queues for the metric","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topics":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]}}},"MetricDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"unitType":{"type":"string","description":"The type of associated metric unit","enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"shortName":{"type":"string","description":"An alternate name for this metric definition, often abbreviation"},"dividendMetrics":{"type":"array","description":"Metric names used as dividend","items":{"type":"string"}},"divisorMetrics":{"type":"array","description":"Metric names used as divisor","items":{"type":"string"}},"defaultObjective":{"description":"A predefined default objective for this metric","$ref":"#/definitions/DefaultObjective"},"lockTemplateId":{"type":"string","description":"An optional field to specify if this metric definition is locked to certain template. e.g. punctuality"},"mediaTypeFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on media types"},"initialDirectionFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on initial direction"},"queueFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on queues"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ObjectiveZone":{"type":"object","required":["directionType","label","lowerLimitPoints","upperLimitPoints","zoneType"],"properties":{"label":{"type":"string","description":"label"},"directionType":{"type":"string","description":"direction type","enum":["Up","Down","Flat"]},"zoneType":{"type":"string","description":"zone type","enum":["Good","Target","Great","Out"]},"upperLimitPoints":{"type":"integer","format":"int32","description":"upper limit points"},"lowerLimitPoints":{"type":"integer","format":"int32","description":"lower limit points"},"upperLimitValue":{"type":"integer","format":"int32","description":"upper limit value"},"lowerLimitValue":{"type":"integer","format":"int32","description":"lower limit value"}}},"GetMetricDefinitionsResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/MetricDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"ObjectiveTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"zones":{"type":"array","items":{"$ref":"#/definitions/ObjectiveZone"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetTemplatesResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ObjectiveTemplate"}},"selfUri":{"type":"string","format":"uri"}}},"ProfileWithDateRange":{"type":"object","properties":{"id":{"type":"string","description":"Profile ID"},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserProfilesInDateRange":{"type":"object","properties":{"user":{"description":"The query agent","$ref":"#/definitions/UserReference"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"profiles":{"type":"array","description":"The list of profiles of the agent","items":{"$ref":"#/definitions/ProfileWithDateRange"}}}},"UserProfilesInDateRangeRequest":{"type":"object","required":["endWorkday","startWorkday"],"properties":{"startWorkday":{"type":"string","example":"2022-11-07","description":"Start work day in ISO-8601 format used in the date range."},"endWorkday":{"type":"string","example":"2022-11-11","description":"End work day in ISO-8601 format used in the date range."}}},"PerformanceProfile":{"type":"object","required":["description","metricOrders","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"A name for this performance profile"},"division":{"description":"The division for this performance profile associate to","readOnly":true,"$ref":"#/definitions/Division"},"description":{"type":"string","description":"A description about this performance profile"},"metricOrders":{"type":"array","description":"Order of the associated metrics. The list should contain valid ids for metrics","items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"reportingIntervals":{"type":"array","description":"The reporting interval periods for this performance profile","items":{"$ref":"#/definitions/ReportingInterval"}},"active":{"type":"boolean","description":"The flag for active profiles","readOnly":true},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this performance profile","readOnly":true},"maxLeaderboardRankSize":{"type":"integer","format":"int32","description":"The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportingInterval":{"type":"object","required":["intervalType","intervalValue"],"properties":{"intervalType":{"type":"string","description":"The granularity of the reporting interval period","enum":["Day","Week","Month"]},"intervalValue":{"type":"integer","format":"int32","description":"The value of the reporting interval period for a given interval type"}}},"GetProfilesResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PerformanceProfile"}},"selfUri":{"type":"string","format":"uri"}}},"CreatePerformanceProfile":{"type":"object","required":["active","description","division","maxLeaderboardRankSize","name","reportingIntervals"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"A name for this performance profile"},"division":{"description":"The associated division for this Performance Profile","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"A description about this performance profile"},"metricOrders":{"type":"array","description":"Order of the associated metrics. The list should contain valid ids for metrics","readOnly":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"reportingIntervals":{"type":"array","description":"The reporting interval periods for this performance profile","items":{"$ref":"#/definitions/ReportingInterval"}},"active":{"type":"boolean","description":"The flag for active profiles"},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this performance profile","readOnly":true},"maxLeaderboardRankSize":{"type":"integer","format":"int32","description":"The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Metric":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this metric"},"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"objective":{"description":"Associated objective for this metric","$ref":"#/definitions/Objective"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"linkedMetric":{"description":"The linked metric entity reference","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of this metric. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateUnlinked":{"type":"string","format":"date","description":"The unlinked workday for this metric if this metric was ever unlinked. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"precision":{"type":"integer","format":"int32","description":"The precision of the metric, must be between 0 and 5","readOnly":true},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]},"sourcePerformanceProfile":{"description":"The source performance profile when this metric is linked","readOnly":true,"$ref":"#/definitions/PerformanceProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Objective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queues":{"type":"array","description":"A list of queues for the metric","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topics":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]},"dateStart":{"type":"string","format":"date","description":"start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"TargetPerformanceProfile":{"type":"object","required":["targetPerformanceProfileId"],"properties":{"targetPerformanceProfileId":{"type":"string","description":"The target destination performanceProfileId for the linked metric."}}},"CreateMetric":{"type":"object","required":["name"],"properties":{"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"objective":{"description":"Associated objective for this metric","$ref":"#/definitions/CreateObjective"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"name":{"type":"string","description":"The name of this metric"},"precision":{"type":"integer","format":"int32","description":"The precision of the metric, must be between 0 and 5"},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]}}},"CreateObjective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"topicIds":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"type":"string"}},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queueIds":{"type":"array","description":"A list of queue ids for the metric","items":{"type":"string"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]},"dateStart":{"type":"string","format":"date","description":"start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"GetMetricsResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metrics"}},"selfUri":{"type":"string","format":"uri"}}},"Metrics":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"order":{"type":"integer","format":"int32","description":"The order of metric within a performance profile"},"metricDefinitionName":{"type":"string","description":"The name of associated metric definition"},"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"unitType":{"type":"string","description":"Corresponding unit type for this metric","enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"enabled":{"type":"boolean","description":"A flag for whether this metric is enabled for a performance profile"},"templateName":{"type":"string","description":"The name of associated objective template"},"maxPoints":{"type":"integer","format":"int32","description":"Achievable maximum points for this metric"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"linkedMetric":{"description":"The linked metric entity reference","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of this metric. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateUnlinked":{"type":"string","format":"date","description":"The unlinked workday for this metric if this metric was ever unlinked. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"sourcePerformanceProfile":{"description":"The source performance profile when this metric is linked","readOnly":true,"$ref":"#/definitions/PerformanceProfile"},"unitDefinition":{"type":"string","description":"Unit definition of linked external metric","readOnly":true},"precision":{"type":"integer","format":"int32","description":"Precision of linked external metric","readOnly":true},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetMetricResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metric"}},"selfUri":{"type":"string","format":"uri"}}},"DivisionReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InsightsDetails":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"user":{"description":"The query user","$ref":"#/definitions/UserReference"},"metricData":{"type":"array","description":"The list of insights data for each metric of the user","items":{"$ref":"#/definitions/InsightsDetailsMetricItem"}},"overallData":{"description":"Overall insights data of the user","$ref":"#/definitions/InsightsDetailsOverallItem"}}},"InsightsDetailsMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the data","$ref":"#/definitions/AddressableEntityRef"},"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsDetailsMetricPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsDetailsMetricPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"},"valueChange":{"type":"number","format":"double","description":"Value change"}}},"InsightsDetailsMetricPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"rankTotalPoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for points on this metric"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for percentage on this metric"},"value":{"type":"number","format":"double","description":"Average value"}}},"InsightsDetailsOverallItem":{"type":"object","properties":{"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsDetailsOverallPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsDetailsOverallPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"}}},"InsightsDetailsOverallPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"rankTotalPoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for points on this metric"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for percentage on this metric"}}},"WorkdayPeriod":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"InsightsAgentItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"manager":{"description":"This user's manager.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InsightsAgents":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"entities":{"type":"array","description":"The list of insights agents","items":{"$ref":"#/definitions/InsightsAgentItem"}}}},"InsightsTrend":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"entities":{"type":"array","description":"The list of insights trend for each metric","items":{"$ref":"#/definitions/InsightsTrendMetricItem"}},"total":{"description":"The insights trend in total","$ref":"#/definitions/InsightsTrendTotalItem"}}},"InsightsTrendMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the trend","$ref":"#/definitions/AddressableEntityRef"},"trends":{"description":"Trends for the metric","$ref":"#/definitions/InsightsTrends"}}},"InsightsTrendTotalItem":{"type":"object","properties":{"trends":{"description":"Trends for the metric","$ref":"#/definitions/InsightsTrends"}}},"InsightsTrends":{"type":"object","properties":{"comparativePeriod":{"type":"array","description":"List of trend data in the comparative period","items":{"$ref":"#/definitions/TrendData"}},"primaryPeriod":{"type":"array","description":"List of trend data in the primary period","items":{"$ref":"#/definitions/TrendData"}}}},"TrendData":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"percentOfGoal":{"type":"number","format":"double","description":"Percent of goal"},"averageValue":{"type":"number","format":"double","description":"Average metric value"}}},"InsightsSummaryMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the data","$ref":"#/definitions/AddressableEntityRef"},"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsSummaryMetricPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsSummaryMetricPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"},"valueChange":{"type":"number","format":"double","description":"Value change"}}},"InsightsSummaryMetricPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"value":{"type":"number","format":"double","description":"Average value"}}},"InsightsSummaryOverallItem":{"type":"object","properties":{"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsSummaryOverallPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsSummaryOverallPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"}}},"InsightsSummaryOverallPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"}}},"InsightsSummaryUserItem":{"type":"object","properties":{"user":{"description":"Queried user","$ref":"#/definitions/UserReference"},"metricData":{"type":"array","description":"The list of insights data for each metric of the user","items":{"$ref":"#/definitions/InsightsSummaryMetricItem"}},"overallData":{"description":"Overall insights data of the user","$ref":"#/definitions/InsightsSummaryOverallItem"},"ranking":{"type":"integer","format":"int32","description":"Ranking of the user"}}},"InsightsSummary":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InsightsSummaryUserItem"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"pageCount":{"type":"integer","format":"int32"}}},"UserInsightsTrend":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"user":{"description":"The query user","$ref":"#/definitions/UserReference"},"entities":{"type":"array","description":"The list of insights trend for each metric","items":{"$ref":"#/definitions/UserInsightsTrendMetricItem"}},"total":{"description":"The insights trend in total","$ref":"#/definitions/UserInsightsTrendTotalItem"}}},"UserInsightsTrendMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the trend","$ref":"#/definitions/AddressableEntityRef"},"trends":{"description":"Trends for the metric","$ref":"#/definitions/UserInsightsTrends"}}},"UserInsightsTrendTotalItem":{"type":"object","properties":{"trends":{"description":"Trends for the metric","$ref":"#/definitions/UserInsightsTrends"}}},"UserInsightsTrends":{"type":"object","properties":{"comparativePeriod":{"type":"array","description":"List of trend data in the comparative period","items":{"$ref":"#/definitions/UserTrendData"}},"primaryPeriod":{"type":"array","description":"List of trend data in the primary period","items":{"$ref":"#/definitions/UserTrendData"}}}},"UserTrendData":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"percentOfGoal":{"type":"number","format":"double","description":"Percent of goal"},"averageValue":{"type":"number","format":"double","description":"Average metric value"},"rankTotalPoints":{"type":"integer","format":"int32","description":"Rank, ordered by total points"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"Rank, ordered by percentage of points"}}},"Member":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The user's id"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"The associated user reference as a member of a performance profile"},"MemberListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Member"}}}},"AssignmentValidation":{"type":"object","properties":{"membersNotAssigned":{"type":"array","description":"The list of users that are not assigned to any custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"membersAlreadyAssigned":{"type":"array","description":"The list of users that are already assigned to the requesting custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"membersAlreadyAssignedToOther":{"type":"array","description":"The list of users that are already assigned to other custom performance profiles","items":{"$ref":"#/definitions/OtherProfileAssignment"}},"invalidMemberAssignments":{"type":"array","description":"The list of user id that are invalid for the gamfication service to handle","items":{"$ref":"#/definitions/InvalidAssignment"}}}},"InvalidAssignment":{"type":"object","properties":{"user":{"description":"Invalid user for validation","$ref":"#/definitions/UserReference"},"message":{"type":"string","description":"The reason for the invalid input for validation"}}},"OtherProfileAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"currentProfile":{"description":"The current performance profile that this user belongs to","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ValidateAssignUsers":{"type":"object","required":["membersToAssign"],"properties":{"membersToAssign":{"type":"array","description":"List of user ids to assign to a performance profile","items":{"type":"string"}}}},"Assignment":{"type":"object","properties":{"assignedMembers":{"type":"array","description":"The list of users successfully assigned to the custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"removedMembers":{"type":"array","description":"The list of users successfully removed from the custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"assignmentErrors":{"type":"array","description":"The list of users failed assignment or removal for the custom performance profile","items":{"$ref":"#/definitions/AssignmentError"}}}},"AssignmentError":{"type":"object","properties":{"user":{"description":"A user that is failed to be removed from the performance profile","$ref":"#/definitions/UserReference"},"message":{"type":"string","description":"Error message from membership assignment"}}},"AssignUsers":{"type":"object","required":["membersToAssign","membersToRemove"],"properties":{"membersToAssign":{"type":"array","description":"List of user ids to assign to a performance profile","items":{"type":"string"}},"membersToRemove":{"type":"array","description":"List of user ids to remove from a performance profile","items":{"type":"string"}}}},"MetricValueTrendAverage":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The targeted start workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The targeted end workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateReferenceWorkday":{"type":"string","format":"date","description":"The targeted reference workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the metrics","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the metrics","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"result":{"description":"The metric value trend and average","readOnly":true,"$ref":"#/definitions/WorkdayValuesMetricItem"},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metric":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"WorkdayValuesMetricItem":{"type":"object","properties":{"metric":{"description":"Gamification metric for the average and the trend","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metricDefinition":{"description":"Gamification metric definition for the average and the trend","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"average":{"type":"number","format":"double","description":"The average value of the metric","readOnly":true},"unitType":{"type":"string","description":"The unit type of the metric value","readOnly":true,"enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"trend":{"type":"array","description":"The metric value trend","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesTrendItem"}}}},"WorkdayValuesTrendItem":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"The workday for the metric value. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"value":{"type":"number","format":"double","description":"The metric value","readOnly":true}}},"UserBestPoints":{"type":"object","properties":{"user":{"description":"The requested user for the best points","readOnly":true,"$ref":"#/definitions/UserReference"},"bestPoints":{"type":"array","description":"List of best point for the requested user","readOnly":true,"items":{"$ref":"#/definitions/UserBestPointsItem"}}}},"UserBestPointsItem":{"type":"object","properties":{"granularityType":{"type":"string","description":"Best points aggregation interval granularity","readOnly":true,"enum":["Daily","Weekly","Monthly"]},"points":{"type":"integer","format":"int32","description":"Gamification points","readOnly":true},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"rank":{"type":"integer","format":"int32","description":"The rank of this user","readOnly":true}}},"PunctualityEvent":{"type":"object","properties":{"dateScheduleStart":{"type":"string","format":"date-time","description":"The scheduled activity start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The time the user started the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the activity in minutes","readOnly":true},"description":{"type":"string","description":"The description of the activity","readOnly":true},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity","readOnly":true},"activityCode":{"type":"string","description":"The activity code","readOnly":true},"activityName":{"type":"string","description":"The activity name","readOnly":true},"category":{"type":"string","description":"The category for the activity","readOnly":true},"points":{"type":"integer","format":"int32","description":"The points earned for this activity","readOnly":true},"delta":{"type":"number","format":"double","description":"Difference between this activity and the last activity in seconds","readOnly":true},"bullseye":{"type":"boolean"}}},"QualityEvaluationScoreItem":{"type":"object","properties":{"evaluationId":{"type":"string","description":"The id of evaluation","readOnly":true},"conversationId":{"type":"string","description":"The id of conversation","readOnly":true},"conversationDate":{"type":"string","format":"date-time","description":"The date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversationEndDate":{"type":"string","format":"date-time","description":"The end date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"formName":{"type":"string","description":"The name of form","readOnly":true},"points":{"type":"integer","format":"int32","description":"Gamification points earned for this metric","readOnly":true},"evaluationScore":{"type":"number","format":"double","description":"The quality score of evaluation as a percentage","readOnly":true},"maxPoints":{"type":"integer","format":"int32","description":"The maximum Gamification points a user may earn for this metric","readOnly":true},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}}}},"WorkdayMetric":{"type":"object","properties":{"metric":{"description":"Gamification metric","readOnly":true,"$ref":"#/definitions/Metric"},"objective":{"description":"Current objective for this metric","readOnly":true,"$ref":"#/definitions/Objective"},"points":{"type":"integer","format":"int32","description":"Gamification points earned for this metric","readOnly":true},"maxPoints":{"type":"integer","format":"int32","description":"The maximum Gamification points a user may earn for this metric","readOnly":true},"value":{"type":"number","format":"double","description":"Value of this metric","readOnly":true},"punctualityEvents":{"type":"array","description":"List of schedule activity events for punctuality metrics","readOnly":true,"items":{"$ref":"#/definitions/PunctualityEvent"}},"evaluationDetails":{"type":"array","description":"List of evaluations for quality evaluation score metrics","readOnly":true,"items":{"$ref":"#/definitions/QualityEvaluationScoreItem"}}}},"WorkdayMetricListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkdayMetric"}}}},"AttendanceStatus":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"the workday date of this attendance status. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"attendanceStatusType":{"type":"string","description":"the attendance status","readOnly":true,"enum":["HasData","Scheduled","Absent","Present","NoSchedule"]},"hasEvaluation":{"type":"string","description":"the quality evaluation score status","readOnly":true,"enum":["HasQualityEvaluation","NoQualityEvaluation"]}}},"AttendanceStatusListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttendanceStatus"}}}},"AllTimePoints":{"type":"object","properties":{"user":{"description":"Queried user","readOnly":true,"$ref":"#/definitions/UserReference"},"dateEndWorkday":{"type":"string","format":"date","description":"Queried end workday for all time points to be collected. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"allTimePoints":{"type":"integer","format":"int64","description":"All time point collected bt the user","readOnly":true}}},"SingleWorkdayAveragePoints":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"Queried target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the average points","readOnly":true,"$ref":"#/definitions/Division"},"averagePoints":{"type":"number","format":"double","description":"The average points per agent earned within the division","readOnly":true},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"WorkdayPointsTrend":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The start workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The end workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"user":{"description":"The targeted user for the query","readOnly":true,"$ref":"#/definitions/UserReference"},"dayOfWeek":{"type":"string","description":"Aggregated for same day comparison","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"averagePoints":{"type":"number","format":"double","description":"The total average points","readOnly":true},"trend":{"type":"array","description":"Daily points trends","readOnly":true,"items":{"$ref":"#/definitions/WorkdayPointsTrendItem"}}}},"WorkdayPointsTrendItem":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"workday date for the points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"points":{"type":"number","format":"double","description":"workday points for the date","readOnly":true}}},"WorkdayValuesTrend":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The start workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The end workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateReferenceWorkday":{"type":"string","format":"date","description":"The reference workday used to determine the metric definition. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the query","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the query","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"results":{"type":"array","description":"The metric value trends","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesMetricItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metric":{"description":"The targeted metric for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SingleWorkdayAverageValues":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"The targeted workday for average value query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the metrics","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the metrics","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"results":{"type":"array","description":"The metric value averages","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesMetricItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"DialerContactId":{"type":"object","properties":{"id":{"type":"string"},"contactListId":{"type":"string"}}},"GDPRJourneyCustomer":{"type":"object","properties":{"type":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined."},"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined."}}},"GDPRRequest":{"type":"object","required":["createdBy","createdDate","requestType","status","subject"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdBy":{"description":"The user that created this request","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"replacementTerms":{"type":"array","example":"[ { \"type\": \"EMAIL\": \"existingValue\": \"personal.email@domain.com\", \"updatedValue\": \"updated.personal.email@domain.com\" } ]","description":"The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request","items":{"$ref":"#/definitions/ReplacementTerm"}},"requestType":{"type":"string","description":"The type of GDPR request","enum":["GDPR_EXPORT","GDPR_UPDATE","GDPR_DELETE"]},"createdDate":{"type":"string","format":"date-time","description":"When the request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the request","readOnly":true,"enum":["INITIATED","SEARCHING","UPDATING","DELETING","COMPLETED","ERROR","FINALIZING"]},"subject":{"example":"{ \"emailAddresses\": [\"personal.email@domain.com\"], \"phoneNumbers\": [\"+13115552368\"] }","description":"The subject of the GDPR request","$ref":"#/definitions/GDPRSubject"},"resultsUrl":{"type":"string","description":"The location where the results of the request can be retrieved","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GDPRSubject":{"type":"object","properties":{"name":{"type":"string"},"userId":{"type":"string"},"externalContactId":{"type":"string"},"dialerContactId":{"$ref":"#/definitions/DialerContactId"},"journeyCustomer":{"$ref":"#/definitions/GDPRJourneyCustomer"},"socialHandle":{"$ref":"#/definitions/SocialHandle"},"externalId":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"phoneNumbers":{"type":"array","items":{"type":"string"}},"emailAddresses":{"type":"array","items":{"type":"string"}}}},"ReplacementTerm":{"type":"object","properties":{"type":{"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","enum":["TWITTER"]},"value":{"type":"string"}}},"GDPRRequestEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRRequest"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GDPRSubjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRSubject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean"},"mapboxKey":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"Greeting":{"type":"object","required":["owner","ownerType","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Greeting type","enum":["STATION","VOICEMAIL","NAME"]},"ownerType":{"type":"string","description":"Greeting owner type","enum":["USER","ORGANIZATION","GROUP"]},"owner":{"description":"Greeting owner","$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION","GROUP"]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Greeting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ClientApp":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED","RESTORED"]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/ClientAppConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a ClientApp"},"ClientAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"ClientAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ClientApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialSpecification":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if the credential must be provided in order for the integration configuration to be valid.","readOnly":true},"title":{"type":"string","description":"Title describing the usage for this credential.","readOnly":true},"credentialTypes":{"type":"array","description":"List of acceptable credential types that can be provided for this credential.","readOnly":true,"items":{"type":"string"}}},"description":"Specifies the requirements for a credential that can be provided for configuring an integration"},"EffectiveConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties"],"properties":{"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field.","additionalProperties":{"type":"object"}},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}}},"description":"Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type."},"HelpLink":{"type":"object","properties":{"uri":{"type":"string","description":"URI of the help resource","readOnly":true},"title":{"type":"string","description":"Link text of the resource","readOnly":true},"description":{"type":"string","description":"Description of the document or resource","readOnly":true}},"description":"Link to a help or support resource"},"IntegrationConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"IntegrationStatusInfo":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"description":"Localizable status details for the integration.","readOnly":true,"$ref":"#/definitions/MessageInfo"},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Status information for an Integration."},"IntegrationType":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"category":{"type":"string","description":"Category describing the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"helpUri":{"type":"string","description":"URI of a page with more information about the integration type","readOnly":true},"termsOfServiceUri":{"type":"string","description":"URI of a page with terms and conditions for the integration type","readOnly":true},"vendorName":{"type":"string","description":"Name of the vendor of this integration type","readOnly":true},"vendorWebsiteUri":{"type":"string","description":"URI of the vendor's website","readOnly":true},"marketplaceUri":{"type":"string","description":"URI of the marketplace listing for this integration type","readOnly":true},"faqUri":{"type":"string","description":"URI of frequently asked questions about the integration type","readOnly":true},"privacyPolicyUri":{"type":"string","description":"URI of a privacy policy for users of the integration type","readOnly":true},"supportContactUri":{"type":"string","description":"URI for vendor support","readOnly":true},"salesContactUri":{"type":"string","description":"URI for vendor sales information","readOnly":true},"helpLinks":{"type":"array","description":"List of links to additional help resources","readOnly":true,"items":{"$ref":"#/definitions/HelpLink"}},"credentials":{"type":"object","description":"Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CredentialSpecification"}},"nonInstallable":{"type":"boolean","description":"Indicates if the integration type is installable or not.","readOnly":true},"maxInstances":{"type":"integer","format":"int32","description":"The maximum number of integration instances allowable for this integration type","readOnly":true},"userPermissions":{"type":"array","description":"List of permissions required to permit user access to the integration type.","readOnly":true,"items":{"type":"string"}},"vendorOAuthClientIds":{"type":"array","description":"List of OAuth Client IDs that must be authorized when the integration is created.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"Integration":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED","RESTORED"]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"}},"description":"Configuration information for the integration"},"IntegrationTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"UserApp":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the userApp, used to distinguish this userApp from others of the same type.","readOnly":true},"integrationType":{"description":"Integration Type for the userApp","readOnly":true,"$ref":"#/definitions/IntegrationType"},"config":{"$ref":"#/definitions/UserAppConfigurationInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a UserApp"},"UserAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"UserAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Category":{"type":"object","properties":{"name":{"type":"string","description":"Category name"}},"description":"List of available Action categories."},"CategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Category"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ActionCertificate":{"type":"object","properties":{"signingAuthority":{"type":"string","description":"The Signing Authority for the certificate","enum":["DigiCert","Genesys"]},"certificate":{"type":"string","description":"The certificate string"},"status":{"type":"string","description":"The certificate status","enum":["Current","Upcoming"]},"type":{"type":"string","description":"The certificate type","enum":["Client"]}},"description":"Details for an mTLS certificate"},"ActionCertificateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionCertificate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Action":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"integrationId":{"type":"string","description":"The ID of the integration for which this action is associated"},"category":{"type":"string","description":"Category of Action"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContract"},"version":{"type":"integer","format":"int32","description":"Version of this action"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionConfig":{"type":"object","properties":{"timeoutSeconds":{"type":"integer","format":"int32","description":"Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."},"request":{"description":"Configuration of outbound request.","$ref":"#/definitions/RequestConfig"},"response":{"description":"Configuration of response processing.","$ref":"#/definitions/ResponseConfig"}},"description":"Defines components of the Action Config."},"ActionContract":{"type":"object","properties":{"output":{"description":"The output to expect when executing this action.","$ref":"#/definitions/ActionOutput"},"input":{"description":"The input required when executing this action.","$ref":"#/definitions/ActionInput"}},"description":"This resource contains all of the schemas needed to define the inputs and outputs, of a single Action."},"ActionInput":{"type":"object","properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaFlattened":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaUri":{"type":"string","description":"The URI of the input schema"}},"description":"Input requirements of Action."},"ActionOutput":{"type":"object","properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"successSchemaUri":{"type":"string","description":"URI to retrieve success schema"},"errorSchema":{"description":"JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaUri":{"type":"string","description":"URI to retrieve error schema"},"successSchemaFlattened":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaFlattened":{"type":"object","description":"JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both."}},"description":"Output definition of Action."},"RequestConfig":{"type":"object","properties":{"requestUrlTemplate":{"type":"string","description":"URL that may include placeholders for requests to 3rd party service. This value is read only for Function Integrations and will be set when a draft is created."},"requestTemplate":{"type":"string","description":"Velocity template to define request body sent to 3rd party service."},"requestTemplateUri":{"type":"string","description":"URI to retrieve requestTemplate"},"requestType":{"type":"string","description":"HTTP method to use for request"},"headers":{"type":"object","description":"Headers to include in request in (Header Name, Value) pairs.","additionalProperties":{"type":"string"}}},"description":"Defines response components of the Action Request."},"ResponseConfig":{"type":"object","properties":{"translationMap":{"type":"object","description":"Map 'attribute name' and 'JSON path' pairs used to extract data from REST response.","additionalProperties":{"type":"string"}},"translationMapDefaults":{"type":"object","description":"Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key.","additionalProperties":{"type":"string"}},"successTemplate":{"type":"string","description":"Velocity template to build response to return from Action."},"successTemplateUri":{"type":"string","description":"URI to retrieve success template."}},"description":"Defines response components of the Action Request."},"TestExecutionOperationResult":{"type":"object","properties":{"step":{"type":"integer","format":"int32","description":"The step number to indicate the order in which the operation was performed"},"name":{"type":"string","description":"Name of the operation performed"},"success":{"type":"boolean","description":"Indicated whether or not the operation was successful"},"result":{"type":"object","description":"The result of the operation"},"error":{"description":"Error that occurred during the operation","$ref":"#/definitions/ErrorBody"}}},"TestExecutionResult":{"type":"object","properties":{"operations":{"type":"array","description":"Execution operations performed as part of the test","items":{"$ref":"#/definitions/TestExecutionOperationResult"}},"error":{"description":"The final error encountered during the test that resulted in test failure","$ref":"#/definitions/ErrorBody"},"finalResult":{"type":"object","description":"The final result of the test. This is the response that would be returned during normal action execution"},"success":{"type":"boolean","description":"Indicates whether or not the test was a success"}}},"ActionContractInput":{"type":"object","required":["input","output"],"properties":{"input":{"description":"Execution input contract","$ref":"#/definitions/PostInputContract"},"output":{"description":"Execution output contract","$ref":"#/definitions/PostOutputContract"}},"description":"Contract definition."},"PostInputContract":{"type":"object","required":["inputSchema"],"properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected requests/inputs."},"PostOutputContract":{"type":"object","required":["successSchema"],"properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected responses/outputs."},"UpdateDraftInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"version":{"type":"integer","format":"int32","description":"Version of current Draft"}},"description":"Definition of an Action Draft to be created or updated."},"PublishDraftInput":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","example":"If the current draft version is 2 and the current published version of Action is 33, then you would send 2 here. (Your draft will become published version 34)","description":"The current draft version."}},"description":"Draft to be published"},"DraftValidationResult":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates if configuration is valid"},"errors":{"type":"array","description":"List of errors causing validation failure","items":{"$ref":"#/definitions/ErrorBody"}}},"description":"Validation results"},"UpdateActionInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"version":{"type":"integer","format":"int32","description":"Version of this action"}}},"ActionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Action"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PostActionInput":{"type":"object","required":["category","config","contract","integrationId","name"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"integrationId":{"type":"string","description":"The ID of the integration this action is associated to"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"}},"description":"Definition of an Action to be created or updated."},"BotConnectorBot":{"type":"object","required":["id","versions"],"properties":{"id":{"type":"string","description":"The Botconnector Bot Id - this is configurable by the user when put"},"name":{"type":"string"},"description":{"type":"string","description":"An optional description of the bot. This can be up to 256 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"versions":{"type":"array","description":"This bots versions, limit of 50 per bot","items":{"$ref":"#/definitions/BotConnectorBotVersion"}},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A botConnector Bot Instance"},"BotConnectorBotVersion":{"type":"object","required":["intents","supportedLanguages","version"],"properties":{"version":{"type":"string","description":"The name of the version. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"supportedLanguages":{"type":"array","description":"The supported languages for this bot. EG 'en-us' or 'es', etc; These language codes are W3C language identification tags (ISO 639-1 for the language name and ISO 3166 for the country code)","items":{"type":"string"}},"intents":{"type":"array","description":"A list of potential intents this bot will return, limit of 50","items":{"$ref":"#/definitions/BotIntent"}}},"description":"A version description for a botConnector bot."},"BotIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of this intent. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"slots":{"type":"object","description":"Optional returned data values associated with this intent, limit of 50.","additionalProperties":{"$ref":"#/definitions/BotSlot"}}},"description":"A botConnector's bot intention"},"BotList":{"type":"object","required":["chatBots"],"properties":{"chatBots":{"type":"array","description":"A list of botConnector Bots. Max 50","items":{"$ref":"#/definitions/BotConnectorBot"}}},"description":"A list of BotConnectorBots"},"BotSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the slot. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"type":{"type":"string","description":"The data type of the slot string, integer, decimal, duration, boolean, currency, datetime or the xxxCollection versions of those types"}},"description":"Description of a data value returned from an intent"},"BotConnectorBotSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BotSummary":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The name of the bot."},"id":{"type":"string","description":"The id of the bot."},"description":{"type":"string","description":"An optional description of the bot."},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true}},"description":"A summary description for a botConnector bot"},"BotConnectorBotVersionSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotVersionSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BotVersionSummary":{"type":"object","required":["id","name","version"],"properties":{"name":{"type":"string","description":"The name of the bot."},"id":{"type":"string","description":"The id of the bot."},"description":{"type":"string","description":"An optional description of the bot."},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true},"version":{"type":"string","description":"The name of the version."}},"description":"A version summary for a botConnector bot."},"DialogflowAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow agent","items":{"type":"string"}},"intents":{"type":"array","description":"An array of Intents associated with this agent","items":{"$ref":"#/definitions/DialogflowIntent"}},"environments":{"type":"array","description":"Available environments for this agent","items":{"type":"string"}},"integration":{"description":"The Integration this Dialogflow agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowIntent":{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","description":"The intent name"},"parameters":{"type":"object","description":"An object mapping parameter names to Parameter objects","additionalProperties":{"$ref":"#/definitions/DialogflowParameter"}}}},"DialogflowParameter":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The parameter name"},"type":{"type":"string","description":"The parameter type"}}},"DialogflowProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"DialogflowAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to.","$ref":"#/definitions/DialogflowProject"},"description":{"type":"string","description":"A description of the Dialogflow agent."},"integration":{"description":"The Integration this Dialogflow agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialogflowCXAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow CX agent belongs to.","$ref":"#/definitions/DialogflowCXProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow CX agent. Each value will be a language code in the country-locale format. e.g. en-us, es-us, fr-ca, etc.","items":{"type":"string"}},"environments":{"type":"array","description":"Available environments for this CX agent.","items":{"$ref":"#/definitions/DialogflowCXEnvironment"}},"integration":{"description":"The Integration this Dialogflow CX agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXEnvironment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"DialogflowCXAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow CX agent belongs to.","$ref":"#/definitions/DialogflowCXProject"},"description":{"type":"string","description":"A description of the Dialogflow CX agent."},"integration":{"description":"The Integration this Dialogflow CX agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowCXAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexBot":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the Lex bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotAlias":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"bot":{"description":"The Lex bot this is an alias for","$ref":"#/definitions/LexBot"},"botVersion":{"type":"string","description":"The version of the Lex bot this alias points at"},"status":{"type":"string","description":"The status of the Lex bot alias","enum":["BUILDING","READY","FAILED","NOT_BUILT"]},"failureReason":{"type":"string","description":"If the status is FAILED, Amazon Lex explains why it failed to build the bot"},"language":{"type":"string","description":"The target language of the Lex bot","enum":["en-US"]},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexIntent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexIntent":{"type":"object","required":["name","slots","version"],"properties":{"name":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexSlot"}},"version":{"type":"string","description":"The intent version"}}},"LexSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"type":{"type":"string","description":"The slot type"},"priority":{"type":"integer","format":"int32","description":"The priority of the slot"}}},"LexBotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexV2Bot":{"type":"object","required":["botId","region"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"botId":{"type":"string","description":"Lex V2 bot Id"},"region":{"type":"string","description":"A region of the Lex V2 bot"},"description":{"type":"string","description":"A description of the Lex V2 bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexV2BotAlias":{"type":"object","required":["aliasId","region"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"region":{"type":"string","description":"The Lex V2 bot region"},"aliasId":{"type":"string","description":"The Lex V2 bot alias Id"},"bot":{"description":"The Lex V2 bot this is an alias for","$ref":"#/definitions/LexV2Bot"},"botVersion":{"type":"string","description":"The version of the Lex V2 bot this alias points at"},"status":{"type":"string","description":"The status of the Lex V2 bot alias","enum":["Creating","Available","Deleting","Failed"]},"language":{"type":"string","description":"The target language of the Lex V2 bot"},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexV2Intent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexV2Intent":{"type":"object","required":["intentId","intentName","slots"],"properties":{"intentName":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexV2Slot"}},"intentId":{"type":"string","description":"The intent id"}}},"LexV2Slot":{"type":"object","required":["slotId","slotName","slotTypeId","type"],"properties":{"slotName":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"slotId":{"type":"string","description":"The slot id"},"type":{"type":"string","description":"The slot type"},"slotTypeId":{"type":"string","description":"The slot type id"}}},"LexV2BotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexV2BotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexV2BotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexV2Bot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AsyncJob":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"state":{"type":"string","enum":["Running","Completed","Failed","Cancelled"]}}},"ComplexVariableInfo":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The variable type ID"},"name":{"type":"string","description":"The variable type display name"}},"description":"Variable type information about a complex type from the bot's definition"},"NuanceApplication":{"type":"object","required":["id","name","tag"],"properties":{"id":{"type":"string","description":"The application ID"},"tag":{"type":"string","description":"The application Tag"},"name":{"type":"string","description":"The application name"}},"description":"Model for a Nuance bot application"},"NuanceBot":{"type":"object","required":["application","geography","id","integrationId","name","nuanceEnvironment","nuanceOrganization"],"properties":{"id":{"type":"string","description":"Nuance bot Id"},"name":{"type":"string","description":"Nuance bot name"},"integrationId":{"type":"string","description":"The Integration Id for this bot"},"nuanceOrganization":{"description":"The Nuance Organization for this bot","$ref":"#/definitions/NuanceOrganization"},"application":{"description":"The Application for this bot","$ref":"#/definitions/NuanceApplication"},"nuanceEnvironment":{"description":"The environment of the Nuance bot","$ref":"#/definitions/NuanceEnvironment"},"geography":{"description":"The Geography of the Nuance bot","$ref":"#/definitions/NuanceGeography"},"credentials":{"type":"array","description":"client ID/Secret objects for the credentials that execute this Nuance bot","items":{"$ref":"#/definitions/NuanceBotCredentials"}},"variables":{"type":"array","description":"List of available variables in this Nuance bot. When querying, use the 'expand=variables' query param to populate this value","items":{"$ref":"#/definitions/NuanceBotVariable"}},"transferNodes":{"type":"array","description":"List of transferNodes in this Nuance bot. When querying, use the 'expand=transferNodes' query param to populate this value","items":{"$ref":"#/definitions/NuanceBotTransferNode"}},"locales":{"type":"array","description":"List of locales associated with this Nuance bot. Generally in the ISO format such as 'en-US'","items":{"type":"string"}},"channels":{"type":"array","description":"List of channels associated with this Nuance bot.","items":{"$ref":"#/definitions/NuanceChannel"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Model for a Nuance bot"},"NuanceBotCredentials":{"type":"object","required":["appId","clientId"],"properties":{"appId":{"type":"string","description":"The application ID"},"clientId":{"type":"string","description":"The credentials client ID"},"clientSecret":{"type":"string","description":"The credentials client secret"},"clientSecretProvided":{"type":"boolean","description":"True if the credentials secret is set (but not returned due to security reasons)"}},"description":"Model for a Nuance bot credentials"},"NuanceBotTransferNode":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","description":"The transfer node ID"},"name":{"type":"string","description":"The transfer node name"},"type":{"type":"string","description":"The transfer node type","enum":["End","Escalate"]},"description":{"type":"string","description":"The transfer node description"},"requestVariables":{"type":"array","description":"List of variables associated with this transfer node","items":{"$ref":"#/definitions/NuanceBotVariable"}}},"description":"Model for a Nuance bot transfer node"},"NuanceBotVariable":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The variable ID"},"name":{"type":"string","description":"The variable display name"},"description":{"type":"string","description":"The variable description"},"reserved":{"type":"boolean","description":"True if the variable is a reserved variable"},"simpleVariableInfo":{"type":"string","description":"The type information for this variable"},"complexGenericVariableInfo":{"description":"The type information for this variable","$ref":"#/definitions/ComplexVariableInfo"}},"description":"Model for a Nuance bot variable"},"NuanceChannel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The channel ID"},"name":{"type":"string","description":"The channel name"},"modes":{"type":"array","description":"Supported Channel Modes","items":{"type":"string"}},"color":{"type":"string","description":"The Channel Color"}},"description":"Model for a Nuance channel"},"NuanceEnvironment":{"type":"object","required":["environmentDesignation","id","name"],"properties":{"id":{"type":"string","description":"The environment ID"},"name":{"type":"string","description":"The environment name"},"environmentDesignation":{"type":"string","description":"The environment type, usually a value like SANDBOX or PRODUCTION"},"executionHost":{"type":"string","description":"The host used to execute this bot, similar to 'api.nuance.com:443'"}},"description":"Model for a Nuance bot environment"},"NuanceGeography":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The geography ID"},"name":{"type":"string","description":"The geography name"}},"description":"Model for a Nuance bot geography"},"NuanceOrganization":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The organization ID"},"name":{"type":"string","description":"The organization name"}},"description":"Model for a Nuance bot organization"},"NuanceBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NuanceBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Model for a paged listing of Nuance bots"},"BotExecutionConfiguration":{"type":"object","required":["botCredentials","botId","executionHost"],"properties":{"botId":{"type":"string","description":"The Nuance bot ID"},"executionHost":{"type":"string","description":"The hostname to use when contacting Nuance to execute this bot"},"botCredentials":{"description":"The bot's launch credentials","$ref":"#/definitions/NuanceBotCredentials"}},"description":"Model for setting the launch configuration for a Nuance bot available to Genesys Cloud"},"NuanceBotLaunchSettings":{"type":"object","required":["botExecutionConfigurations"],"properties":{"botExecutionConfigurations":{"type":"array","description":"The list of Nuance bots that are configured as available to the Genesys Cloud system","items":{"$ref":"#/definitions/BotExecutionConfiguration"}}},"description":"Model for setting the launch configuration for Nuance bots available to Genesys Cloud"},"SttEngineEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grammarBased":{"type":"boolean","description":"The STT engine is intended to be used for Grammars"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SttEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SttEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TtsEngineEntity":{"type":"object","required":["languages","outputFormats"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languages":{"type":"array","description":"The set of languages the TTS engine supports","items":{"type":"string"}},"outputFormats":{"type":"array","description":"The set of output formats the TTS engine can produce","items":{"type":"string"}},"voices":{"type":"array","description":"The set of voices the TTS engine supports","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"isDefault":{"type":"boolean","description":"The TTS engine is the global default engine"},"isSecure":{"type":"boolean","description":"The TTS engine can be used in a secure call flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsVoiceEntity":{"type":"object","required":["engine","gender","language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"gender":{"type":"string","description":"The gender of the TTS voice"},"language":{"type":"string","description":"The language supported by the TTS voice"},"engine":{"description":"Ths TTS engine this voice belongs to","$ref":"#/definitions/TtsEngineEntity"},"isDefault":{"type":"boolean","description":"The voice is the default voice for its language"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LanguageOverride":{"type":"object","required":["engine","language","voice"],"properties":{"language":{"type":"string","description":"The language code of the language being overridden"},"engine":{"type":"string","description":"The ID of the TTS engine to use for this language override"},"voice":{"type":"string","description":"The ID of the voice to use for this language override. The voice must be supported by the chosen engine."}}},"TtsSettings":{"type":"object","required":["defaultEngine","languageOverrides"],"properties":{"defaultEngine":{"type":"string","description":"ID of the global default TTS engine"},"languageOverrides":{"type":"array","description":"The list of default overrides for specific languages","items":{"$ref":"#/definitions/LanguageOverride"}}}},"TtsVoiceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"triggerWithOutcomePercentileConditions":{"type":"array","description":"(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomePercentileCondition"}},"triggerWithOutcomeQuantileConditions":{"type":"array","description":"Quantile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeQuantileCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/ActionMapAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/ActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ActionMapAction":{"type":"object","properties":{"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"actionTargetId":{"type":"string","description":"Action target ID."},"isPacingEnabled":{"type":"boolean","description":"Whether this action should be throttled."},"props":{"description":"Additional properties.","$ref":"#/definitions/ActionProperties"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"},"webMessagingOfferFields":{"description":"Admin-configurable fields of a web messaging offer action.","$ref":"#/definitions/WebMessagingOfferFields"},"openActionFields":{"description":"Admin-configurable fields of an open action.","$ref":"#/definitions/OpenActionFields"}}},"ActionMapActionTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapScheduleGroup":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the action maps's associated schedule group."}}},"ActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"ActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/ActionSurvey"}}},"ActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/JourneySurveyQuestion"}}}},"Activation":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of activation."},"delayInSeconds":{"type":"integer","format":"int32","description":"Activation delay time amount."}}},"ArchitectFlowFields":{"type":"object","properties":{"architectFlow":{"description":"The architect flow.","$ref":"#/definitions/AddressableEntityRef"},"flowRequestMappings":{"type":"array","description":"Collection of Architect Flow Request Mappings to use.","items":{"$ref":"#/definitions/RequestMapping"}}}},"EventCondition":{"type":"object","required":["key","sessionType","streamType","values"],"properties":{"key":{"type":"string","description":"The event key."},"values":{"type":"array","description":"The event values.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"streamType":{"type":"string","description":"The stream type for which this condition can be satisfied.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this condition can be satisfied."},"eventName":{"type":"string","description":"The name of the event for which this condition can be satisfied."}}},"JourneySurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"OpenActionFields":{"type":"object","required":["openAction"],"properties":{"openAction":{"description":"The specific type of the open action.","$ref":"#/definitions/DomainEntityRef"},"configurationFields":{"type":"object","description":"Custom fields defined in the schema referenced by the open action type selected.","additionalProperties":{"type":"object"}}}},"OutcomePercentileCondition":{"type":"object","required":["maximumPercentile","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumPercentile":{"type":"number","format":"float","description":"Percentile value for the selected outcome, at or above which the action map will trigger."},"fallbackPercentile":{"type":"number","format":"float","description":"Additional percentile condition, where if set, the action map will trigger if the current outcome percentile is lower or equal to the value."}}},"OutcomeProbabilityCondition":{"type":"object","required":["maximumProbability","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."}}},"OutcomeQuantileCondition":{"type":"object","required":["maxQuantileThreshold","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maxQuantileThreshold":{"type":"number","format":"float","description":"This Outcome Quantile Condition is met when sessionMaxQuantile of the OutcomeScore is above this value, (unless fallbackQuantile is set). Range 0.00-1.00"},"fallbackQuantileThreshold":{"type":"number","format":"float","description":"(Optional) If set, this Condition is met when maxQuantileThreshold is met, AND the current quantile of the OutcomeScore is below this fallbackQuantileThreshold. Range 0.00-1.00"}}},"RequestMapping":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Integration Action Attribute to supply the value for"},"attributeType":{"type":"string","description":"Type of the value supplied","enum":["String","Number","Integer","Boolean"]},"mappingType":{"type":"string","description":"Method of finding value to use with Attribute","enum":["Lookup","HardCoded"]},"value":{"type":"string","description":"Value to supply for the specified Attribute"}}},"UrlCondition":{"type":"object","required":["operator","values"],"properties":{"values":{"type":"array","description":"The URL condition value.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"WebMessagingOfferFields":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."},"architectFlow":{"description":"Flow to be invoked, overrides default flow when specified.","$ref":"#/definitions/AddressableEntityRef"}}},"PatchAction":{"type":"object","required":["mediaType"],"properties":{"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"actionTargetId":{"type":"string","description":"Action target ID."},"isPacingEnabled":{"type":"boolean","description":"Whether this action should be throttled."},"props":{"description":"Additional properties.","$ref":"#/definitions/PatchActionProperties"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"},"webMessagingOfferFields":{"description":"Admin-configurable fields of a web messaging offer action.","$ref":"#/definitions/PatchWebMessagingOfferFields"},"openActionFields":{"description":"Admin-configurable fields of an open action.","$ref":"#/definitions/OpenActionFields"}}},"PatchActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"triggerWithOutcomePercentileConditions":{"type":"array","description":"(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomePercentileCondition"}},"triggerWithOutcomeQuantileConditions":{"type":"array","description":"Quantile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeQuantileCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/PatchAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/PatchActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"PatchActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/PatchActionSurvey"}}},"PatchActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/PatchSurveyQuestion"}}}},"PatchSurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"PatchWebMessagingOfferFields":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."},"architectFlow":{"description":"Flow to be invoked, overrides default flow when specified.","$ref":"#/definitions/AddressableEntityRef"}}},"ActionMapListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionMap"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userData":{"type":"array","description":"Additional user data associated with the target in key/value format.","items":{"$ref":"#/definitions/KeyValue"}},"supportedMediaTypes":{"type":"array","description":"Supported media types of the target.","items":{"type":"string","enum":["callback","call","email","generic","messaging","social","webchat"]}},"state":{"type":"string","description":"Indicates the state of the target.","enum":["active","inactive","deleted"]},"description":{"type":"string","description":"Description of the target."},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"KeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for free-form data."},"value":{"type":"string","description":"Value for free-form data."}}},"PatchActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddressableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionTargetListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTarget"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTemplate":{"type":"object","required":["mediaType","name","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"version":{"type":"integer","format":"int32","description":"The version of the action template.","readOnly":true},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/ContentOffer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when action template was created in ISO-8601 format.","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when action template was last modified in ISO-8601 format.","readOnly":true}}},"CallToAction":{"type":"object","required":["url"],"properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"]}}},"CloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"ContentOffer":{"type":"object","required":["displayMode","layoutMode"],"properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/CallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/ContentOfferStylingConfiguration"}}},"ContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"ContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/ContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/ContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/CloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/CtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/TextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/TextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/TextStyleProperties"}}},"ContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"CtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #FF0000)"}}},"IntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/IntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"TextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]}}},"PatchActionTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"version":{"type":"integer","format":"int32","description":"The version of the action template."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/PatchContentOffer"}}},"PatchCallToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"]}}},"PatchCloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"PatchContentOffer":{"type":"object","properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/PatchCallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/PatchContentOfferStylingConfiguration"}}},"PatchContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"PatchContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/PatchContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/PatchContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/PatchCloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/PatchCtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/PatchTextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/PatchTextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/PatchTextStyleProperties"}}},"PatchContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"PatchCtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #A04033)"}}},"PatchIntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration action to be invoked."}}},"PatchIntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/PatchIntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"PatchTextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]}}},"ActionTemplateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionMapEstimateResult":{"type":"object","properties":{"qualifiedSessionCount":{"type":"integer","format":"int32","description":"Number of sessions qualified for Action map."},"totalSessionCount":{"type":"integer","format":"int32","description":"Total number of sessions."},"perSegmentCounts":{"type":"array","description":"Number of sessions qualified for Action map per segment.","items":{"$ref":"#/definitions/SegmentEstimateCount"}},"outcomesScoresCount":{"type":"integer","format":"int32","description":"Difference made by outcome criteria to number of sessions qualified for Action map."}}},"SegmentEstimateCount":{"type":"object","properties":{"segmentId":{"type":"string","description":"ID of Segment."},"count":{"type":"integer","format":"int32","description":"Estimate count per segment."}}},"EstimateJobAsyncResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapEstimateOutcomeCriteria":{"type":"object","required":["outcomeId"],"properties":{"outcomeId":{"type":"string","description":"ID of outcome."},"maxProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."},"quantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted probability."},"maxQuantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted session max probability."}}},"ActionMapEstimateRequest":{"type":"object","properties":{"segmentIds":{"type":"array","description":"List of Segment IDs.","items":{"type":"string"}},"outcomeCriteria":{"description":"Outcome Criteria containing outcomeId and probability thresholds.","$ref":"#/definitions/ActionMapEstimateOutcomeCriteria"}}},"FlowPaths":{"type":"object","required":["category","elements"],"properties":{"category":{"type":"string","description":"Category (use case) of the paths within a given domain.","enum":["All","Abandoned","AgentEscalation","Complete","Disconnect","Error","RecognitionFailure","Transfer"]},"elements":{"type":"object","description":"Unique element identifiers and their corresponding elements in the trie data structure representing the paths.","additionalProperties":{"$ref":"#/definitions/FlowPathsElement"}}}},"FlowPathsElement":{"type":"object","required":["count","flows","type"],"properties":{"parentId":{"type":"string","description":"Unique identifier of the parent element. Will be null for the root element."},"type":{"type":"string","description":"Type of the element.","enum":["Abandoned","AgentEscalation","Disconnect","Error","Exit","Milestone","Outcome","RecognitionFailure","Root","TransferToAcd"]},"count":{"type":"integer","format":"int32","description":"Count of all journeys that include this element."},"flows":{"type":"array","description":"Details of flows involved in journeys that include this element.","items":{"$ref":"#/definitions/FlowPathsFlowDetails"}},"flowOutcomeValue":{"type":"string","description":"The value of the flow outcome, if the element type is Outcome.","enum":["FAILURE","SUCCESS","UNKNOWN"]},"flowMilestone":{"description":"The flow milestone, set if the element type is Milestone.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flowOutcome":{"description":"The flow outcome, set if the element type is Outcome or Milestone.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"FlowPathsFlowDetails":{"type":"object","required":["count","flow","type","version"],"properties":{"version":{"type":"string","description":"The version of the flow."},"type":{"type":"string","description":"The type of the flow.","enum":["DigitalBot","Bot","InboundCall","SecureCall","InboundShortMessage","InboundEmail","OutboundCall"]},"count":{"type":"integer","format":"int32","description":"Count of all journeys that include this element in the given flow."},"flow":{"description":"The identifier of the flow.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"FlowPathsFlowFilter":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the flow."}}},"FlowPathsQuery":{"type":"object","required":["category","flows"],"properties":{"category":{"type":"string","description":"Category (use case) of the paths within a given domain.","enum":["All","Abandoned","AgentEscalation","Complete","Disconnect","Error","RecognitionFailure","Transfer"]},"flows":{"type":"array","description":"List of flows to query the paths result.","items":{"$ref":"#/definitions/FlowPathsFlowFilter"}}}},"AssociatedValueField":{"type":"object","required":["dataType","name"],"properties":{"dataType":{"type":"string","description":"The data type of the value field.","enum":["Number","Integer"]},"name":{"type":"string","description":"The field name for extracting value from event."}}},"Context":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/ContextPattern"}}}},"ContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/EntityTypeCriteria"}}}},"Criteria":{"type":"object","required":["key","operator","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"EntityTypeCriteria":{"type":"object","required":["entityType","key","operator","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"Journey":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/JourneyPattern"}}}},"JourneyPattern":{"type":"object","required":["count","criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/Criteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"Outcome":{"type":"object","required":["context","createdDate","displayName","id","isActive","isPositive","journey","modifiedDate","version"],"properties":{"id":{"type":"string","description":"ID of the outcome."},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/AssociatedValueField"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchAssociatedValueField":{"type":"object","properties":{"dataType":{"type":"string","description":"The data type of the value field.","enum":["Number","Integer"]},"name":{"type":"string","description":"The field name for extracting value from event."}}},"PatchContext":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/PatchContextPattern"}}}},"PatchContextPattern":{"type":"object","properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/PatchEntityTypeCriteria"}}}},"PatchCriteria":{"type":"object","properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"PatchEntityTypeCriteria":{"type":"object","properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"PatchJourney":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/PatchJourneyPattern"}}}},"PatchJourneyPattern":{"type":"object","properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/PatchCriteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"PatchOutcome":{"type":"object","required":["displayName"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/PatchContext"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/PatchJourney"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/PatchAssociatedValueField"}}},"OutcomeRequest":{"type":"object","required":["displayName"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/RequestContext"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/RequestJourney"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/AssociatedValueField"}}},"RequestContext":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/RequestContextPattern"}}}},"RequestContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/RequestEntityTypeCriteria"}}}},"RequestCriteria":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"RequestEntityTypeCriteria":{"type":"object","required":["entityType","key","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"RequestJourney":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/RequestJourneyPattern"}}}},"RequestJourneyPattern":{"type":"object","required":["count","criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/RequestCriteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"OutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Outcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutcomeScore":{"type":"object","properties":{"outcome":{"description":"The outcome that the score was calculated for.","$ref":"#/definitions/AddressableEntityRef"},"sessionMaxProbability":{"type":"number","format":"float","description":"Represents the max probability reached in the session."},"probability":{"type":"number","format":"float","description":"Represents the likelihood of a customer reaching or achieving a given outcome."},"percentile":{"type":"integer","format":"int32","description":"(Deprecated: use the 'quantile' field instead) Represents the predicted probability's percentile score when compared with all other generated probabilities for a given outcome."},"sessionMaxPercentile":{"type":"integer","format":"int32","description":"(Deprecated: use the 'quantile' field instead) Represents the maximum likelihood percentile score reached for a given outcome by the current session."},"quantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted probability."},"sessionMaxQuantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted session max probability."}}},"OutcomeScoresResult":{"type":"object","properties":{"outcomeScores":{"type":"array","description":"List of scored outcomes in the session.","items":{"$ref":"#/definitions/OutcomeScore"}},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating the last time that the event was scored. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"OutcomePredictor":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"outcome":{"description":"The outcome for which this predictor will provide predictions.","$ref":"#/definitions/OutcomeRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeRef":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomePredictorRequest":{"type":"object","required":["outcome"],"properties":{"outcome":{"description":"The outcome for which this predictor will provide predictions.","$ref":"#/definitions/OutcomeRefRequest"}}},"OutcomeRefRequest":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of outcome."}}},"OutcomePredictorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomePredictor"}}}},"ExternalSegment":{"type":"object","required":["id","name","source"],"properties":{"id":{"type":"string","description":"Identifier for the external segment in the system where it originates from."},"name":{"type":"string","description":"Name for the external segment in the system where it originates from."},"source":{"type":"string","description":"The external system where the segment originates from.","enum":["AdobeExperiencePlatform","Custom"]}}},"JourneySegment":{"type":"object","required":["color","context","createdDate","displayName","id","isActive","journey","modifiedDate","scope","shouldDisplayToAgent","version"],"properties":{"id":{"type":"string","description":"The ID of the segment."},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/ExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchExternalSegment":{"type":"object","properties":{"name":{"type":"string","description":"Name for the external segment in the system where it originates from."}}},"PatchSegment":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/PatchContext"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/PatchJourney"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/PatchExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."}}},"JourneySegmentRequest":{"type":"object","required":["color","context","displayName","journey"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/RequestContext"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/RequestJourney"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/RequestExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."}}},"RequestExternalSegment":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Identifier for the external segment in the system where it originates from."},"name":{"type":"string","description":"Name for the external segment in the system where it originates from."},"source":{"type":"string","description":"The external system where the segment originates from.","enum":["AdobeExperiencePlatform","Custom"]}}},"SegmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneySegment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CategoryReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the category."},"name":{"type":"string","description":"Category name."},"parentCategory":{"description":"The reference to category to which this category belongs to.","$ref":"#/definitions/CategoryReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"description":{"type":"string"},"externalId":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"parentCategory":{"description":"The reference to category to which this category belongs to.","$ref":"#/definitions/CategoryReference"},"documentCount":{"type":"integer","format":"int32","description":"Number of documents assigned to this category."},"knowledgeBase":{"description":"The reference to knowledge base to which the category belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CategoryResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"CategoryCreateRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"parentCategoryId":{"type":"string"},"description":{"type":"string","description":"The description for the category."},"externalId":{"type":"string","description":"The external id associated with the category."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"parentCategoryId":{"type":"string","description":"The category to which this category belongs."},"description":{"type":"string"},"externalId":{"type":"string","description":"The external id associated with the category."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArticleContent":{"type":"object","properties":{"body":{"description":"Body of the article content.","readOnly":true,"$ref":"#/definitions/ArticleContentBody"}}},"ArticleContentBody":{"type":"object","properties":{"locationUrl":{"type":"string","description":"Presigned URL to retrieve the document content.","readOnly":true}}},"DocumentArticle":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"The title of the Article."},"content":{"description":"The content of the Article.","readOnly":true,"$ref":"#/definitions/ArticleContent"},"alternatives":{"type":"array","description":"List of Alternative questions related to the title which helps in improving the likelihood of a match to user query.","items":{"type":"string"}}}},"DocumentFaq":{"type":"object","required":["answer","question"],"properties":{"question":{"type":"string","description":"The question for this FAQ"},"answer":{"type":"string","description":"The answer for this FAQ"},"alternatives":{"type":"array","description":"List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query","items":{"type":"string"}}}},"KnowledgeBase":{"type":"object","required":["coreLanguage"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-US","description":"Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL] which might have a lower accuracy.","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"dateCreated":{"type":"string","format":"date-time","description":"Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"faqCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type FAQ in the KnowledgeBase","readOnly":true},"dateDocumentLastModified":{"type":"string","format":"date-time","description":"The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"articleCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type Article in the KnowledgeBase","readOnly":true},"published":{"type":"boolean","description":"Flag that indicates the knowledge base is published","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchDocumentV1":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"type":{"type":"string","description":"Document type","enum":["Faq","Article"]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"article":{"description":"Article","$ref":"#/definitions/DocumentArticle"},"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchResponse":{"type":"object","properties":{"searchId":{"type":"string","description":"Search Id","readOnly":true},"total":{"type":"integer","format":"int32","description":"Total number of records returned","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"pageSize":{"type":"integer","format":"int32","description":"Number of records according to the page size","readOnly":true},"pageNumber":{"type":"integer","format":"int32","description":"Current page number for the returned records","readOnly":true},"results":{"type":"array","description":"Results associated to the search response","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeSearchDocumentV1"}}}},"KnowledgeSearchRequest":{"type":"object","required":["languageCode","query"],"properties":{"query":{"type":"string","description":"Input query to search content in the knowledge base"},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results"},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results"},"documentType":{"type":"string","description":"Document type to be used while searching","enum":["Faq","Article"]},"languageCode":{"type":"string","description":"query search for specific languageCode"},"searchOnDraftDocuments":{"type":"boolean","description":"If true the search query will be executed on draft documents, else it will be on active documents"}}},"CategoryListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeExtendedCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"parent":{"description":"Category parent","readOnly":true,"$ref":"#/definitions/KnowledgeCategory"},"children":{"type":"array","description":"Category children","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeCategory"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentCategoryInput":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"KnowledgeBase Category ID"}}},"KnowledgeCategoryRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"parent":{"description":"Category parent","$ref":"#/definitions/DocumentCategoryInput"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ImportError":{"type":"object","properties":{"message":{"type":"string"},"line":{"type":"integer","format":"int32"}}},"ImportReport":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/ImportError"}},"validated":{"$ref":"#/definitions/ResultCounters"},"imported":{"$ref":"#/definitions/ResultCounters"},"totalDocuments":{"type":"integer","format":"int32"}}},"KnowledgeImport":{"type":"object","required":["fileType","uploadKey"],"properties":{"id":{"type":"string","description":"Id of the import operation","readOnly":true},"name":{"type":"string","description":"Name of the import operation"},"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"file type of the document","enum":["Csv","JsonLines"]},"ignoreHeaders":{"type":"boolean","description":"Ignore headers for the specified file"},"status":{"type":"string","description":"Status of the operation","readOnly":true,"enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the import operation","readOnly":true,"$ref":"#/definitions/ImportReport"},"knowledgeBase":{"description":"Knowledge base which document import does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Language code","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResultCounters":{"type":"object","properties":{"success":{"type":"integer","format":"int32"},"failure":{"type":"integer","format":"int32"}}},"ImportStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"New status for existing import operation"}}},"KnowledgeDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]},"type":{"type":"string","description":"Document type","enum":["Faq","Article"]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"article":{"description":"Article","$ref":"#/definitions/DocumentArticle"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq","Article"]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"article":{"description":"Article details","$ref":"#/definitions/DocumentArticle"}}},"DocumentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocument"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentBulkRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq","Article"]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"article":{"description":"Article details","$ref":"#/definitions/DocumentArticle"},"id":{"type":"string","description":"Identifier of document for update. Omit for create new Document."}}},"KnowledgeBaseUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Knowledge base name"},"description":{"type":"string","description":"Knowledge base description"}}},"KnowledgeBaseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeBase"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeBaseCreateRequest":{"type":"object","required":["coreLanguage","name"],"properties":{"name":{"type":"string","description":"Knowledge base name"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-US","description":"Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL] which might have a lower accuracy.","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL"]}}},"KnowledgeGroupStatistics":{"type":"object","properties":{"unlinkedPhraseCount":{"type":"integer","format":"int32","description":"Knowledge Group unique phrase count"},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Knowledge Group unlinked phrases hit count"},"totalPhraseHitCount":{"type":"integer","format":"int32","description":"Total number of phrase hit counts of an unanswered group"}}},"UnansweredGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"label":{"type":"string","description":"Knowledge base unanswered group label"},"phraseGroups":{"type":"array","description":"Represents a list of phrase groups inside an unanswered group","items":{"$ref":"#/definitions/UnansweredPhraseGroup"}},"suggestedDocuments":{"type":"array","description":"Represents a list of documents that may be linked to an unanswered group","items":{"$ref":"#/definitions/UnansweredGroupSuggestedDocument"}},"statistics":{"description":"Statistics object containing the various hit counts for an unanswered group","$ref":"#/definitions/KnowledgeGroupStatistics"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnansweredGroupSuggestedDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnansweredGroups":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnansweredGroup"}}}},"UnansweredPhrase":{"type":"object","properties":{"id":{"type":"string","description":"Id of an unanswered phrase"},"text":{"type":"string","description":"Phrase text of an unanswered phrase"},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Hit count of an unlinked phrase"}}},"UnansweredPhraseGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"label":{"type":"string","description":"Knowledge base phrase group label"},"phrases":{"type":"array","description":"List of unanswered phrases in a phrase group","items":{"$ref":"#/definitions/UnansweredPhrase"}},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Hit count of the unlinked phrase group"},"unlinkedPhraseCount":{"type":"integer","format":"int32","description":"Unique phrase count of the unlinked phrase group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhraseAssociations":{"type":"object","required":["documentId","phraseId"],"properties":{"phraseId":{"type":"string","description":"Id of the phrase to be linked"},"documentId":{"type":"string","description":"Id of the document to be linked"}}},"UnansweredPhraseGroupUpdateResponse":{"type":"object","properties":{"phraseAssociations":{"type":"array","description":"List of phrases and documents linked in the patch request","items":{"$ref":"#/definitions/PhraseAssociations"}},"group":{"description":"Knowledge base unanswered group response","$ref":"#/definitions/UnansweredGroup"}}},"UnansweredPhraseGroupPatchRequestBody":{"type":"object","required":["phraseAssociations"],"properties":{"phraseAssociations":{"type":"array","description":"List of phrases and documents to be linked","items":{"$ref":"#/definitions/PhraseAssociations"}},"dateStart":{"type":"string","format":"date","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"LabelResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color of the label."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The last modification date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentCount":{"type":"integer","format":"int32","description":"Number of documents assigned to this label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LabelUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color for the label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LabelListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LabelResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"LabelCreateRequest":{"type":"object","required":["color","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color for the label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeTraining":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateTriggered":{"type":"string","format":"date-time","description":"Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Training status.","readOnly":true,"enum":["Queued","InProgress","Succeeded","Failed"]},"languageCode":{"type":"string","description":"Language of the documents that are trained.","readOnly":true},"knowledgeBase":{"description":"Knowledge Base that the training belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"errorMessage":{"type":"string","description":"Any error message during the Training or Promote action.","readOnly":true},"knowledgeDocumentsState":{"type":"string","description":"State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.","readOnly":true,"enum":["Draft","Active","Discarded","Archived"]},"datePromoted":{"type":"string","format":"date-time","description":"Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrainingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeTraining"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"DocumentBodyBlockWithHighlight":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Image","Video","OrderedList","UnorderedList","Table"]},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"}}},"DocumentBodyImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL for the image."},"hyperlink":{"type":"string","description":"The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label//"},"properties":{"description":"The properties for the image.","$ref":"#/definitions/DocumentBodyImageProperties"}}},"DocumentBodyImageProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color property for the image. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align property for the image.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation property for the image. The valid values in 'em'."}}},"DocumentBodyList":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlock"}},"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"}}},"DocumentBodyListBlock":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlock"}},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"}}},"DocumentBodyListBlockProperties":{"type":"object","properties":{"unorderedType":{"type":"string","description":"The type of icon for the unordered list.","enum":["Normal","Square","Circle","None"]},"orderedType":{"type":"string","description":"The type of icon for the ordered list.","enum":["Number","LowerAlpha","LowerGreek","LowerRoman","UpperAlpha","UpperRoman","None"]}}},"DocumentBodyListItemProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color for the list item. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the list item.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation property for the list item. The valid values in 'em'."},"fontSize":{"type":"string","description":"The font size for the list item. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"fontType":{"type":"string","description":"The font type for the list item.","enum":["Paragraph","Heading1","Heading2","Heading3","Heading4","Heading5","Heading6","Preformatted"]},"textColor":{"type":"string","description":"The text color for the list item. The valid values in hex color code representation. For example black color - #000000"},"unorderedType":{"type":"string","description":"The type of icon for the unordered list.","enum":["Normal","Square","Circle","None"]},"orderedType":{"type":"string","description":"The type of icon for the ordered list.","enum":["Number","LowerAlpha","LowerGreek","LowerRoman","UpperAlpha","UpperRoman","None"]}}},"DocumentBodyParagraph":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of blocks for the paragraph.","items":{"$ref":"#/definitions/DocumentContentBlock"}},"properties":{"description":"The properties for the paragraph.","$ref":"#/definitions/DocumentBodyParagraphProperties"}}},"DocumentBodyParagraphProperties":{"type":"object","properties":{"fontSize":{"type":"string","description":"The font size for the paragraph. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"fontType":{"type":"string","description":"The font type for the paragraph.","enum":["Paragraph","Heading1","Heading2","Heading3","Heading4","Heading5","Heading6","Preformatted"]},"textColor":{"type":"string","description":"The text color for the paragraph. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the paragraph. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the paragraph.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation color for the paragraph. The valid values in 'em'."}}},"DocumentBodyParagraphWithHighlight":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of blocks for the paragraph.","items":{"$ref":"#/definitions/DocumentContentBlockWithHighlight"}},"properties":{"description":"The properties for the paragraph.","$ref":"#/definitions/DocumentBodyParagraphProperties"}}},"DocumentBodyTable":{"type":"object","required":["rows"],"properties":{"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlock"}},"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"}}},"DocumentBodyTableCaptionBlock":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the caption property.","items":{"$ref":"#/definitions/DocumentBodyTableCaptionItem"}}}},"DocumentBodyTableCaptionItem":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the caption item.","enum":["Text","Paragraph","Image","Video","OrderedList","UnorderedList"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"}}},"DocumentBodyTableCellBlock":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlock"}},"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"}}},"DocumentBodyTableCellBlockProperties":{"type":"object","properties":{"cellType":{"type":"string","description":"The type of the table cell.","enum":["Cell","HeaderCell"]},"width":{"type":"number","format":"float","description":"The width for the table cell."},"height":{"type":"number","format":"float","description":"The height for the table cell."},"horizontalAlign":{"type":"string","description":"The horizontal alignment for the table cell.","enum":["Center","Left","Right"]},"verticalAlign":{"type":"string","description":"The vertical alignment for the table cell.","enum":["Top","Middle","Bottom"]},"borderWidth":{"type":"number","format":"float","description":"The border width for the table cell. The valid values in 'em'"},"borderStyle":{"type":"string","description":"The border style for the table cell.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table cell. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table cell. For example black color - #000000"},"scope":{"type":"string","description":"The scope for the table cell.","enum":["Row","Column","RowGroup","ColumnGroup","None"]},"colSpan":{"type":"integer","format":"int32","description":"The colSpan for the table cell."},"rowSpan":{"type":"integer","format":"int32","description":"The rowSpan for the table cell."}}},"DocumentBodyTableProperties":{"type":"object","properties":{"width":{"type":"number","format":"float","description":"The width for the table. The valid values in 'em'."},"height":{"type":"number","format":"float","description":"The height for the table."},"cellSpacing":{"type":"number","format":"float","description":"The cell spacing for the table. The valid values in 'em'."},"cellPadding":{"type":"number","format":"float","description":"The cell padding for the table. The valid values in 'em'."},"borderWidth":{"type":"number","format":"float","description":"The border width for the table. The valid values in 'em'"},"alignment":{"type":"string","description":"The alignment for the table.","enum":["Center","Left","Right"]},"borderStyle":{"type":"string","description":"The border style for the table.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table. The valid values in hex color code representation. For example black color - #000000"},"caption":{"description":"The caption for the table. The valid values in hex color code representation. For example black color - #000000","$ref":"#/definitions/DocumentBodyTableCaptionBlock"}}},"DocumentBodyTableRowBlock":{"type":"object","required":["cells"],"properties":{"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlock"}},"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"}}},"DocumentBodyTableRowBlockProperties":{"type":"object","properties":{"rowType":{"type":"string","description":"The type of the table row.","enum":["Header","Footer","Body"]},"alignment":{"type":"string","description":"The alignment for the table row.","enum":["Center","Left","Right"]},"height":{"type":"number","format":"float","description":"The height for the table row."},"borderStyle":{"type":"string","description":"The border style for the table row.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table row. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table row. For example black color - #000000"}}},"DocumentBodyVideo":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL for the video."},"properties":{"description":"The properties for the video.","$ref":"#/definitions/DocumentBodyVideoProperties"}}},"DocumentBodyVideoProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color for the video. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the video.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation for the video. The valid values in 'em'."}}},"DocumentBodyWithHighlight":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlockWithHighlight"}}}},"DocumentContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the paragraph block.","enum":["Text","Image","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"}}},"DocumentContentBlockWithHighlight":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the paragraph block.","enum":["Text","Image","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"DocumentContentHighlightIndex":{"type":"object","properties":{"startIndex":{"type":"integer","format":"int32","description":"Highlight text start index."},"endIndex":{"type":"integer","format":"int32","description":"Highlight text end index."}}},"DocumentListContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["Text","Image","OrderedList","UnorderedList","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"}}},"DocumentTableContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the table cell. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Text","Image","Video","OrderedList","UnorderedList","Table"]},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if the type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"}}},"DocumentText":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Text."},"marks":{"type":"array","description":"The unique list of marks (whether it is bold and/or underlined etc.) for the text.","uniqueItems":true,"items":{"type":"string","enum":["Bold","Italic","Underline","Strikethrough","Subscript","Superscript"]}},"hyperlink":{"type":"string","description":"The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label//"},"properties":{"description":"The properties for the text.","$ref":"#/definitions/DocumentTextProperties"}}},"DocumentTextProperties":{"type":"object","properties":{"fontSize":{"type":"string","description":"The font size for the text. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"textColor":{"type":"string","description":"The text color for the text. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the text. The valid values in hex color code representation. For example black color - #000000"}}},"DocumentVariationAnswer":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBodyWithHighlight"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentVariationContext":{"type":"object","required":["context","values"],"properties":{"context":{"description":"The knowledge context associated with the variation.","$ref":"#/definitions/KnowledgeContextReference"},"values":{"type":"array","description":"The list of knowledge context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeContextValueReference"}}}},"KnowledgeContextReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge context."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeContextValueReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge context value."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentReference":{"type":"object","required":["id","knowledgeBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document."},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentBody":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentBodyBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Image","Video","OrderedList","UnorderedList","Table"]},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"}}},"DocumentVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentAlternative":{"type":"object","required":["autocomplete","phrase"],"properties":{"phrase":{"type":"string","description":"Alternate phrasing to the document title, having a limit of 500 words."},"autocomplete":{"type":"boolean","description":"Autocomplete enabled for the alternate phrase."}}},"KnowledgeDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"category":{"description":"The reference to category associated with the document.","$ref":"#/definitions/CategoryResponse"},"labels":{"type":"array","description":"The references to labels associated with the document.","items":{"$ref":"#/definitions/LabelResponse"}},"knowledgeBase":{"description":"Knowledge base to which the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"externalId":{"type":"string","description":"The reference to external id associated with the document."},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/DocumentVariation"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentReq":{"type":"object","required":["title"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"categoryId":{"type":"string","description":"The category associated with the document."},"labelIds":{"type":"array","description":"The ids of labels associated with the document.","items":{"type":"string"}},"externalId":{"type":"string","description":"The external id associated with the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersion":{"type":"object","required":["restoreFromVersionId"],"properties":{"id":{"type":"string","description":"Globally unique identifier for the document version.","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"Published date of document version. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"document":{"description":"The document which is versioned.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentResponse"},"restoreFromVersionId":{"type":"string","description":"The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. If not, it publishes the draft changes as a new version of the document."},"versionNumber":{"type":"integer","format":"int32","description":"Version Number of the document.","readOnly":true},"dateExpires":{"type":"string","format":"date-time","description":"Expiry date of document version, applicable only to the 'Archived' version of the document. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"BulkResponse":{"type":"object","properties":{"results":{"type":"array","description":"A list of the results from the bulk operation.","items":{"$ref":"#/definitions/BulkResult"}},"errorCount":{"type":"integer","format":"int32","description":"The number of errors from the bulk operation."},"errorIndexes":{"type":"array","description":"An index of where the errors are in the listing.","items":{"type":"integer","format":"int32"}}}},"DocumentVariationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentVariation"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentVersionVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"documentVersion":{"description":"Reference to the document version to which the variation is associated with.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentVersionVariationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariation"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeConversationContext":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The unique identifier of the conversation."},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Unknown","Callback","Chat","Cobrowse","Email","Message","Screenshare","Video","Voice"]},"queueId":{"type":"string","description":"The unique identifier of the queue used to assign the interaction to the user."},"externalContactId":{"type":"string","description":"The external contact identifier of the end-user participant."}}},"KnowledgeDocumentCopy":{"type":"object","required":["application","documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the document whose content was copied."},"documentVersionId":{"type":"string","description":"The version of the document whose content was copied."},"searchId":{"type":"string","description":"The search that surfaced the document whose content was copied."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"conversationContext":{"description":"Conversation context information, if the document content is copied in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"application":{"description":"The client application in which the document content was copied.","$ref":"#/definitions/KnowledgeSearchClientApplication"}}},"KnowledgeSearchClientApplication":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Application type.","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"deployment":{"description":"Application details when type is MessengerKnowledgeApp or SupportCenter.","$ref":"#/definitions/AddressableEntityRef"},"botFlow":{"description":"Application details when type is BotFlow.","$ref":"#/definitions/AddressableEntityRef"},"assistant":{"description":"Application details when type is Assistant.","$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentPresentation":{"type":"object","required":["application","documents"],"properties":{"documents":{"type":"array","description":"The presented documents","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationReference"}},"searchId":{"type":"string","description":"The search that surfaced the documents that were presented."},"queryType":{"type":"string","description":"The type of the query that surfaced the documents.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"conversationContext":{"description":"Conversation context information if the documents were presented in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"application":{"description":"The client application in which the documents were presented.","$ref":"#/definitions/KnowledgeSearchClientApplication"}}},"KnowledgeDocumentVersionVariationReference":{"type":"object","required":["documentId","documentVariationId","documentVersionId"],"properties":{"documentId":{"type":"string","description":"The ID of the document."},"documentVariationId":{"type":"string","description":"The variation of the document."},"documentVersionId":{"type":"string","description":"The version of the document."}}},"EntityReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"KnowledgeConversationContextResponse":{"type":"object","required":["conversation"],"properties":{"conversation":{"description":"The conversation.","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"The queue used to assign the interaction to the user.","$ref":"#/definitions/AddressableEntityRef"},"externalContact":{"description":"The end-user participant of the conversation.","$ref":"#/definitions/AddressableEntityRef"},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Unknown","Callback","Chat","Cobrowse","Email","Message","Screenshare","Video","Voice"]}}},"KnowledgeDocumentFeedbackResponse":{"type":"object","required":["documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the feedback is given in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContextResponse"},"user":{"description":"The user who created the feedback.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersionReference":{"type":"object","required":["knowledgeBase","versionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document.","readOnly":true},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBaseReference"},"versionId":{"type":"string","description":"The globally unique identifier for the version of the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentFeedback":{"type":"object","required":["application","document","documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the feedback is given in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"userId":{"type":"string","description":"The ID of the user who created the feedback.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentFeedbackResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"DocumentQuery":{"type":"object","required":["clauses","operator"],"properties":{"clauses":{"type":"array","description":"Documents filter clauses/criteria. Limit of 20 clauses.","items":{"$ref":"#/definitions/DocumentQueryClause"}},"operator":{"type":"string","description":"Specifies how the filter clauses will be applied together.","enum":["Or","And"]}}},"DocumentQueryClause":{"type":"object","required":["operator","predicates"],"properties":{"operator":{"type":"string","description":"Specifies how the predicates will be applied together.","enum":["Or","And"]},"predicates":{"type":"array","description":"To apply multiple conditions. Limit of 10 predicates across all clauses.","items":{"$ref":"#/definitions/DocumentQueryPredicate"}}}},"DocumentQueryInterval":{"type":"object","properties":{"field":{"type":"string","description":"Specifies the date field to be used for date and time range.","enum":["dateCreated","dateModified","datePublished"]},"value":{"type":"string","description":"Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}},"DocumentQueryPredicate":{"type":"object","required":["fields","type","values"],"properties":{"fields":{"type":"array","description":"Specifies the document fields to be matched against.","items":{"type":"string","enum":["alternatives","categoryId","categoryName","contextId","contextName","contextValueId","contextValueName","documentId","labelId","labelName","title","variationId","visible","state"]}},"values":{"type":"array","description":"Specifies the values of the fields to be matched against.","items":{"type":"string"}},"type":{"type":"string","description":"Specifies the matching criteria between the fields and values.","enum":["Equals","NotEquals","Contains","MatchAll","MatchAny"]}}},"KnowledgeExportJobDocumentsFilter":{"type":"object","properties":{"interval":{"type":"string","description":"Retrieves the documents modified in specified date and time range. Cannot be used together with entities filter. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"entities":{"type":"array","description":"Retrieves the documents with the given ids. Cannot be used together with internal filter.","items":{"$ref":"#/definitions/Entity"},"maxItems":100,"minItems":1}}},"KnowledgeExportJobFilter":{"type":"object","required":["versionFilter"],"properties":{"documentsFilter":{"description":"Filters for narrowing down which documents to export.","$ref":"#/definitions/KnowledgeExportJobDocumentsFilter"},"versionFilter":{"type":"string","description":"Specifies what version should be exported.","enum":["All","Latest"]}}},"KnowledgeExportJobResponse":{"type":"object","required":["fileType"],"properties":{"id":{"type":"string","description":"Id of the export job."},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the export file, when available."},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"jsonFileVersion":{"type":"integer","format":"int32","description":"Requested version of the exported json file."},"countDocumentProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed."},"exportFilter":{"description":"Filters to narrow down what to export.","$ref":"#/definitions/KnowledgeExportJobFilter"},"status":{"type":"string","description":"The status of the export job.","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"knowledgeBase":{"description":"Knowledge base which document export belongs to.","$ref":"#/definitions/KnowledgeBase"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"errorInformation":{"description":"Any error information, or null of the processing is not in failed state.","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeExportJobRequest":{"type":"object","required":["exportFilter","fileType"],"properties":{"exportFilter":{"description":"What to export.","$ref":"#/definitions/KnowledgeExportJobFilter"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"jsonFileVersion":{"type":"integer","format":"int32","description":"Requested version of the exported json file. Available versions are 2 and 3, default is 2"}}},"KnowledgeImportJobError":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}},"limit":{"$ref":"#/definitions/Limit"},"documentIndex":{"type":"integer","format":"int32","description":"Index of the faulty document."}}},"KnowledgeImportJobReport":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors occurred during processing import.","items":{"$ref":"#/definitions/KnowledgeImportJobError"}},"statistics":{"description":"Statistics related to the import job.","$ref":"#/definitions/KnowledgeImportJobStatistics"}}},"KnowledgeImportJobResponse":{"type":"object","required":["fileType","uploadKey"],"properties":{"id":{"type":"string","description":"Id of the import job","readOnly":true},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the imported file."},"failedEntitiesURL":{"type":"string","description":"The URL of the location at which the caller can download the entities in json format that failed during the import."},"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"settings":{"description":"Additional optional settings","$ref":"#/definitions/KnowledgeImportJobSettings"},"status":{"type":"string","description":"Status of the import job","readOnly":true,"enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the import job","readOnly":true,"$ref":"#/definitions/KnowledgeImportJobReport"},"knowledgeBase":{"description":"Knowledge base which document import does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"createdBy":{"description":"The user who created the operation","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"skipConfirmationStep":{"type":"boolean","description":"If enabled pre-validation step will be skipped."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeImportJobSettings":{"type":"object","properties":{"importAsNew":{"type":"boolean","description":"If enabled import creates a new document even if update is available."},"visible":{"type":"boolean","description":"If specified, import will override the visibility of the imported documents."},"categoryId":{"type":"string","description":"If specified, import will override the category of the imported documents."},"labelIds":{"type":"array","description":"If specified, import will add this labels to the imported documents.","items":{"type":"string"}}}},"KnowledgeImportJobStatistics":{"type":"object","properties":{"countDocumentImportActivityCreate":{"type":"integer","format":"int32","description":"Number of documents will be created by the import."},"countDocumentImportActivityUpdate":{"type":"integer","format":"int32","description":"Number of documents will be updated by the import."},"countDocumentStateDraft":{"type":"integer","format":"int32","description":"Number of documents will be imported as draft."},"countDocumentStatePublished":{"type":"integer","format":"int32","description":"Number of documents will be imported as published."},"countDocumentValidationSuccess":{"type":"integer","format":"int32","description":"Number of documents that validated successfully for import."},"countDocumentValidationFailure":{"type":"integer","format":"int32","description":"Number of documents that failed validation for import."},"countDocumentImportSuccess":{"type":"integer","format":"int32","description":"Number of imported documents."},"countDocumentImportFailure":{"type":"integer","format":"int32","description":"Number of documents failed to import."},"countCategoryValidationSuccess":{"type":"integer","format":"int32","description":"Number of categories that validated successfully for import."},"countCategoryValidationFailure":{"type":"integer","format":"int32","description":"Number of categories that failed validation for import."},"countCategoryImportSuccess":{"type":"integer","format":"int32","description":"Number of imported categories."},"countCategoryImportFailure":{"type":"integer","format":"int32","description":"Number of categories failed to import."},"countLabelValidationSuccess":{"type":"integer","format":"int32","description":"Number of labels that validated successfully for import."},"countLabelValidationFailure":{"type":"integer","format":"int32","description":"Number of labels that failed validation for import."},"countLabelImportSuccess":{"type":"integer","format":"int32","description":"Number of imported labels."},"countLabelImportFailure":{"type":"integer","format":"int32","description":"Number of labels failed to import."},"migrationDetected":{"type":"boolean","description":"Shows whether the import treated as migration or not."}}},"KnowledgeImportJobRequest":{"type":"object","required":["fileType","uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"settings":{"description":"Additional optional settings","$ref":"#/definitions/KnowledgeImportJobSettings"},"skipConfirmationStep":{"type":"boolean","description":"If enabled pre-validation step will be skipped."}}},"KnowledgeDocumentSearch":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"results":{"type":"array","description":"Documents matching the search query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentSearchResult"}},"application":{"description":"The client application details from which search happened.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the search is initiated in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContextResponse"},"confidenceThreshold":{"type":"number","format":"float","description":"The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold."}}},"KnowledgeDocumentSearchResult":{"type":"object","properties":{"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query."},"document":{"description":"Document that matched the query.","$ref":"#/definitions/KnowledgeSearchDocumentResponse"}}},"KnowledgeSearchDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"category":{"description":"The reference to category associated with the document.","$ref":"#/definitions/CategoryResponse"},"labels":{"type":"array","description":"The references to labels associated with the document.","items":{"$ref":"#/definitions/LabelResponse"}},"knowledgeBase":{"description":"Knowledge base to which the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"externalId":{"type":"string","description":"The reference to external id associated with the document."},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/DocumentVariationAnswer"}},"answer":{"type":"string","description":"The answer to the query."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentSearchRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the search results would also include draft documents."},"interval":{"description":"Retrieves the documents created/modified/published in specified date and time range.","$ref":"#/definitions/DocumentQueryInterval"},"filter":{"description":"Filter for the document search.","$ref":"#/definitions/DocumentQuery"},"sortOrder":{"type":"string","description":"The sort order for search results.","enum":["Asc","Desc"]},"sortBy":{"type":"string","description":"The field in the documents that you want to sort the search results by.","enum":["ConfidenceScore","DateCreated","DateModified","CategoryName","LabelName"]},"application":{"description":"The client application details from which search request was sent.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the search is initiated in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"confidenceThreshold":{"type":"number","format":"float","description":"The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1."},"answerHighlightTopResults":{"type":"integer","format":"int32","description":"The number of articles to be sent for answer-highlighting. Can range from 1-5.","minimum":1,"maximum":5}}},"SearchUpdateRequest":{"type":"object","required":["answered"],"properties":{"sessionId":{"type":"string","description":"The unique identifier of this session","readOnly":true},"answered":{"type":"boolean","description":"Mark the search as answered/unanswered"},"selectedAnswer":{"description":"The selected search result chosen as the answer.","$ref":"#/definitions/SelectedAnswer"}}},"SelectedAnswer":{"type":"object","required":["document"],"properties":{"document":{"description":"The search result document chosen as the answer.","$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentSuggestion":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"results":{"type":"array","description":"Documents matching to the autocomplete suggestions query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentSuggestionResult"}}}},"KnowledgeDocumentSuggestionResult":{"type":"object","properties":{"matchedPhrase":{"type":"string","description":"Matched phrase to the autocomplete suggestions query."},"document":{"$ref":"#/definitions/KnowledgeDocumentSuggestionResultDocument"}}},"KnowledgeDocumentSuggestionResultDocument":{"type":"object","required":["id","knowledgeBase","title"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document."},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"title":{"type":"string","description":"The title of the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentSuggestionRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the suggestion results would also include draft documents."},"interval":{"description":"Retrieves the documents created/modified/published in specified date and time range.","$ref":"#/definitions/DocumentQueryInterval"},"filter":{"description":"Filter for the document suggestions.","$ref":"#/definitions/DocumentQuery"}}},"KnowledgeDocumentView":{"type":"object","required":["application","documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the viewed document."},"documentVersionId":{"type":"string","description":"The version of the viewed document."},"searchId":{"type":"string","description":"The search that surfaced the viewed document."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"application":{"description":"The client application from which the document was viewed.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"sessionId":{"type":"string","description":"The unique identifier of the knowledge session in which the document was viewed."},"conversationContext":{"description":"Conversation context information if the document was viewed in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"}}},"AdditionalLanguagesIntent":{"type":"object","properties":{"id":{"type":"string","description":"ID of the intent for respective additional language","readOnly":true},"utterances":{"type":"array","description":"Utterances list for additional language","items":{"$ref":"#/definitions/NluUtterance"}}}},"AdditionalLanguagesSynonyms":{"type":"object","properties":{"synonyms":{"type":"array","description":"Synonyms for additional language","readOnly":true,"items":{"type":"string"}}}},"IntentDefinition":{"type":"object","required":["name","utterances"],"properties":{"id":{"type":"string","description":"ID of the intent.","readOnly":true},"name":{"type":"string","description":"The name of the intent."},"entityTypeBindings":{"type":"array","description":"The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities","items":{"$ref":"#/definitions/NamedEntityTypeBinding"}},"entityNameReferences":{"type":"array","description":"The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings","readOnly":true,"items":{"type":"string"}},"utterances":{"type":"array","description":"The utterances that act as training phrases for the intent.","items":{"$ref":"#/definitions/NluUtterance"}},"additionalLanguages":{"type":"object","description":"Additional languages for intents","additionalProperties":{"$ref":"#/definitions/AdditionalLanguagesIntent"}}}},"NamedEntityAnnotation":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the annotated named entity."}}},"NamedEntityDefinition":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the entity."},"type":{"type":"string","description":"The name of the entity type."}}},"NamedEntityTypeBinding":{"type":"object","required":["entityName","entityType"],"properties":{"entityType":{"type":"string","description":"The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."},"entityName":{"type":"string","description":"The name that this named entity type is bound to."}}},"NamedEntityTypeDefinition":{"type":"object","required":["mechanism","name"],"properties":{"name":{"type":"string","description":"The name of the entity type."},"description":{"type":"string","description":"Description of the of the named entity type."},"mechanism":{"description":"The mechanism enabling detection of the named entity type.","$ref":"#/definitions/NamedEntityTypeMechanism"}}},"NamedEntityTypeItem":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"A value for an named entity type definition."},"synonyms":{"type":"array","description":"Synonyms for the given named entity value.","items":{"type":"string"}},"additionalLanguages":{"type":"object","description":"Additional Language Synonyms for the given named entity value.","additionalProperties":{"$ref":"#/definitions/AdditionalLanguagesSynonyms"}}}},"NamedEntityTypeMechanism":{"type":"object","required":["items","type"],"properties":{"items":{"type":"array","description":"The items that define the named entity type.","items":{"$ref":"#/definitions/NamedEntityTypeItem"}},"restricted":{"type":"boolean","description":"Whether the named entity type is restricted to the items provided. Default: false"},"type":{"type":"string","description":"The type of the mechanism.","enum":["DynamicList","List","Regex","Unknown"]}}},"NluDomain":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the NLU domain."},"language":{"type":"string","description":"The language culture of the NLU domain, e.g. `en-us`, `de-de`."},"draftVersion":{"description":"The draft version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"lastPublishedVersion":{"description":"The last published version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"engineVersion":{"type":"string","description":"The version of the NLU engine to use."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluDomainVersion":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"domain":{"description":"The NLU domain of the version.","readOnly":true,"$ref":"#/definitions/NluDomain"},"description":{"type":"string","description":"The description of the NLU domain version."},"language":{"type":"string","description":"The language that the NLU domain version supports."},"published":{"type":"boolean","description":"Whether this NLU domain version has been published.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trainingStatus":{"type":"string","description":"The training status of the NLU domain version.","readOnly":true,"enum":["Untrained","Training","Trained","Error","Unknown"]},"evaluationStatus":{"type":"string","description":"The evaluation status of the NLU domain version.","readOnly":true,"enum":["Unevaluated","Evaluating","Evaluated","Error"]},"intents":{"type":"array","description":"The intents defined for this NLU domain version.","items":{"$ref":"#/definitions/IntentDefinition"}},"entityTypes":{"type":"array","description":"The entity types defined for this NLU domain version.","items":{"$ref":"#/definitions/NamedEntityTypeDefinition"}},"entities":{"type":"array","description":"The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings","items":{"$ref":"#/definitions/NamedEntityDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluUtterance":{"type":"object","required":["segments"],"properties":{"id":{"type":"string","description":"ID of the utterance.","readOnly":true},"segments":{"type":"array","description":"The list of segments that that constitute this utterance for the given intent.","items":{"$ref":"#/definitions/NluUtteranceSegment"}}}},"NluUtteranceSegment":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the segment."},"entity":{"description":"The entity annotation of the segment.","$ref":"#/definitions/NamedEntityAnnotation"}}},"NluDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DetectedNamedEntity":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected named entity.","readOnly":true},"entityType":{"type":"string","description":"The type of the detected named entity.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected named entity.","readOnly":true},"value":{"description":"The value of the detected named entity.","readOnly":true,"$ref":"#/definitions/DetectedNamedEntityValue"}}},"DetectedNamedEntityValue":{"type":"object","properties":{"raw":{"type":"string","description":"The raw value of the detected named entity.","readOnly":true},"resolved":{"type":"string","description":"The resolved value of the detected named entity.","readOnly":true},"unit":{"type":"string","description":"The unit of the detected amount of money entity, e.g. EUR, USD.","readOnly":true,"allowEmptyValue":true}}},"IntentFeedback":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}},"assessment":{"type":"string","description":"The assessment on the detection for feedback text.","enum":["Incorrect","Correct","Unknown","Disabled"]}}},"NluFeedbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"version":{"description":"The domain version of the feedback.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"language":{"type":"string","description":"The language of the version to which feedback is linked, e.g. en-us, de-de"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluFeedbackRequest":{"type":"object","required":["intents","text","versionId"],"properties":{"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"versionId":{"type":"string","description":"The domain version ID of the feedback."},"language":{"type":"string","description":"The language of the version to which feedback is linked, e.g. en-us, de-de"}}},"NluFeedbackListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluFeedbackResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Draft":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Draft name"},"miner":{"description":"Miner to which the draft belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"intents":{"type":"array","description":"Draft intent object.","readOnly":true,"items":{"$ref":"#/definitions/DraftIntents"}},"topics":{"type":"array","description":"Draft topic object.","readOnly":true,"items":{"$ref":"#/definitions/DraftTopics"}},"dateCreated":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the draft was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the draft was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftIntents":{"type":"object","required":["id","name","utterances"],"properties":{"id":{"type":"string","description":"Id for an intent."},"name":{"type":"string","description":"Name/Label for an intent."},"utterances":{"type":"array","description":"The utterances that are extracted for an Intent.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftTopics":{"type":"object","required":["id","phrases"],"properties":{"id":{"type":"string","description":"Id for a topic."},"name":{"type":"string","description":"Topic name."},"miner":{"description":"The miner to which the topic belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"conversationCount":{"type":"integer","format":"int32","description":"Number of conversations where a topic has occurred.","readOnly":true},"conversationPercent":{"type":"number","format":"float","description":"Percentage of conversations where a topic has occurred.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of unique utterances where a topic has occurred.","readOnly":true},"phraseCount":{"type":"integer","format":"int32","description":"Number of unique phrases (sub-utterances) where a topic has occurred.","readOnly":true},"phrases":{"type":"array","description":"The phrases that are extracted for a topic.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Miner":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Chat Corpus Name."},"language":{"type":"string","description":"Language Localization code.","enum":["en-us","en-gb","en-au","en-in","en-za","es-us","es-es","fr-fr","fr-ca","de-de","pt-pt","pt-br","nl-nl","it-it"]},"minerType":{"type":"string","description":"Type of the miner, intent or topic.","enum":["Intent","Topic"]},"dateCreated":{"type":"string","format":"date-time","example":"2020-04-29T17:12:06.613","description":"Date when the miner was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Status of the miner.","readOnly":true,"enum":["NotStarted","FetchingConversationIds","ConversationIdsFetched","ConversationIdsFetchError","FetchingConversations","ConversationsFetched","ConversationsFetchError","Queued","QueuingError","MiningStarted","MaskingUtterances","MaskingError","ComputingAnalytics","ComputingAnalyticsError","MiningCompleted","MiningError","ModelValidationError","Deleted"]},"conversationsDateRangeStart":{"type":"string","format":"date","example":"2019-06-20","description":"Date from which the conversations need to be taken for mining. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"conversationsDateRangeEnd":{"type":"string","format":"date","example":"2019-12-20","description":"Date till which the conversations need to be taken for mining. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the mining process was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"message":{"type":"string","description":"Mining message if present.","readOnly":true},"errorInfo":{"description":"Error Information","readOnly":true,"$ref":"#/definitions/MinerErrorInfo"},"warningInfo":{"description":"Warning Information","readOnly":true,"$ref":"#/definitions/MinerErrorInfo"},"conversationDataUploaded":{"type":"boolean","description":"Flag to indicate whether data file to be mined was uploaded.","readOnly":true},"mediaType":{"type":"string","description":"Media type for filtering conversations.","readOnly":true,"enum":["Chat","Call","Message","Email"]},"participantType":{"type":"string","description":"Type of the participant, either agent, customer or both.","readOnly":true,"enum":["Customer","Agent","Both"]},"queueIds":{"type":"array","description":"List of queue IDs for filtering conversations.","readOnly":true,"items":{"type":"string"}},"dateTriggered":{"type":"string","format":"date-time","example":"2020-04-30T23:56:07.268","description":"Date when the miner started execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","example":"2020-04-30T23:56:07.268","description":"Date when the miner was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"latestDraftVersion":{"description":"Latest draft details of the miner.","readOnly":true,"$ref":"#/definitions/Draft"},"conversationsFetchedCount":{"type":"integer","format":"int32","description":"Number of conversations/transcripts fetched.","readOnly":true},"conversationsValidCount":{"type":"integer","format":"int32","description":"Number of conversations/recordings/transcripts that were found valid for mining purposes.","readOnly":true},"getminedItemCount":{"type":"integer","format":"int32","description":"Number of intents or topics based on the miner type.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MinerErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"messageWithParams":{"type":"string","description":"Error message with params included."},"messageParams":{"type":"object","description":"Map of variables and params for the error message.","additionalProperties":{"type":"object"}}}},"DraftRequest":{"type":"object","properties":{"intents":{"type":"array","description":"Draft intent object.","items":{"$ref":"#/definitions/DraftIntents"}},"topics":{"type":"array","description":"Draft topic object.","items":{"$ref":"#/definitions/DraftTopicRequest"}}}},"DraftTopicRequest":{"type":"object","required":["id","name","phrases"],"properties":{"id":{"type":"string","description":"Id for a topic."},"name":{"type":"string","description":"Name/Label for a topic."},"phrases":{"type":"array","description":"The phrases that are extracted for a topic.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Draft"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerIntent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","example":"pay bill.","description":"Intent name."},"miner":{"description":"The miner to which the intent belongs.","$ref":"#/definitions/Miner"},"utterances":{"type":"array","description":"The utterances that are extracted for an Intent.","items":{"$ref":"#/definitions/Utterance"}},"analyticVolumePercent":{"type":"number","format":"double","example":21.5,"description":"Percentage of conversations belonging to the intent."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Utterance":{"type":"object","properties":{"utteranceText":{"type":"string","example":"I want to pay bill.","description":"Utterance text"}}},"MinedIntentsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MinerIntent"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerExecuteRequest":{"type":"object","properties":{"dateStart":{"type":"string","format":"date","example":"2020-04-01","description":"Start date for the date range to mine. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","example":"2020-04-01","description":"End date for the date range to mine. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"uploadKey":{"type":"string","example":"intent-miner/raw-utterances/imports/org_id/request_id.mine_id.json","description":"Location of input conversations."},"mediaType":{"type":"string","description":"Media type for filtering conversations.","enum":["Chat","Call","Message","Email"]},"participantType":{"type":"string","description":"Type of the participant, either agent, customer or both.","enum":["Customer","Agent","Both"]},"queueIds":{"type":"array","example":"[ \"7fe8a4ce-7435-4c78-a83f-47c3943e53eb\", \"18c744bf-34d5-452a-b6d6-9af95628aa50\"]","description":"List of queue IDs for filtering conversations.","items":{"type":"string"}}}},"MinerListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Miner"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Topic name."},"miner":{"description":"The miner to which the topic belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"conversationCount":{"type":"integer","format":"int32","description":"Number of conversations where a topic has occurred.","readOnly":true},"conversationPercent":{"type":"number","format":"float","description":"Percentage of conversations where a topic has occurred.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of unique utterances where a topic has occurred.","readOnly":true},"phraseCount":{"type":"integer","format":"int32","description":"Number of unique phrases (sub-utterances) where a topic has occurred.","readOnly":true},"phrases":{"type":"array","description":"Phrases associated with a topic.","items":{"$ref":"#/definitions/TopicPhrase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicPhrase":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"utteranceCount":{"type":"integer","format":"int32"}}},"MinerTopicsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MinerTopic"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerTopicPhrase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Phrase name."},"topic":{"description":"Topic associated with a phrase.","$ref":"#/definitions/MinerTopic"},"utterances":{"type":"array","description":"List of utterances related to a phrase.","items":{"$ref":"#/definitions/Utterance"}},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances belonging to a phrase"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluConfusionMatrixColumn":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the intent for the column."},"value":{"type":"number","format":"float","description":"The confusion value between the intents"}}},"NluConfusionMatrixRow":{"type":"object","required":["columns","name"],"properties":{"name":{"type":"string","description":"The name of the intent for the row."},"columns":{"type":"array","description":"The columns of confusion matrix for the intent","items":{"$ref":"#/definitions/NluConfusionMatrixColumn"}}}},"NluDomainVersionQualityReport":{"type":"object","required":["confusionMatrix","summary","version"],"properties":{"version":{"description":"The domain and version details of the quality report","$ref":"#/definitions/NluDomainVersion"},"confusionMatrix":{"type":"array","description":"The confusion matrix for the Domain Version","items":{"$ref":"#/definitions/NluConfusionMatrixRow"}},"summary":{"description":"The quality report summary for the Domain Version","$ref":"#/definitions/NluQualityReportSummary"}}},"NluQualityReportSummary":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"array","description":"The list of metrics in the summary","items":{"$ref":"#/definitions/NluQualityReportSummaryMetric"}}}},"NluQualityReportSummaryMetric":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the metric. e.g. recall, f1_score"},"value":{"type":"number","format":"float","description":"The value of the metric"}}},"NluDomainVersionTrainingResponse":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating result of the action.","readOnly":true},"version":{"$ref":"#/definitions/NluDomainVersion"}}},"DetectedDialogAct":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected dialog act.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected dialog act.","readOnly":true}}},"DetectedIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}}}},"NluDetectionInput":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text to perform NLU detection on."},"language":{"type":"string","description":"Language of the version for multilingual detection, e.g. `en-us`, `de-de`"}}},"NluDetectionOutput":{"type":"object","properties":{"intents":{"type":"array","description":"The detected intents.","readOnly":true,"items":{"$ref":"#/definitions/DetectedIntent"}},"dialogActs":{"type":"array","description":"The detected dialog acts.","readOnly":true,"items":{"$ref":"#/definitions/DetectedDialogAct"}}}},"NluDetectionResponse":{"type":"object","properties":{"version":{"description":"The NLU domain version which performed the detection.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"output":{"$ref":"#/definitions/NluDetectionOutput"},"input":{"$ref":"#/definitions/NluDetectionInput"}}},"ContextEntity":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity."}}},"ContextIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the intent."}}},"NluDetectionContext":{"type":"object","properties":{"intent":{"description":"Restrict detection to this intent.","$ref":"#/definitions/ContextIntent"},"entity":{"description":"Use this entity to restrict detection.","$ref":"#/definitions/ContextEntity"}}},"NluDetectionRequest":{"type":"object","required":["input"],"properties":{"input":{"description":"The input subject to NLU detection.","$ref":"#/definitions/NluDetectionInput"},"context":{"description":"The context for the input to NLU detection.","$ref":"#/definitions/NluDetectionContext"}}},"NluDomainVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomainVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddressableLicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"permissions":{"$ref":"#/definitions/Permissions"},"prerequisites":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AddressableLicenseDefinition"}},"comprises":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Permissions":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"List of permission ids.","items":{"type":"string"}}}},"LicenseOrgToggle":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean"}}},"LicenseUpdateStatus":{"type":"object","properties":{"userId":{"type":"string"},"licenseId":{"type":"string"},"result":{"type":"string"}}},"LicenseAssignmentRequest":{"type":"object","required":["licenseId","userIdsAdd","userIdsRemove"],"properties":{"licenseId":{"type":"string","description":"The id of the license to assign/unassign."},"userIdsAdd":{"type":"array","description":"The ids of users to assign this license to.","uniqueItems":true,"items":{"type":"string"}},"userIdsRemove":{"type":"array","description":"The ids of users to unassign this license from.","uniqueItems":true,"items":{"type":"string"}}}},"LicenseBatchAssignmentRequest":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"The list of license assignment updates to make.","items":{"$ref":"#/definitions/LicenseAssignmentRequest"}}}},"LicenseUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicenses":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicensesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserLicenses"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ApprovalNamespace":{"type":"object","properties":{"namespace":{"type":"string","description":"The namespace of the associated approvers.","readOnly":true,"enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"status":{"type":"string","description":"The current namespace approval status.","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"type":{"type":"string","description":"The type of namespace approval.","readOnly":true,"enum":["Primary","Secondary","System"]}}},"LimitChangeRequestDetails":{"type":"object","required":["description","key","namespace","requestedValue","supportCaseUrl"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"key":{"type":"string","description":"Limit key to be overridden (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)"},"namespace":{"type":"string","description":"Namespace the key belongs to (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)","enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"requestedValue":{"type":"number","format":"double","description":"Requested limit value for a given key"},"description":{"type":"string","description":"Description of the need for the limit change request"},"supportCaseUrl":{"type":"string","description":"The support case url created by Care"},"status":{"type":"string","description":"Current status of the limit change request","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"currentValue":{"type":"number","format":"double","description":"Current limit value for a given key","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date of the limit change request creation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"statusHistory":{"type":"array","description":"List of statuses that a limit change request has gone through","readOnly":true,"items":{"$ref":"#/definitions/StatusChange"}},"dateCompleted":{"type":"string","format":"date-time","description":"The date of the limit change request completion (ChangeImplemented, Rejected, or RollbackImplemented. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"rejectReason":{"type":"string","description":"The reason for rejecting the limit override request","readOnly":true,"enum":["AlternativeExists","IncreaseNotRequired","PlatformMisuse","PlatformStability","OtherReason"]},"approvalNamespaces":{"type":"array","description":"The approval breakdown for this override request.","readOnly":true,"items":{"$ref":"#/definitions/ApprovalNamespace"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StatusChange":{"type":"object","properties":{"dateStatusChanged":{"type":"string","format":"date-time","description":"The date of this status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status the change request transitioned to","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"previousStatus":{"type":"string","description":"The status the change request transitioned from","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"namespace":{"type":"string","description":"The namespace for the status change","readOnly":true,"enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"message":{"type":"string","description":"A short message describing the status change","readOnly":true},"rejectReason":{"type":"string","description":"The reason for rejecting the limit override request","readOnly":true,"enum":["AlternativeExists","IncreaseNotRequired","PlatformMisuse","PlatformStability","OtherReason"]}}},"LimitChangeRequestsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LimitChangeRequestDetails"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"LimitDocs":{"type":"object","properties":{"key":{"type":"string"},"defaultValue":{"type":"integer","format":"int64"},"description":{"type":"string"},"resource":{"type":"string"},"configurable":{"type":"boolean"},"trackable":{"type":"boolean"}}},"LimitDocumentation":{"type":"object","properties":{"url":{"type":"string"},"namespaces":{"type":"array","items":{"$ref":"#/definitions/NamespaceDocs"}}}},"NamespaceDocs":{"type":"object","properties":{"friendlyName":{"type":"string"},"limits":{"type":"array","items":{"$ref":"#/definitions/LimitDocs"}}}},"FreeTrialLimit":{"type":"object","properties":{"key":{"type":"string"},"defaultValue":{"type":"integer","format":"int64"},"description":{"type":"string"},"resource":{"type":"string"}}},"FreeTrialLimitDocs":{"type":"object","properties":{"namespaces":{"type":"array","items":{"$ref":"#/definitions/FreeTrialNamespace"}}}},"FreeTrialNamespace":{"type":"object","properties":{"friendlyName":{"type":"string"},"limits":{"type":"array","items":{"$ref":"#/definitions/FreeTrialLimit"}}}},"PagedNamespaceListing":{"type":"object"},"LimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Limit"}}}},"LogCaptureDownloadExecutionResponse":{"type":"object","required":["dateStart","fileUrl","id","state","user"],"properties":{"id":{"type":"string","description":"Id of file download job."},"state":{"type":"string","description":"Execution state of the download.","readOnly":true,"enum":["Running","Failed","Succeeded"]},"dateStart":{"type":"string","format":"date-time","description":"Start date of file download execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"fileUrl":{"type":"string","description":"Url of a file with query result.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user that created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LogCaptureQueryRequest":{"type":"object","required":["interval","userId"],"properties":{"interval":{"type":"string","description":"Date and time range to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userId":{"type":"string","description":"Id of the user to query."},"sortOrder":{"type":"string","description":"Order of results. Default order is ASC.","enum":["ASC","DESC"]}}},"LogCaptureQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LogEntry"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"LogEntry":{"type":"object","properties":{"level":{"type":"string","description":"Level of log entry"},"message":{"type":"string","description":"Log message"},"timestamp":{"type":"integer","format":"int64","description":"Timestamp of log entry"}}},"PagelessEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AddressableEntity"}},"selfUri":{"type":"string","format":"uri"}}},"LogCaptureUserConfiguration":{"type":"object","required":["dateExpired"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"Indicates when log capture will be turned off for the user. (Must be within 24 hours). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ButtonComponent":{"type":"object","properties":{"title":{"type":"string","description":"Text to show inside the button."},"actions":{"description":"The button actions (Deprecated).","$ref":"#/definitions/ContentActions"}},"description":"Structured template button object."},"ContentActions":{"type":"object","properties":{"url":{"type":"string","description":"A URL of a web page to direct the user to."},"urlTarget":{"type":"string","description":"The target window in which to open the URL. If empty will open a blank page or tab."},"textback":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The textback and title are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"ContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, a LINE sticker ID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."}},"description":"Attachment object."},"ContentCard":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"defaultAction":{"description":"The default button action.","$ref":"#/definitions/ContentCardAction"},"actions":{"type":"array","description":"An array of action objects.","items":{"$ref":"#/definitions/ContentCardAction"}}},"description":"Card content object."},"ContentCardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."},"url":{"type":"string","description":"A URL of a web page to direct the user to."}},"description":"A card action that a user can take."},"ContentCarousel":{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","description":"An array of card objects.","items":{"$ref":"#/definitions/ContentCard"}}},"description":"Carousel content object."},"ContentGeneric":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"actions":{"description":"Actions to be taken (Deprecated).","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Deprecated, should use Card."},"ContentList":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID assigned to this rich message content."},"listType":{"type":"string","description":"The type of list this instance represents.","enum":["Selection","Vertical"]},"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"submitLabel":{"type":"string","description":"Label for Submit button."},"actions":{"description":"The list actions (Deprecated).","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ListItemComponent"}}},"description":"List content object."},"ContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"URL of the Location."},"address":{"type":"string","description":"Location postal address."},"text":{"type":"string","description":"Location name."},"latitude":{"type":"number","format":"double","description":"Latitude of the location."},"longitude":{"type":"number","format":"double","description":"Longitude of the location."}},"description":"Location object."},"ContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The messaging provider template ID. For WhatsApp, 'namespace@name'."},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/NotificationTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/NotificationTemplateBody"},"footer":{"description":"The template footer.","$ref":"#/definitions/NotificationTemplateFooter"}},"description":"Template notification object."},"ContentPostback":{"type":"object","required":["payload"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response."},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Postback response object representing the click of a rich media button (Deprecated)."},"ContentQuickReply":{"type":"object","required":["payload","text"],"properties":{"id":{"type":"string","description":"A unique ID assigned to the quick reply (Deprecated)."},"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object."},"ContentQuickReplyV2":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show as the title of the quick reply."},"actions":{"type":"array","description":"An array of quick reply objects.","items":{"$ref":"#/definitions/ContentQuickReply"}}},"description":"Quick reply object V2."},"ContentReaction":{"type":"object","required":["count","reactionType"],"properties":{"reactionType":{"type":"string","description":"Type of reaction.","enum":["Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care"]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to the message."}},"description":"User reaction to public message."},"ContentStory":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"An ephemeral story."},"ContentText":{"type":"object","required":["body"],"properties":{"type":{"type":"string","description":"Type of text content.","enum":["Text"]},"body":{"type":"string","description":"Text to be shown for this content element."}},"description":"Message content element containing text only."},"ListItemComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this list item."},"rmid":{"type":"string","description":"An ID of the rich message instance."},"type":{"type":"string","description":"The type of list item to render.","enum":["ListItem","ListItemBig"]},"image":{"type":"string","description":"URL of an image."},"title":{"type":"string","description":"The main headline of the list item."},"description":{"type":"string","description":"Text to show in the list item description."},"actions":{"description":"The list item actions (Deprecated).","$ref":"#/definitions/ContentActions"}},"description":"An entry in a List template."},"MessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention","ButtonResponse","Story","Card","Carousel","Text","QuickReplyV2"]},"location":{"description":"Location content.","$ref":"#/definitions/ContentLocation"},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ContentAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/ContentQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ContentButtonResponse"},"generic":{"description":"Generic content (Deprecated).","$ref":"#/definitions/ContentGeneric"},"list":{"description":"List content (Deprecated).","$ref":"#/definitions/ContentList"},"template":{"description":"Template notification content.","$ref":"#/definitions/ContentNotificationTemplate"},"reactions":{"type":"array","description":"A set of reactions to a message.","items":{"$ref":"#/definitions/ContentReaction"}},"mention":{"description":"Mention content.","$ref":"#/definitions/MessagingRecipient"},"postback":{"description":"Structured message postback (Deprecated).","$ref":"#/definitions/ContentPostback"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/ContentStory"},"card":{"description":"Card content","$ref":"#/definitions/ContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ContentCarousel"},"text":{"description":"Text content.","$ref":"#/definitions/ContentText"},"quickReplyV2":{"description":"Quick reply V2 content.","$ref":"#/definitions/ContentQuickReplyV2"}},"description":"Message content element. If contentType = \"Attachment\" only one item is allowed."},"MessagingRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","items":{"$ref":"#/definitions/RecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to or received from."},"NotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored."},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template body object."},"NotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored."}},"description":"Template footer object."},"NotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored."},"media":{"description":"Media template header image.","$ref":"#/definitions/ContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template header object."},"NotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name."},"text":{"type":"string","description":"Parameter text value."}},"description":"Template parameters for placeholders in template."},"RecipientAdditionalIdentifier":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the Identifier","readOnly":true,"enum":["Deployment","Subject"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"Verifier":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Indicates whether this verifier is enabled."},"default":{"type":"boolean","description":"Indicates whether this is the default verifier."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VerifierEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Verifier"}},"selfUri":{"type":"string","format":"uri"}}},"UpdateVerifierRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the verifier."},"enabled":{"type":"boolean","description":"Indicates whether this verifier will be enabled."},"default":{"type":"boolean","description":"Indicates whether this will be the default verifier."}}},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp","audiohook","open-messaging","api"]},"region":{"type":"string"}}},"IpAddressRangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IpAddressRange"}}}},"ActionEventRequest":{"type":"object","required":["actionId","actionState","sessionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"sessionId":{"type":"string","description":"UUID of the customer session for this action."},"actionId":{"type":"string","description":"UUID for the action, as returned by the Ping endpoint when the action was qualified."},"actionState":{"type":"string","description":"State the action is transitioning to.","enum":["accepted","rejected","timedout","errored","ignored","qualified","offered","started","engaged","qualifiedOutsideSchedule","offeredOutsideSchedule","abandoned","completed","frequencyCapReached"]},"errorCode":{"type":"string","description":"Client defined error code (when state transitions to errored)"},"errorMessage":{"type":"string","description":"Message of the error returned when the action fails (when state transitions to errored)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AppEventResponse":{"type":"object","required":["app","attributes","createdDate","customerId","customerIdType","device","eventName","id","screenName","session","traits"],"properties":{"id":{"type":"string","description":"System-generated UUID for the event."},"customerId":{"type":"string","description":"Identifier of the customer in the source of the event."},"customerIdType":{"type":"string","description":"Type of identifier for the customer ID (cookie, email etc.)."},"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered)."},"screenName":{"type":"string","description":"The name of the screen in the app that the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"session":{"description":"The app session the event belongs to.","$ref":"#/definitions/AppEventResponseSession"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events (e.g. email, name, phone).","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AppEventResponseSession":{"type":"object","required":["createdDate","durationInSeconds","eventCount","id","screenviewCount"],"properties":{"id":{"type":"string","description":"ID of the app session."},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the customer has been in the app within this session."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events recorded during this session."},"screenviewCount":{"type":"integer","format":"int32","description":"The count of all screen views recorded during this session."},"referrer":{"description":"The referrer of the first event in the app session.","$ref":"#/definitions/Referrer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp of the session's first event, that is when the session starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AppEventRequest":{"type":"object","required":["app","createdDate","customerCookieId","device","eventName","screenName"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered."},"screenName":{"type":"string","description":"The name of the screen, view, or fragment in the app where the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/RequestDevice"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"referrerUrl":{"type":"string","description":"The referrer URL of the first event in the app session."},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, lastName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"customerCookieId":{"type":"string","description":"Cookie ID of the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution."},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RequestDevice":{"type":"object","required":["category","osFamily","osVersion","type"],"properties":{"category":{"type":"string","description":"Device category.","enum":["desktop","mobile","tablet","other"]},"type":{"type":"string","description":"Device type (e.g. iPad, iPhone, Other)."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"screenHeight":{"type":"integer","format":"int32","description":"Device's screen height."},"screenWidth":{"type":"integer","format":"int32","description":"Device's screen width."},"screenDensity":{"type":"integer","format":"int32","description":"Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual device features."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"DeploymentPing":{"type":"object","properties":{"actions":{"type":"array","description":"Collection of actions to be offered or displayed to the visitor.","items":{"$ref":"#/definitions/DeploymentWebAction"}},"pollIntervalMilliseconds":{"type":"integer","format":"int32","description":"Custom poll interval in milliseconds; when the return value is -1, disable pings."}}},"DeploymentWebAction":{"type":"object","required":["actionMapId","actionMapVersion","id","mediaType","sessionId"],"properties":{"id":{"type":"string","description":"System-generated UUID for the action."},"mediaType":{"type":"string","description":"Action media type used to deliver the action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"customerId":{"type":"string","description":"ID string of the customer that the action was triggered for."},"customerIdType":{"type":"string","description":"Type of the customer ID that the action was triggered for."},"actionMapId":{"type":"string","description":"ID of the action map that triggered the action."},"actionMapVersion":{"type":"integer","format":"int32","description":"Version of the action map that triggered the action."},"sessionId":{"type":"string","description":"ID of the session that the action was triggered for."},"webMessagingOfferProperties":{"description":"Web messaging offer specific properties.","$ref":"#/definitions/WebMessagingOfferProperties"},"contentOfferProperties":{"description":"Content offer specific properties.","$ref":"#/definitions/ContentOffer"},"openActionProperties":{"description":"Open action specific properties.","$ref":"#/definitions/OpenActionProperties"}}},"OpenActionProperties":{"type":"object","properties":{"openActionName":{"type":"string","description":"The specific type of the open action."},"configurationFields":{"type":"object","description":"Custom fields defined in the schema referenced by the open action type selected.","additionalProperties":{"type":"object"}}}},"WebMessagingOfferProperties":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."}}},"KnowledgeGuestDocumentVariationAnswer":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBodyWithHighlight"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentVariationContext":{"type":"object","required":["context","values"],"properties":{"context":{"description":"The knowledge context associated with the variation.","$ref":"#/definitions/AddressableEntityRef"},"values":{"type":"array","description":"The list of knowledge context values associated with the variation.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"KnowledgeGuestDocumentFeedback":{"type":"object","required":["document","documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeGuestDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"KnowledgeGuestDocumentVersionReference":{"type":"object","required":["versionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document.","readOnly":true},"versionId":{"type":"string","description":"The globally unique identifier for the version of the document."}}},"KnowledgeGuestSearchClientApplication":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Application type.","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"deployment":{"description":"Application details when type is MessengerKnowledgeApp or SupportCenter.","$ref":"#/definitions/EntityReference"},"botFlow":{"description":"Application details when type is BotFlow.","$ref":"#/definitions/EntityReference"},"assistant":{"description":"Application details when type is Assistant.","$ref":"#/definitions/EntityReference"}}},"GuestCategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"sessionId":{"type":"string","description":"ID of the guest session.","readOnly":true},"category":{"description":"The reference to category associated with the document.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariation"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeGuestDocumentResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeGuestDocumentView":{"type":"object","required":["documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the viewed document."},"documentVersionId":{"type":"string","description":"The version of the viewed document."},"searchId":{"type":"string","description":"The search that surfaced the viewed document."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]}}},"KnowledgeGuestDocumentCopy":{"type":"object","required":["documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the document whose content was copied."},"documentVersionId":{"type":"string","description":"The version of the document whose content was copied."},"searchId":{"type":"string","description":"The search that surfaced the document whose content was copied."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"application":{"description":"The client application in which the document content was copied.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"KnowledgeGuestDocumentPresentation":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","description":"The presented documents","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationReference"}},"searchId":{"type":"string","description":"The search that surfaced the documents that were presented."},"queryType":{"type":"string","description":"The type of the query that surfaced the documents.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"application":{"description":"The client application in which the documents were presented.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"GuestCategoryResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GuestResponseCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"sessionId":{"type":"string"}}},"GuestResponseCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"externalId":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"parentCategory":{"description":"The reference to category to which this category belongs.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentGuestSearch":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"sessionId":{"type":"string","description":"Session ID of the search.","readOnly":true},"results":{"type":"array","description":"Documents that matched the search query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentGuestSearchResult"}}}},"KnowledgeDocumentGuestSearchResult":{"type":"object","properties":{"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query."},"document":{"description":"Document that matched the query.","$ref":"#/definitions/KnowledgeGuestSearchDocumentResponse"}}},"KnowledgeGuestSearchDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"sessionId":{"type":"string","description":"ID of the guest session.","readOnly":true},"category":{"description":"The reference to category associated with the document.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationAnswer"}},"answer":{"type":"string","description":"The answer to the query."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentGuestSearchRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"sessionId":{"type":"string","description":"Session ID of the search.","readOnly":true},"answerHighlightTopResults":{"type":"integer","format":"int32","description":"The number of articles to be sent for answer-highlighting. Can range from 1-5.","minimum":1,"maximum":5},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the search results would also include draft documents."}}},"KnowledgeGuestDocumentSuggestion":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"sessionId":{"type":"string","description":"Session ID of the guest suggestions.","readOnly":true},"results":{"type":"array","description":"Suggestions matching the query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestionResult"}}}},"KnowledgeGuestDocumentSuggestionResult":{"type":"object","properties":{"matchedPhrase":{"type":"string","description":"Matched phrase to the autocomplete suggestions query."}}},"KnowledgeGuestDocumentSuggestionRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the suggestion results would also include draft documents."}}},"KnowledgeGuestSession":{"type":"object","required":["app","customerId"],"properties":{"id":{"type":"string","description":"Session ID.","readOnly":true},"app":{"description":"The app where the session is started.","$ref":"#/definitions/KnowledgeGuestSessionApp"},"customerId":{"type":"string","description":"An arbitrary ID for the customer starting the session. Used to track multiple sessions started by the same customer."},"pageUrl":{"type":"string","description":"URL of the page where the session is started."},"contexts":{"type":"array","description":"The session contexts.","items":{"$ref":"#/definitions/KnowledgeGuestSessionContext"}}}},"KnowledgeGuestSessionApp":{"type":"object","required":["deploymentId","type"],"properties":{"deploymentId":{"type":"string","description":"App deployment ID."},"type":{"type":"string","description":"App type.","enum":["MessengerKnowledgeApp","SupportCenter"]}}},"KnowledgeGuestSessionContext":{"type":"object","required":["id","values"],"properties":{"id":{"type":"string","description":"The context id associated with the session."},"values":{"type":"array","description":"The list of knowledge context values associated with the session.","items":{"$ref":"#/definitions/Entity"}}}},"DomainEntityListingSurveyForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScorableSurvey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"]},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyForm":{"type":"object","required":["contextId","language","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The survey form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"published":{"type":"boolean","description":"Is this form published"},"disabled":{"type":"boolean","description":"Is this form disabled"},"contextId":{"type":"string","description":"Unique Id for all versions of this form","readOnly":true},"language":{"type":"string","description":"Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"},"header":{"type":"string","description":"Markdown text for the top of the form."},"footer":{"type":"string","description":"Markdown text for the bottom of the form."},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/SurveyQuestionGroup"}},"publishedVersions":{"description":"List of published version of this form","readOnly":true,"$ref":"#/definitions/DomainEntityListingSurveyForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"naEnabled":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."},"explanationPrompt":{"type":"string","description":"Prompt for details explaining the chosen NPS score. Used by NPS questions."}}},"SurveyQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"naEnabled":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"SurveyQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float","description":"Score of all questions in the group"},"maxTotalScore":{"type":"number","format":"float","description":"Maximum possible score of all questions in the group"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"questionScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionScore"}}}},"SurveyQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32","description":"Unweighted score of the question"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"assistedAnswerId":{"type":"string","description":"AnswerId found with evaluation assistance conditions"},"npsScore":{"type":"integer","format":"int32"},"npsTextAnswer":{"type":"string"},"freeTextAnswer":{"type":"string"}}},"SurveyScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"npsScore":{"type":"integer","format":"int32"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionGroupScore"}}}},"DocumentationResult":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int32","description":"The globally unique identifier for the object."},"categories":{"type":"array","description":"The category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"description":{"type":"string","description":"The description of the documentation entity. Will be returned in responses for certain entities."},"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"excerpt":{"type":"string","description":"The excerpt of the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"modified":{"type":"string","format":"date-time","description":"The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"The name of the documentation entity. Will be returned in responses for certain entities."},"service":{"type":"array","description":"The service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"slug":{"type":"string","description":"The slug of the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"get_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."},"facet_feature":{"type":"array","description":"The facet feature of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_role":{"type":"array","description":"The facet role of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_service":{"type":"array","description":"The facet service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"faq_categories":{"type":"array","description":"The faq categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_category":{"type":"array","description":"The releasenote category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_tag":{"type":"array","description":"The releasenote tag of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"service-area":{"type":"array","description":"The service area of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"video_categories":{"type":"array","description":"The video categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}}}},"DocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/DocumentationResult"}}}},"DocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","TERM","TERMS","MATCH_ALL","SIMPLE","QUERY_STRING","MULTI_MATCH"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["title","content"]}}}},"DocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}}}},"JsonNodeSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"GKNDocumentationResult":{"type":"object","required":["_type"],"properties":{"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."}}},"GKNDocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/GKNDocumentationResult"}}}},"GKNDocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["SIMPLE"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["title","content"]}}}},"GKNDocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}}}},"CreateWebChatConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Chat Conversation identifier"},"jwt":{"type":"string","description":"The JWT that you can use to identify subsequent calls on this conversation"},"eventStreamUri":{"type":"string","format":"uri","description":"The URI which provides the conversation event stream."},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"}}},"CreateWebChatConversationRequest":{"type":"object","required":["deploymentId","memberInfo","organizationId","routingTarget"],"properties":{"organizationId":{"type":"string","description":"The organization identifier."},"deploymentId":{"type":"string","description":"The web chat Deployment ID which contains the appropriate settings for this chat conversation."},"routingTarget":{"description":"The routing information to use for the new chat conversation.","$ref":"#/definitions/WebChatRoutingTarget"},"memberInfo":{"description":"The guest member info to use for the new chat conversation.","$ref":"#/definitions/GuestMemberInfo"},"memberAuthToken":{"type":"string","description":"If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource."},"journeyContext":{"description":"A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"}}},"GuestMemberInfo":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","description":"The display name to use for the guest member in the conversation."},"firstName":{"type":"string","description":"The first name to use for the guest member in the conversation."},"lastName":{"type":"string","description":"The last name to use for the guest member in the conversation."},"email":{"type":"string","description":"The email address to use for the guest member in the conversation."},"phoneNumber":{"type":"string","description":"The phone number to use for the guest member in the conversation."},"avatarImageUrl":{"type":"string","format":"uri","description":"The URL to the avatar image to use for the guest member in the conversation, if any."},"customFields":{"type":"object","description":"Any custom fields of information, in key-value format, to attach to the guest member in the conversation.","additionalProperties":{"type":"string"}}}},"WebChatRoutingTarget":{"type":"object","required":["targetAddress","targetType"],"properties":{"targetType":{"type":"string","description":"The target type of the routing target, such as 'QUEUE'.","enum":["QUEUE"]},"targetAddress":{"type":"string","description":"The target of the route, in the format appropriate given the 'targetType'."},"skills":{"type":"array","description":"The list of skill names to use for routing.","items":{"type":"string"}},"language":{"type":"string","description":"The language name to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."}}},"WebDeploymentsRefreshJWTRequest":{"type":"object","required":["deploymentId","refreshToken"],"properties":{"refreshToken":{"type":"string","description":"Refresh token used to issue a new JWT."},"deploymentId":{"type":"string","description":"The WebDeployment ID"}}},"WebDeploymentsAuthorizationResponse":{"type":"object","properties":{"refreshToken":{"type":"string","description":"Refresh token used to issue a new JWT."},"jwt":{"type":"string"}}},"WebDeploymentsJourneyContext":{"type":"object","properties":{"journeyAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"},"customer":{"description":"Journey customer information. Used for linking the authenticated customer with the journey. ","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"Contains the Journey System's customer session details.","$ref":"#/definitions/JourneyCustomerSession"}}},"WebDeploymentsOAuthExchangeRequest":{"type":"object","required":["deploymentId"],"properties":{"deploymentId":{"type":"string","description":"The WebDeployment ID"},"journeyContext":{"description":"A Customer journey context.","$ref":"#/definitions/WebDeploymentsJourneyContext"},"oauth":{"$ref":"#/definitions/WebDeploymentsOAuthRequestParameters"}}},"WebDeploymentsOAuthRequestParameters":{"type":"object","required":["code","redirectUri"],"properties":{"code":{"type":"string","description":"The authorization code to be sent to the authentication server during the token request.\n Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"redirectUri":{"type":"string","description":"Redirect URI sent in the \"Authentication Request\"Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"nonce":{"type":"string","description":"Required if provided in the \"Authentication Request\". Otherwise should be empty.String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token. Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"maxAge":{"type":"integer","format":"int32","description":"Required if provided in the \"Authentication Request\". Otherwise should be empty.Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated.Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"codeVerifier":{"type":"string","description":"Required if authorizing using Proof Key for Code Exchange (PKCE). Otherwise should be empty.Random URL-safe string with a minimum length of 43 characters generated at start of authorization flow to mitigate the threat of having the authorization code intercepted. Refer to https://datatracker.ietf.org/doc/html/rfc7636"},"iss":{"type":"string","description":"Optional parameter. Set it if authorization server discovery metadata authorization_response_iss_parameter_supported is enabled.\nRefer to https://datatracker.ietf.org/doc/html/rfc9207"}}},"AvailableTopic":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"permissionDetails":{"type":"array","description":"Full detailed permissions required to subscribe to the topic","items":{"$ref":"#/definitions/PermissionDetails"}},"requiresPermissions":{"type":"array","description":"Permissions required to subscribe to the topic","items":{"type":"string"}},"requiresDivisionPermissions":{"type":"boolean","description":"True if the subscribing user must belong to the same division as the topic object ID"},"requiresAnyValidator":{"type":"boolean","description":"If multiple permissions are required for this topic, such as both requiresCurrentUser and requiresDivisionPermissions, then true here indicates that meeting any one condition will satisfy the requirements; false indicates all conditions must be met."},"enforced":{"type":"boolean","description":"Whether or not the permissions on this topic are enforced"},"visibility":{"type":"string","description":"Visibility of this topic (Public or Preview)","enum":["Public","Preview"]},"schema":{"type":"object","additionalProperties":{"type":"object"}},"requiresCurrentUser":{"type":"boolean","description":"True if the topic user ID is required to match the subscribing user ID"},"requiresCurrentUserOrPermission":{"type":"boolean","description":"True if permissions are only required when the topic user ID does not match the subscribing user ID"},"transports":{"type":"array","description":"Transports that support events for the topic","items":{"type":"string","enum":["All","Websocket","EventBridge","ProcessAutomation"]}},"publicApiTemplateUriPaths":{"type":"array","items":{"type":"string"}},"topicParameters":{"type":"array","description":"Parameters in the topic name that can be substituted, in the order they appear in the topic name","items":{"type":"string"}}}},"AvailableTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}}}},"PermissionDetails":{"type":"object","properties":{"type":{"type":"string","description":"The type of permission requirement","enum":["requiresCurrentUser","requiresPermissions","requiresDivisionPermissions","requiresAnyDivisionPermissions","requiresUserBeConversationParticipant"]},"permissions":{"type":"array","description":"List of required permissions","items":{"type":"string"}},"allowsCurrentUser":{"type":"boolean","description":"Whether the current user can subscribe, when division permissions are otherwise required"},"enforced":{"type":"boolean","description":"Whether or not this permission requirement is enforced"}}},"Channel":{"type":"object","properties":{"connectUri":{"type":"string","format":"uri"},"id":{"type":"string"},"expires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ChannelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","enum":["Permitted","Rejected"]},"rejectionReason":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChannelTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CustomerInteractionCenter":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GSuite":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GenericSAML":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityNow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CustomProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"]},"ssoBinding":{"type":"string","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST","urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"signAuthnRequests":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityProviderEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IdentityProvider"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthAuthorization":{"type":"object","properties":{"client":{"$ref":"#/definitions/OAuthClient"},"scope":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"resourceOwner":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"pending":{"type":"boolean"},"state":{"type":"string","enum":["Unauthorized","Requested","Authorized","Revoked"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"OAuthClientRequest":{"type":"object","required":["authorizedGrantType","name"],"properties":{"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UsageExecutionResult":{"type":"object","properties":{"executionId":{"type":"string","description":"The id of the query execution"},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved"}}},"ApiUsageClientQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"]},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"]}},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","TemplateUri","HttpMethod"]}}}},"ApiUsageQueryResult":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ApiUsageRow"}},"queryStatus":{"type":"string","description":"Query status","enum":["Complete","Failed","Running"]},"cursors":{"description":"Cursor tokens to be used for navigating paginated results","$ref":"#/definitions/Cursors"}}},"ApiUsageRow":{"type":"object","properties":{"clientId":{"type":"string","description":"Client Id associated with this query result"},"clientName":{"type":"string","description":"Client Name associated with this query result"},"organizationId":{"type":"string","description":"Organization Id associated with this query result"},"userId":{"type":"string","description":"User Id associated with this query result"},"templateUri":{"type":"string","description":"Template Uri associated with this query result"},"httpMethod":{"type":"string","description":"HTTP Method associated with this query result"},"status200":{"type":"integer","format":"int64","description":"Number of requests resulting in a 2xx HTTP status code"},"status300":{"type":"integer","format":"int64","description":"Number of requests resulting in a 3xx HTTP status code"},"status400":{"type":"integer","format":"int64","description":"Number of requests resulting in a 4xx HTTP status code"},"status500":{"type":"integer","format":"int64","description":"Number of requests resulting in a 5xx HTTP status code"},"status429":{"type":"integer","format":"int64","description":"Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400"},"requests":{"type":"integer","format":"int64","description":"Total number of requests"},"date":{"type":"string","format":"date-time","description":"Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OAuthClientEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClientListing"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientListing":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScope":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScopeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthScope"}},"selfUri":{"type":"string","format":"uri"}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PingIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureEngage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"autoProvisionUsers":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"description":{"type":"string","description":"description","readOnly":true}}},"EventDefinitionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventDefinition"}}}},"EmbeddedIntegration":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"IpAddressAuthentication":{"type":"object","properties":{"networkWhitelist":{"type":"array","items":{"type":"string"}}}},"OrgWhitelistSettings":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"OrgAuthSettings":{"type":"object","properties":{"multifactorAuthenticationRequired":{"type":"boolean","description":"Indicates whether multi-factor authentication is required."},"domainAllowlistEnabled":{"type":"boolean","description":"Indicates whether the domain allowlist is enabled."},"domainAllowlist":{"type":"array","description":"The list of domains that will be allowed to embed Genesys Cloud applications.","items":{"type":"string"}},"ipAddressAllowlist":{"type":"array","description":"The list of IP addresses that will be allowed to authenticate with Genesys Cloud.","items":{"type":"string"}},"passwordRequirements":{"description":"The password requirements for the organization.","$ref":"#/definitions/PasswordRequirements"}}},"PasswordRequirements":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"minimumDigits":{"type":"integer","format":"int32"},"minimumLetters":{"type":"integer","format":"int32"},"minimumUpper":{"type":"integer","format":"int32"},"minimumLower":{"type":"integer","format":"int32"},"minimumSpecials":{"type":"integer","format":"int32"},"minimumAgeSeconds":{"type":"integer","format":"int32"},"expirationDays":{"type":"integer","format":"int32"}}},"AuditQueryResponse":{"type":"object"},"Facet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"Filter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"TrusteeAuditQueryRequest":{"type":"object","required":["trusteeOrganizationIds","trusteeUserIds"],"properties":{"trusteeOrganizationIds":{"type":"array","description":"Limit returned audits to these trustee organizationIds.","items":{"type":"string"}},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"TrustEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustee"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trustee":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"usesDefaultRole":{"type":"boolean","description":"Denotes if trustee uses admin role by default."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"trustor":{"description":"The ID of the trustor organization this clone exists in.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents a cloned user in a trustor organization."},"ClonedUserEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClonedUser"}},"selfUri":{"type":"string","format":"uri"}}},"TrustGroup":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"dateCreated":{"type":"string","format":"date-time","description":"The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user that added trusted group.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustRequest":{"type":"object","required":["trustee"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"User who created this request.","readOnly":true,"$ref":"#/definitions/OrgUser"},"dateCreated":{"type":"string","format":"date-time","description":"Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustee":{"description":"Trustee organization who generated this request.","readOnly":true,"$ref":"#/definitions/Organization"},"users":{"type":"array","description":"The list of trustee users that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/OrgUser"}},"groups":{"type":"array","description":"The list of trustee groups that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/TrustGroup"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustRequestCreate":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of trustee users that are requesting access. If no users are specified, at least one group is required.","items":{"type":"string"}},"groupIds":{"type":"array","description":"The list of trustee groups that are requesting access. If no groups are specified, at least one user is required.","items":{"type":"string"}}}},"TrustMemberCreate":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Trustee User or Group Id"},"roleIds":{"type":"array","description":"The list of roles to be granted to this user or group. Roles will be granted in all divisions.","items":{"type":"string"}},"roleDivisions":{"description":"The list of trustor organization roles granting this user or group access paired with the divisions for those roles.","$ref":"#/definitions/RoleDivisionGrants"}}},"TrustGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustUpdate":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrustUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustUserDetails":{"$ref":"#/definitions/TrustUserDetails"}}},"TrustUserDetails":{"type":"object","properties":{"dateCreated":{"type":"string","format":"date-time","description":"Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that added trusted user.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustorAuditQueryRequest":{"type":"object","required":["trusteeUserIds","trustorOrganizationId"],"properties":{"trustorOrganizationId":{"type":"string","description":"Limit returned audits to this trustor organizationId."},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"TrustorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustor"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustCreate":{"type":"object","required":["enabled"],"properties":{"pairingId":{"type":"string","description":"The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship. Not required when creating a default pairing with Customer Care."},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"users":{"type":"array","description":"The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"groups":{"type":"array","description":"The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"intent":{"type":"string","description":"Indicates the media type scope of this estimated wait time","enum":["ALL","CALL","CALLBACK","CHAT","EMAIL","SOCIALEXPRESSION","VIDEOCOMM","MESSAGE"]},"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCE_ABANDON"]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"UcUserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userId":{"type":"string","description":"User ID of the associated Genesys Cloud user."},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"The registered source ID from where the presence was set"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Presence from a given source for a user"},"MutableUserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The user's id"},"name":{"type":"string"},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"Represents the ID of a registered source"},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresence":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","description":"The label used for the system presence in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string"},"deactivated":{"type":"boolean"},"primary":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrganizationPresenceDefinition":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of definition","enum":["System","User"]},"languageLabels":{"type":"object","description":"The label used for the definition in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"divisionId":{"type":"string"},"deactivated":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresenceDefinitionEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"PresenceSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restorePresenceSettings":{"description":"The settings for the restore presence feature","$ref":"#/definitions/RestorePresenceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RestorePresenceSettings":{"type":"object","required":["enabled","restoreOnQueueEnabled","restoreTimeMilliseconds"],"properties":{"enabled":{"type":"boolean","description":"Whether the restore presence feature is enabled"},"restoreTimeMilliseconds":{"type":"integer","format":"int64","description":"How many milliseconds the presence will be restored within"},"restoreOnQueueEnabled":{"type":"boolean","description":"Whether the ON_QUEUE presence will be restored"}}},"Source":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the source"},"description":{"type":"string","description":"The description of the source"},"type":{"type":"string","description":"The type of source","enum":["System","User"]},"deactivated":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Source"}},"selfUri":{"type":"string","format":"uri"}}},"SystemPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserPrimarySource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sourceId":{"type":"string","description":"The id of the source"},"registered":{"type":"boolean","description":"Whether or not the source is registered"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TestMatchesEventOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matchedTriggers":{"type":"array","description":"Triggers that matched","items":{"$ref":"#/definitions/TestModeTrigger"}},"unmatchedTriggers":{"type":"array","description":"Triggers that did not match","items":{"$ref":"#/definitions/TestModeTrigger"}}},"description":"Results from evaluating matching criteria against test input"},"TestModeEventResults":{"type":"object","properties":{"schemaValidation":{"description":"Information about the validation of the schema of the event body passed in to test mode","$ref":"#/definitions/TestSchemaOperation"},"triggerMatchValidation":{"description":"Information about matched and unmatched triggers","$ref":"#/definitions/TestMatchesEventOperation"}},"description":"Information about event test mode execution"},"TestModeTrigger":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the trigger"},"enabled":{"type":"boolean","description":"Whether or not the trigger is enabled"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Basic identifying information about a trigger"},"TestSchemaOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"type":"string"}}},"description":"Information about the Trigger test mode schema validation step"},"TopicCursorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"string"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}},"description":"Cursor listing of Topics."},"JsonNode":{"type":"object"},"MatchCriteria":{"type":"object","properties":{"jsonPath":{"type":"string","description":"The Goessner json path of the field to match"},"operator":{"type":"string","description":"The type of operation to perform for matching check","enum":["GreaterThanOrEqual","LessThanOrEqual","Equal","NotEqual","LessThan","GreaterThan","NotIn","In","Contains","All","Exists","Size"]},"value":{"description":"The value to match on. Only one of value and values can be included","$ref":"#/definitions/JsonNode"},"values":{"type":"array","description":"The list of values to match on. Only one of value and values can be included","items":{"$ref":"#/definitions/JsonNode"}}},"description":"Defines a simple matching condition"},"Trigger":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked"},"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"version":{"type":"integer","format":"int64","description":"Version of this trigger"},"enabled":{"type":"boolean","description":"Whether or not the trigger is enabled"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event","items":{"$ref":"#/definitions/MatchCriteria"}},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a process automation trigger."},"TriggerTarget":{"type":"object","properties":{"type":{"type":"string","description":"The entity type to target","enum":["Workflow"]},"id":{"type":"string","description":"The ID of the entity to target"},"workflowTargetSettings":{"description":"Optional config for the target.","$ref":"#/definitions/WorkflowTargetSettings"}},"description":"The target of a trigger invocation"},"WorkflowTargetSettings":{"type":"object","properties":{"dataFormat":{"type":"string","description":"The data format to use when invoking target.","enum":["Json","TopLevelPrimitives"]}}},"UpdateTriggerRequest":{"type":"object","required":["enabled","name","target","topicName","version"],"properties":{"version":{"type":"integer","format":"int64","description":"Version of this trigger"},"enabled":{"type":"boolean","description":"Boolean indicating if Trigger is enabled"},"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event","items":{"$ref":"#/definitions/MatchCriteria"}},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked. Must match existing trigger topicName."},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."}}},"MatchCriteriaTestResult":{"type":"object","properties":{"jsonPath":{"type":"string","description":"The Goessner json path of the field to match"},"operator":{"type":"string","description":"The type of operation to perform for matching check","enum":["GreaterThanOrEqual","LessThanOrEqual","Equal","NotEqual","LessThan","GreaterThan","NotIn","In","Contains","All","Exists","Size"]},"value":{"description":"The value to match on. Only one of value and values can be included","$ref":"#/definitions/JsonNode"},"values":{"type":"array","description":"The list of values to match on. Only one of value and values can be included","items":{"$ref":"#/definitions/JsonNode"}},"generatedJsonPathCondition":{"type":"string","description":"The generated json path condition"},"match":{"type":"boolean","description":"Did the generated json path condition match"},"jsonPathExtraction":{"type":"array","description":"The json paths and their values that were compared","items":{"$ref":"#/definitions/MatchTestResult"}}},"description":"Results of a matching expression"},"MatchTestResult":{"type":"object","properties":{"value":{"description":"The value of the field being matched","$ref":"#/definitions/JsonNode"},"path":{"type":"string","description":"The json path to the json node being matched on. ex: $['things'][1]"}},"description":"Information about the results being matched by the expressions"},"TestMatchesOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"$ref":"#/definitions/MatchCriteriaTestResult"}}},"description":"Information about the Trigger test mode processing step"},"TestModeResults":{"type":"object","properties":{"schemaValidation":{"description":"Information about the validation of the schema of the event body passed in to test mode","$ref":"#/definitions/TestSchemaOperation"},"targetValidation":{"description":"Information about the validation of the trigger target","$ref":"#/definitions/TestTargetOperation"},"jsonPathValidation":{"description":"Information about the json path matching criteria","$ref":"#/definitions/TestMatchesOperation"},"triggerMatches":{"type":"boolean","description":"Whether the trigger would have matched on the provided event body"}},"description":"Information about trigger test mode execution"},"TestTargetOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"type":"string"}}},"description":"Information about the Trigger test mode target validation step"},"CreateTriggerRequest":{"type":"object","required":["enabled","name","target","topicName"],"properties":{"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"enabled":{"type":"boolean","description":"Boolean indicating if Trigger is enabled"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event. When not provided, all events will fire the trigger","items":{"$ref":"#/definitions/MatchCriteria"}},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked. Cannot be updated after creation. Valid topics can be found at /processautomation/triggers/topics "},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."}}},"TriggerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trigger"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numCriticalEvaluations":{"type":"integer","format":"int32"},"averageCriticalScore":{"type":"number","format":"float"},"highestEvaluationScore":{"type":"number","format":"float"},"lowestEvaluationScore":{"type":"number","format":"float"},"highestCriticalScore":{"type":"number","format":"float"},"lowestCriticalScore":{"type":"number","format":"float"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string","description":"Conversation id of the result"},"recordingId":{"type":"string","description":"Recording id of the result"},"resultUrl":{"type":"string","description":"URL of results... HTTP GET from this location to download results for this item"},"contentType":{"type":"string","description":"Content type of this result"},"errorMsg":{"type":"string","description":"An error message, in case of failed processing will indicate the cause of the failure"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobStatusResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"jobId":{"type":"string","description":"JobId returned when job was initially submitted"},"expectedResultCount":{"type":"integer","format":"int32","description":"Number of results expected when job is completed"},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available"},"errorCount":{"type":"integer","format":"int32","description":"Number of error results produced so far"},"results":{"type":"array","description":"Current set of results for the job","items":{"$ref":"#/definitions/BatchDownloadJobResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmissionResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmission":{"type":"object","required":["batchDownloadRequestList"],"properties":{"batchDownloadRequestList":{"type":"array","description":"List of up to 100 items requested","items":{"$ref":"#/definitions/BatchDownloadRequest"}}}},"BatchDownloadRequest":{"type":"object","properties":{"conversationId":{"type":"string","description":"Conversation id requested"},"recordingId":{"type":"string","description":"Recording id requested, optional. Leave null for all recordings on the conversation"}}},"CalibrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CalibrationCreate":{"type":"object","required":["conversation"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"description":"The conversation to use for the calibration.","$ref":"#/definitions/ConversationReference"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"]},"dateStart":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/QualityAuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"QualityAuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","TrusteeOnlyAudits","ClientId","Action","EntityType","EntityId","ConversationId","ServiceName"]},"value":{"type":"string","description":"Value of the property to filter."}}},"QualityAuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"userTrusteeOrgId":{"type":"string","description":"Trustee Organization Id if this audit message is from trustee access."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIps":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message.","enum":["RecordingService","RecordingPlaybackService","QualityService"]},"level":{"type":"string","description":"The level of this audit message.","enum":["User","System","GENESYS_INTERNAL"]},"status":{"type":"string","description":"The status of the action of this audit message.","enum":["Success","Failure","Warning"]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageInfo":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place.","enum":["Read","Create","Update","Delete","Abandon","Archive","Export","Download","RestoreRequest","RestoreComplete","ApplyProtection","RevokeProtection","UpdateRetention"]},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted.","enum":["Recording","Evaluation","Calibration","Annotation","ScreenRecording","Survey"]},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}}}},"QualityAuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/QualityAuditLogMessage"}}}},"QMAuditQueryRequest":{"type":"object","required":["filters","interval"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"filters":{"type":"array","description":"List of filters for the query.","items":{"$ref":"#/definitions/QualityAuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"ConversationDeletionProtectionQuery":{"type":"object","required":["conversationIds"],"properties":{"conversationIds":{"type":"array","description":"This is a list of ConversationIds. The list cannot exceed 100 conversationids.","items":{"type":"string"}}}},"EvaluationFormResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"weightMode":{"type":"string","description":"Mode for evaluation form weight","enum":["SCALED","OFF"]},"publishedVersions":{"description":"A list of the published versions of this form. Not populated by default, its availability depends on the endpoint. Use the 'expand=publishHistory' query parameter to retrieve this data where applicable (refer to the endpoint description to see if it is applicable).","$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationFormResponse"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"assignee":{"$ref":"#/definitions/User"},"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable."},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"assigned":{"type":"boolean","description":"Set to false to unassign the evaluation. This cannot be set to false when assignee is also set."},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"isScoringIndex":{"type":"boolean"},"authorizedActions":{"type":"array","description":"List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit","items":{"type":"string"}},"hasAssistanceFailed":{"type":"boolean","description":"Is true when evaluation assistance didn't execute successfully"},"evaluationSource":{"description":"The source that created the evaluation.","readOnly":true,"$ref":"#/definitions/EvaluationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateBody":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"evaluationForm":{"description":"Evaluation form used for evaluation (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateEvalForm"},"evaluator":{"description":"User ID of the evaluator (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateUser"},"agent":{"description":"User ID of the agent (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateUser"},"agentHasRead":{"type":"boolean"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"calibration":{"$ref":"#/definitions/EvaluationCreateCalibration"},"evaluationContextId":{"type":"string"},"conversation":{"$ref":"#/definitions/EvaluationCreateConversation"},"resourceType":{"type":"string","enum":["EMAIL"]},"evaluationSource":{"$ref":"#/definitions/EvaluationSource"},"rescore":{"type":"boolean"},"queue":{"$ref":"#/definitions/EvaluationCreateQueue"},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"neverRelease":{"type":"boolean"},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignee":{"$ref":"#/definitions/EvaluationCreateUser"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateCalibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateEvalForm":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDiagnosticInfo":{"type":"object","properties":{"lastActionId":{"type":"integer","format":"int32","description":"The step number of the survey invite flow where the error occurred."}}},"QueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Survey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"]},"queue":{"$ref":"#/definitions/QueueReference"},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"completedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"surveyErrorDetails":{"description":"Additional information about what happened when the survey is in Error status.","$ref":"#/definitions/SurveyErrorDetails"},"agentTeam":{"description":"The team that the agent belongs to","$ref":"#/definitions/Team"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyErrorDetails":{"type":"object","properties":{"flowDiagnosticInfo":{"description":"Additional information about any errors that occurred in the survey invite flow.","$ref":"#/definitions/FlowDiagnosticInfo"},"surveyErrorReason":{"type":"string","description":"An error code indicating the reason for the survey failure."}}},"EvaluationAggregationQueryMe":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]},"contextId":{"type":"string","description":"Evaluation context Id"}}},"EvaluationFormResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationFormResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Annotation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64","description":"Offset of annotation in milliseconds."},"durationMs":{"type":"integer","format":"int64","description":"Duration of annotation in milliseconds."},"absoluteLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses)."},"absoluteDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds)."},"recordingLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"},"recordingDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds), adjusted for any recording cuts."},"user":{"description":"User that created this annotation (if any).","$ref":"#/definitions/User"},"description":{"type":"string","description":"Text of annotation. Maximum character limit is 500."},"reason":{"type":"string","description":"Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue","readOnly":true,"enum":["Hold","SecurePause","FlowOrQueue"]},"annotations":{"type":"array","description":"List of annotations","readOnly":true,"items":{"$ref":"#/definitions/Annotation"}},"realtimeLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ButtonResponse":{"type":"object","properties":{"type":{"type":"string","description":"Button response type that captures Button and QuickReply type responses","enum":["Button","QuickReply"]},"text":{"type":"string","description":"Text to show inside the Button reply. This is also used as the response text after clicking on the Button."},"payload":{"type":"string","description":"Content of the textback payload after clicking a button"},"messageType":{"type":"string","description":"Button response message type that captures QuickReply , Cards and Carousel .This is used as label for Card selection","enum":["QuickReply","Card","Carousel"]}}},"Card":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"url":{"type":"string","description":"URL of an image."},"defaultAction":{"description":"The default action to be taken.","$ref":"#/definitions/CardAction"},"actions":{"type":"array","description":"List of possible action objects.","items":{"$ref":"#/definitions/CardAction"}}}},"CardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Content of the textback payload after clicking a button."},"url":{"type":"string","description":"The location of the image file associated with action."},"isSelected":{"type":"boolean","description":"Indicates if the card option is selected by end customer."}},"description":"A card action that a user can take."},"ChatMessage":{"type":"object","properties":{"body":{"type":"string","description":"The message body"},"id":{"type":"string"},"to":{"type":"string","description":"The message recipient"},"from":{"type":"string","description":"The message sender"},"utc":{"type":"string"},"chat":{"type":"string","description":"The interaction id (if available)"},"message":{"type":"string","description":"The message id"},"type":{"type":"string"},"bodyType":{"type":"string","description":"Type of the message body (v2 chats only)","enum":["STANDARD","ACTIVITY","TYPING","NOTICE","MEMBERJOIN","MEMBERLEAVE","MEDIAREQUEST"]},"senderCommunicationId":{"type":"string","description":"Communication of sender (v2 chats only)"},"participantPurpose":{"type":"string","description":"Participant purpose of sender (v2 chats only)"},"user":{"description":"The user information for the sender (if available)","$ref":"#/definitions/ChatMessageUser"}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"MediaResult":{"type":"object","properties":{"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"MessageMediaAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object.If null then the media type should be dictated by the url.","enum":["image/png","image/jpeg","image/gif"]},"contentLength":{"type":"integer","format":"int64","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The name of the media object."},"id":{"type":"string","description":"A globally unique identifier for the media object."}}},"MessageStickerAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"id":{"type":"string","description":"A globally unique identifier for the media object."}}},"QuickReply":{"type":"object","properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"},"url":{"type":"string","description":"The location of the image file associated with quick reply"},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.","enum":["Message"]},"isSelected":{"type":"boolean","description":"Indicates if the quick reply option is selected by end customer"}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording. Null when there is no playable media."},"endTime":{"type":"string","description":"The end time of the recording. Null when there is no playable media."},"media":{"type":"string","description":"The media type of the recording. This could be audio, chat, messaging, email, or screen."},"mediaSubtype":{"type":"string","description":"The media subtype of the recording.","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string","description":"The media subject of the recording."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"messagingTranscript":{"type":"array","description":"Represents a messaging transcript","items":{"$ref":"#/definitions/RecordingMessagingMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording. Null when there is no playable media.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outputDurationMs":{"type":"integer","format":"int32","description":"Duration of transcoded media in milliseconds"},"outputSizeInBytes":{"type":"integer","format":"int32","description":"Size of transcoded media in bytes. 0 if there is no transcoded media."},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"users":{"type":"array","description":"The users participating in the conversation","items":{"$ref":"#/definitions/User"}},"recordingFileRole":{"type":"string","description":"Role of the file recording. It can be either customer_experience or adhoc.","enum":["CUSTOMER_EXPERIENCE","ADHOC"]},"recordingErrorStatus":{"type":"string","description":"Status of a recording that cannot be returned because of an error","enum":["EMAIL_TRANSCRIPT_TOO_LARGE"]},"originalRecordingStartTime":{"type":"string","format":"date-time","description":"The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingAnnotationFlow":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The flow name"},"id":{"type":"string","description":"The flow Id"}}},"RecordingAnnotationQueue":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The queue name"},"id":{"type":"string","description":"The queue Id"}}},"RecordingContentStory":{"type":"object","properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"Story object."},"RecordingEmailMessage":{"type":"object","properties":{"htmlBody":{"type":"string"},"textBody":{"type":"string"},"id":{"type":"string"},"to":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"$ref":"#/definitions/EmailAddress"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingMessagingMessage":{"type":"object","properties":{"from":{"type":"string","description":"The message sender session id."},"fromUser":{"description":"The user who sent this message.","$ref":"#/definitions/User"},"fromExternalContact":{"description":"The PureCloud external contact sender details.","$ref":"#/definitions/ExternalContact"},"to":{"type":"string","description":"The message recipient."},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"A globally unique identifier for this communication."},"messageText":{"type":"string","description":"The content of this message."},"messageMediaAttachments":{"type":"array","description":"List of media objects attached with this message.","items":{"$ref":"#/definitions/MessageMediaAttachment"}},"messageStickerAttachments":{"type":"array","description":"List of message stickers attached with this message.","items":{"$ref":"#/definitions/MessageStickerAttachment"}},"quickReplies":{"type":"array","description":"List of quick reply options offered with this message.","items":{"$ref":"#/definitions/QuickReply"}},"buttonResponse":{"description":"Button Response selected by user for this message.","$ref":"#/definitions/ButtonResponse"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/RecordingContentStory"},"cards":{"type":"array","description":"List of cards offered for this message","items":{"$ref":"#/definitions/Card"}},"contentType":{"type":"string","description":"Indicates the content type for this message","enum":["QuickReply","Story","Card","Carousel","Attachment","Location","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention","ButtonResponse"]}}},"Endpoint":{"type":"object","required":["name","schema"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"description":"Schema","$ref":"#/definitions/DomainEntityRef"},"enabled":{"type":"boolean"},"site":{"$ref":"#/definitions/DomainEntityRef"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL","SCREEN_RECORDING","PUREENGAGE","PURECONNECT"]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL","SCREEN"]},"mediaSubtype":{"type":"string","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string"},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"orphanStatus":{"type":"string","description":"The status of the orphaned recording's conversation.","enum":["NO_CONVERSATION","UNKNOWN_CONVERSATION","CONVERSATION_NOT_COMPLETE","CONVERSATION_NOT_EVALUATED","EVALUATED"]},"sourceOrphaningId":{"type":"string","description":"An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with"},"region":{"type":"string","enum":["af-south-1","ap-east-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-south-1","ap-southeast-1","ap-southeast-2","ap-southeast-3","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","me-central-1","sa-east-1","us-east-1","us-west-2"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanUpdateRequest":{"type":"object","properties":{"archiveDate":{"type":"string","format":"date-time","description":"The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The orphan recording's delete date. Must be greater than archiveDate and exportDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The orphan recording's export date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"integrationId":{"type":"string","description":"IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set."},"conversationId":{"type":"string","description":"A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media."}}},"OrphanRecordingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishForm":{"type":"object","required":["id","published"],"properties":{"published":{"type":"boolean","description":"Is this form published"},"id":{"type":"string","description":"Unique Id for this version of this form"}}},"SurveyFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording for screen recordings. Null for other types."},"endTime":{"type":"string"},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, email, or message."},"mediaSubtype":{"type":"string","description":"The recording media subtype.","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string","description":"The recording media subject."},"annotations":{"type":"array","description":"Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.","items":{"$ref":"#/definitions/Annotation"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingRetention":{"type":"object","properties":{"conversationId":{"type":"string"},"recordingId":{"type":"string"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingRetentionCursorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingRetention"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"FailedRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJobFailedRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingJobFailedRecording":{"type":"object","properties":{"conversation":{"description":"Conversation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"recording":{"description":"Recording","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJob":{"type":"object","required":["state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The current state of the job.","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"]},"recordingJobsQuery":{"description":"Original query of the job.","readOnly":true,"$ref":"#/definitions/RecordingJobsQuery"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"totalConversations":{"type":"integer","format":"int32","description":"Total number of conversations affected.","readOnly":true},"totalRecordings":{"type":"integer","format":"int32","description":"Total number of recordings affected.","readOnly":true},"totalSkippedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings that have been skipped.","readOnly":true},"totalFailedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings that the bulk job failed to process.","readOnly":true},"totalProcessedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings have been processed.","readOnly":true},"percentProgress":{"type":"integer","format":"int32","description":"Progress in percentage based on the number of recordings","readOnly":true},"errorMessage":{"type":"string","description":"Error occurred during the job execution","readOnly":true},"failedRecordings":{"type":"string","description":"Get IDs of recordings that the bulk job failed for","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJobsQuery":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":"Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date.","enum":["ARCHIVE","DELETE","EXPORT"]},"actionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"actionAge":{"type":"integer","format":"int32","description":"The number of days after each recording's creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings."},"screenRecordingActionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"screenRecordingActionAge":{"type":"integer","format":"int32","description":"The number of days after each screen recording's creation date when the action will be performed. If this is provided then includeScreenRecordings must be true."},"integrationId":{"type":"string","description":"IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action."},"includeRecordingsWithSensitiveData":{"type":"boolean","description":"Whether to include recordings with PCI DSS and/or PII data, default value = false "},"includeScreenRecordings":{"type":"boolean","description":"Whether to include Screen recordings for the action, default value = true "},"clearExport":{"type":"boolean","description":"For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false"},"conversationQuery":{"description":"Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. This result depends on the analytics data lake job completion. See also: https://developer.genesys.cloud/analyticsdatamanagement/analytics/jobs/conversation-details-job#data-availability.This is supported only when querying for conversations up to and including 5 years old.","$ref":"#/definitions/AsyncConversationQuery"},"agedConversationInterval":{"type":"string","description":"As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}},"ExecuteRecordingJobsQuery":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The desired state for the job to be set to.","enum":["PROCESSING"]}}},"RecordingJobEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32","description":"Maximum number of simultaneous screen recording streams"},"maxConfigurableScreenRecordingStreams":{"type":"integer","format":"int32","description":"Upper limit that maxSimultaneousStreams can be configured"},"regionalRecordingStorageEnabled":{"type":"boolean","description":"Store call recordings in the region where they are intended to be recorded, otherwise in the organization's home region"}}},"RecordingUploadReport":{"type":"object","properties":{"id":{"type":"string","description":"The report id."},"name":{"type":"string"},"state":{"type":"string","description":"The current status of the upload report.","enum":["InProgress","Completed","Failed"]},"signedUrl":{"type":"string","description":"For COMPLETED tasks, the signed url to download the report."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingUploadReportRequest":{"type":"object","required":["dateSince"],"properties":{"dateSince":{"type":"string","format":"date-time","description":"Report will include uploads since this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadStatus":{"type":"string","description":"Report will include uploads with this status","enum":["Pending","Success","Failure","WaitForConversation"]}}},"ScreenRecordingMetaData":{"type":"object","properties":{"trackId":{"type":"string"},"mediaId":{"type":"string"},"screenId":{"type":"string"},"originX":{"type":"integer","format":"int32"},"originY":{"type":"integer","format":"int32"},"primary":{"type":"boolean"},"main":{"type":"boolean"}}},"ScreenRecordingMetaDataRequest":{"type":"object","properties":{"participantJid":{"type":"string"},"roomId":{"type":"string"},"metaData":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingMetaData"}}}},"ScreenRecordingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"communicationId":{"type":"string","description":"The id of the communication that is being recorded on the conversation"},"conversation":{"$ref":"#/definitions/Conversation"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScreenRecordingSessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingSession"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScreenRecordingActiveSessions":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Current concurrent active screen recordings count for organization"}}},"ScreenRecordingSessionRequest":{"type":"object","properties":{"state":{"type":"string","description":"The screen recording session's state. Values can be: 'stopped'","enum":["STOPPED"]},"archiveDate":{"type":"string","format":"date-time","description":"The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AcknowledgeScreenRecordingRequest":{"type":"object","properties":{"participantJid":{"type":"string"},"roomId":{"type":"string"},"conversationId":{"type":"string"}}},"SurveyFormAndScoringSet":{"type":"object","properties":{"surveyForm":{"$ref":"#/definitions/SurveyForm"},"answers":{"$ref":"#/definitions/SurveyScoringSet"}}},"AlertNotification":{"type":"object","required":["notificationTypes","recipient"],"properties":{"recipient":{"type":"string","description":"The entity to receive the notification."},"notificationTypes":{"type":"array","description":"The notification types the user will receive.","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}},"locale":{"type":"string","description":"The locale whose language will be used when sending alerts. Locale should be in theformat language_COUNTRY where language is always lower case and country is always upper case."}}},"AlertRuleProperties":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"type":{"type":"string","description":"The type of rule being alerted.","readOnly":true,"enum":["ConversationMetrics","UserPresence","WorkforceManagement","Unknown"]}}},"AlertSummary":{"type":"object","required":["entities","entitiesAreTeamMembers","metricType"],"properties":{"entities":{"type":"array","description":"The entities who violated the rule condition over the duration of the alert.","items":{"$ref":"#/definitions/AlertSummaryEntity"}},"conversation":{"description":"The id of the conversation that triggered the alert. Only used for alerts based on instance-based conversation metrics.","$ref":"#/definitions/AddressableEntityRef"},"metricType":{"type":"string","description":"The metric type that is monitored.","enum":["Interval","Instance"]},"entitiesAreTeamMembers":{"type":"boolean","description":"Flag that indicated whether or not the alert is for a rule with a condition for all members of a team."}}},"AlertSummaryEntity":{"type":"object","required":["alerting","entityType"],"properties":{"entityType":{"type":"string","description":"Specifies the type of entity being evaluated","enum":["User","Group","Queue","Team","TeamMembers"]},"user":{"description":"User id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"group":{"description":"Group id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"Queue id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"team":{"description":"Team id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"alerting":{"type":"boolean","description":"Flag that indicated if the entity is current causing the alert to be triggered"}}},"CommonAlert":{"type":"object","required":["active","conditions","dateMutedUntil","dateSnoozedUntil","dateStart","muted","notifications","rule","snoozed","unread","user","waitBetweenNotificationMs"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user who created the rule that triggered the alert.","$ref":"#/definitions/UserReference"},"rule":{"description":"The properties of the rule that triggered the alert.","$ref":"#/definitions/AlertRuleProperties"},"notifications":{"type":"array","description":"The collection of notification methods and the ids of users who were notified by those methods.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"dateStart":{"type":"string","format":"date-time","description":"The timestamp of when the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The timestamp of when the alert ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean","description":"Indicates if an alert is currently active."},"unread":{"type":"boolean","description":"Indicates if an alert has not been read."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time to wait between notification. Time is in milliseconds."},"muted":{"type":"boolean","description":"Flag indicating if the alert is in a muted state."},"snoozed":{"type":"boolean","description":"Flag indicating if the alert is in a snoozed state."},"dateMutedUntil":{"type":"string","format":"date-time","description":"Timestamp of when the mute status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateSnoozedUntil":{"type":"string","format":"date-time","description":"Timestamp of when the snooze status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conditions":{"description":"The conditions that make up the rule.","$ref":"#/definitions/CommonRuleConditions"},"conversationId":{"type":"string","description":"The id of the conversation instance that caused the alert to trigger."},"alertSummary":{"description":"Summary of the alert status of the entities defined in the conditions. Is set when rule has instance-based or team member based rule predicates","$ref":"#/definitions/AlertSummary"},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonRuleConditions":{"type":"object","required":["predicates","type"],"properties":{"clauses":{"type":"array","description":"The list of predicates groups to be evaluated","items":{"$ref":"#/definitions/CommonRuleConditions"}},"predicates":{"type":"array","description":"The list of rule metric predicates to be evaluated.","items":{"$ref":"#/definitions/CommonRulePredicate"}},"type":{"type":"string","description":"the logic operator performed.","enum":["And","Or","Not"]},"id":{"type":"string","description":"The id."}}},"CommonRulePredicate":{"type":"object","required":["comparisonOperator","entity","metric","metricType","metricValueType","value"],"properties":{"metricType":{"type":"string","description":"The type of metric being evaluated.","enum":["Interval","Instance"]},"metricValueType":{"type":"string","description":"The type of metric value being evaluated.","enum":["Count","Min","Timer","Max","Percentage","Average","Observation"]},"comparisonOperator":{"type":"string","description":"The comparison operator being performed on the metric.","enum":["Gt","Gte","Lt","Lte","Eq","Ne"]},"value":{"type":"number","format":"double","description":"The value the metric will be compared to."},"status":{"type":"string","description":"The status of the entity corresponding to the metric."},"entity":{"description":"The entity whose metric is being represented.","$ref":"#/definitions/CommonRulePredicateEntity"},"mediaType":{"type":"string","description":"The media type of the conversation the metric describes.","enum":["Voice","Chat","Email","Callback","Message"]},"metric":{"type":"string","description":"The metric being evaluated.","enum":["nAbandon","nConnected","nInteractions","nOffered","nOutbound","nTransferred","serviceLevel","oServiceLevel","oWaiting","tAbandon","tAcw","tAlert","tAnswered","tHandle","tHeldComplete","tTalkComplete","tWait","tTalk","tHeld","tOrganizationPresence","tSystemPresence","tAgentRoutingStatus","oUserRoutingStatuses","oUserPresences","oInteracting","tFlowOut","tAdherenceStatus"]}}},"CommonRulePredicateEntity":{"type":"object","required":["entityType"],"properties":{"entityType":{"type":"string","description":"Specifies the type of entity being evaluated","enum":["User","Group","Queue","Team","TeamMembers"]},"user":{"description":"User id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"group":{"description":"Group id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"Queue id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"team":{"description":"Team id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"}}},"AlertRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The action being taken on the alert.","enum":["Mute","Snooze","Unread"]},"dateStart":{"type":"string","format":"date-time","description":"The start date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The end date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"unread":{"description":"The fields need for an unread update requests","$ref":"#/definitions/UnreadFields"},"validRequest":{"type":"boolean"}}},"UnreadFields":{"type":"object","required":["state"],"properties":{"state":{"type":"boolean","description":"The new unread state of the alert"}}},"AlertingUnreadStatus":{"type":"object","required":["unread"],"properties":{"unread":{"type":"boolean","description":"True is alert is unread, false if it has not been."}}},"CommonAlertBulkUpdateRequest":{"type":"object","required":["alertIds","type"],"properties":{"type":{"type":"string","description":"The action to take","enum":["Mute","Snooze","Unread"]},"alertIds":{"type":"array","description":"The user supplied alert ids to be muted","uniqueItems":true,"items":{"type":"string"}},"muteSnooze":{"description":"The fields need for a mute or snooze requests","$ref":"#/definitions/MuteSnoozeFields"},"unread":{"description":"The fields need for an unread update requests","$ref":"#/definitions/UnreadFields"}}},"MuteSnoozeFields":{"type":"object","required":["dateEnd","dateStart"],"properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The end date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AlertListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GetAlertQuery":{"type":"object","required":["queryType","ruleType"],"properties":{"ruleType":{"type":"string","description":"The rule type of the alerts the query will return","enum":["Conversation","Presence","All"]},"queryType":{"type":"string","description":"The type of query being performed.","enum":["Info","Count"]},"alertStatus":{"type":"string","description":"The status of the alerts the query will return.","enum":["Active","Inactive","All"]},"viewedStatus":{"type":"string","description":"The view status of the alerts the query will return.","enum":["Unread","Read","All"]},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The field to sort responses by. The accepted choices are Name and DateStart","enum":["Name","DateStart"]},"sortOrder":{"type":"string","description":"The order in which response will be sorted. The accepted choices are Asc and Desc","enum":["Asc","Desc"]}}},"CommonRule":{"type":"object","required":["name","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"description":{"type":"string","description":"The description of the rule."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"notifications":{"type":"array","description":"The alert notification types to trigger when alarm state changes as well as the users they will be sent to.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"sendExitingAlarmNotifications":{"type":"boolean","description":"Indicates if the alert will send a notification when it is closed."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time in milliseconds to wait between notification."},"conditions":{"description":"The set of metric conditions that would trigger an alert.","$ref":"#/definitions/CommonRuleConditions"},"type":{"type":"string","description":"The type of the rule.","enum":["ConversationMetrics","UserPresence","WorkforceManagement","Unknown"]},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state."},"user":{"description":"The entity that created the rule.","$ref":"#/definitions/UserReference"},"version":{"type":"integer","format":"int32","description":"The current version number of the rule."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the rule when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateLastModified":{"type":"string","format":"date-time","description":"The timestamp of the last update to the rule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ModifiableRuleProperties":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"description":{"type":"string","description":"The description of the rule."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"notifications":{"type":"array","description":"The alert notification types to trigger when alarm state changes as well as the users they will be sent to.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"sendExitingAlarmNotifications":{"type":"boolean","description":"Indicates if the alert will send a notification when it is closed."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time in milliseconds to wait between notification."},"conditions":{"description":"The set of metric conditions that would trigger an alert.","$ref":"#/definitions/CommonRuleConditions"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonRuleBulkUpdateNotificationsRequest":{"type":"object","required":["ruleIds"],"properties":{"ruleIds":{"type":"array","description":"The user supplied rules ids to be updated","uniqueItems":true,"items":{"type":"string"}},"properties":{"description":"The rule properties to be updated","$ref":"#/definitions/ModifiableRuleProperties"},"typesToAdd":{"type":"array","description":"Collection of alerting notification types to add for all entities in the rules","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}},"typesToRemove":{"type":"array","description":"Collection of alerting notification types to remove for all entities in the rules","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}}}},"CommonRuleBulkDeleteRequest":{"type":"object","required":["ruleIds"],"properties":{"ruleIds":{"type":"array","description":"The user supplied rule ids to be deleted","items":{"type":"string"}}}},"CommonRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GetRulesQuery":{"type":"object","required":["queryType","ruleType"],"properties":{"ruleType":{"type":"string","description":"The rule type of the alerts the query will return","enum":["Conversation","Presence","All"]},"queryType":{"type":"string","description":"The type of query being performed.","enum":["Info","Count"]},"enabledType":{"type":"string","description":"The state of the rule the query will return. The accepted choices are Enabled, Disabled, or All","enum":["Enabled","Disabled","All"]},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The field to sort responses by. The accepted choices are Name and DateStart","enum":["Name","DateCreated"]},"sortOrder":{"type":"string","description":"The order in which response will be sorted. The accepted choices are Asc and Desc","enum":["Asc","Desc"]},"ruleName":{"type":"string","description":"The name of the rule being queries."},"nameSearchType":{"type":"string","description":"Specifies how strict the name search needs to be. Expected values are Exact and Contains if querying by name.","enum":["Exact","Contains","Unknown"]}}},"Library":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The library name."},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"createdBy":{"description":"User that created the library.","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"responseType":{"type":"string","description":"This value is deprecated. Responses representing message templates may be added to any library.","enum":["MessagingTemplate","CampaignSmsTemplate","CampaignEmailTemplate","Footer"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LibraryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LibraryBatchRequest":{"type":"object","required":["libraryIds"],"properties":{"libraryIds":{"type":"array","description":"List of Library IDs","items":{"type":"string"}}}},"FooterTemplate":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type represented by Footer.","enum":["Signature"]},"applicableResources":{"type":"array","description":"Specifies the canned response template where the footer can be used.","items":{"type":"string","enum":["Campaign"]}}},"description":"The Footer template identifies the Footer type and its footerUsage"},"MessagingTemplate":{"type":"object","properties":{"whatsApp":{"description":"Defines a messaging template for a WhatsApp messaging channel","$ref":"#/definitions/WhatsAppDefinition"}},"description":"The messaging template identifies a structured message templates supported by a messaging channel."},"Response":{"type":"object","required":["libraries","texts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"libraries":{"type":"array","description":"One or more libraries response is associated with.","items":{"$ref":"#/definitions/DomainEntityRef"}},"texts":{"type":"array","description":"One or more texts associated with the response.","items":{"$ref":"#/definitions/ResponseText"}},"createdBy":{"description":"User that created the response","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"substitutions":{"type":"array","description":"Details about any text substitutions used in the texts for this response.","items":{"$ref":"#/definitions/ResponseSubstitution"}},"substitutionsSchema":{"description":"Metadata about the text substitutions in json schema format.","$ref":"#/definitions/JsonSchemaDocument"},"responseType":{"type":"string","description":"The response type represented by the response.","enum":["MessagingTemplate","CampaignSmsTemplate","CampaignEmailTemplate","Footer"]},"messagingTemplate":{"description":"An optional messaging template definition for responseType.MessagingTemplate.","$ref":"#/definitions/MessagingTemplate"},"assets":{"type":"array","description":"Assets used in the response","items":{"$ref":"#/definitions/AddressableEntityRef"}},"footer":{"description":"Footer template definition for responseType.Footer.","$ref":"#/definitions/FooterTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"ResponseEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"ResponseSubstitution":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Response substitution identifier."},"description":{"type":"string","description":"Response substitution description."},"defaultValue":{"type":"string","description":"Response substitution default value."}},"description":"Contains information about the substitutions associated with a response."},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name","namespace"],"properties":{"name":{"type":"string","description":"The messaging template name."},"namespace":{"type":"string","description":"The messaging template namespace."},"language":{"type":"string","description":"The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US'"}},"description":"A WhatsApp messaging template definition as defined in the WhatsApp Business Manager"},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name', 'libraryId', 'text.contentType', 'messagingTemplate' and 'responseType'"},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"]},"values":{"type":"array","description":"Values to filter on. If name is 'responseType' then allowed values are 'CampaignSmsTemplate', 'CampaignEmailTemplate', 'Footer' and 'Signature'","items":{"type":"string"}}},"description":"Used to filter response queries"},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseFilter"}}},"description":"Used to query for responses"},"ResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"contentLength":{"type":"integer","format":"int64","description":"response asset size in bytes"},"contentLocation":{"type":"string","description":"response asset location."},"contentType":{"type":"string","description":"MIME type of response asset"},"dateCreated":{"type":"string","format":"date-time","description":"Created date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User who created the response asset","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"User who last modified the response asset","$ref":"#/definitions/DomainEntityRef"},"responses":{"type":"array","description":"Canned responses actively using this asset","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseAssetRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"divisionId":{"type":"string","description":"Division to associate to this asset. Can only be used with this division."}}},"ResponseAssetStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"Upload status of the asset","readOnly":true,"enum":["InProgress","Uploaded","Failed"]},"errorCode":{"type":"string","description":"Error code. Used for localization","readOnly":true},"errorMessage":{"type":"string","description":"Error message that explains upload failure status ","readOnly":true}}},"CreateResponseAssetResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"Pre-signed URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"CreateResponseAssetRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"divisionId":{"type":"string","description":"Division to associate to this asset. Can only be used with this division."},"contentMd5":{"type":"string","description":"Content MD-5 of the file to upload"}}},"ResponseAssetSearchResults":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/ResponseAsset"}}}},"ResponseAssetFilter":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format"},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format"},"fields":{"type":"array","description":"Field name to search against. Allowed Values: divisionId, name, contentLength, contentType, dateCreated","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"type":{"type":"string","description":"How to apply this search criteria against other criteria. Filter type supported for each field:- name:[STARTS_WITH, TERM], divisionId:[TERM, TERMS], contentLength:[RANGE, GREATER_THAN_EQUAL_TO, LESS_THAN_EQUAL_TO], contentType:[STARTS_WITH, TERM] dateCreated:[DATE_RANGE]","enum":["TERM","TERMS","STARTS_WITH","RANGE","GREATER_THAN_EQUAL_TO","LESS_THAN_EQUAL_TO","DATE_RANGE"]}}},"ResponseAssetSearchRequest":{"type":"object","required":["query"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of results per page. Default: 25, Maximum: 100."},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"query":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseAssetFilter"}}}},"AvailableMediaType":{"type":"object","properties":{"mediaType":{"type":"string","description":"Name of the available media type"},"availableSubTypes":{"type":"array","description":"List of available subtypes for this media type","items":{"type":"string"}}}},"AvailableMediaTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableMediaType"}}}},"ComparisonPeriod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"kpi":{"type":"string","description":"Key Performance Indicator optimised during the comparison period.","readOnly":true},"dateStarted":{"type":"string","format":"date-time","description":"Start date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateEnded":{"type":"string","format":"date-time","description":"End date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"percentageBenefit":{"type":"number","format":"double","description":"The percentage benefit on this queue for the duration of the comparison period","readOnly":true},"kpiResults":{"type":"array","description":"KPI results for each metric","readOnly":true,"items":{"$ref":"#/definitions/KpiResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ComparisonPeriodListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ComparisonPeriod"}},"selfUri":{"type":"string","format":"uri"}}},"KpiResult":{"type":"object","properties":{"kpiTotalOn":{"type":"integer","format":"int64","description":"Absolute metric (in which the KPI is based) total for the interactions handled by predictive routing (GPR was on)","readOnly":true},"kpiTotalOff":{"type":"integer","format":"int64","description":"Absolute metric (in which the KPI is based) total for the interactions not routed by predictive routing (GPR was off)","readOnly":true},"interactionCountOn":{"type":"integer","format":"int64","description":"Total interactions handled by predictive routing (GPR was on)","readOnly":true},"interactionCountOff":{"type":"integer","format":"int64","description":"Total interactions not routed by predictive routing (GPR was off)","readOnly":true},"mediaType":{"type":"string","description":"Media type used for the KPI","readOnly":true,"enum":["voice","email","message"]},"percentageBenefit":{"type":"number","format":"double","description":"The percentage benefit for this media type for the duration of the comparison period","readOnly":true}}},"QueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapUpCodeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"WrapupCodeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"joined":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserQueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateQueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"sourceQueueId":{"type":"string","description":"The id of an existing queue to copy the settings (does not include GPR settings) from when creating a new queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptionSettings":{"type":"object","required":["transcription","transcriptionConfidenceThreshold"],"properties":{"transcription":{"type":"string","description":"Setting to enable/disable transcription capability","enum":["Disabled","EnabledGlobally","EnabledQueueFlow"]},"transcriptionConfidenceThreshold":{"type":"integer","format":"int32","description":"Configure confidence threshold. The possible values are from 1 to 100."},"lowLatencyTranscriptionEnabled":{"type":"boolean","description":"Boolean flag indicating whether low latency transcription via Notification API is enabled"},"contentSearchEnabled":{"type":"boolean","description":"Setting to enable/disable content search"},"pciDssRedactionEnabled":{"type":"boolean","description":"Setting to enable/disable PCI DSS Redaction"},"piiRedactionEnabled":{"type":"boolean","description":"Setting to enable/disable PII Redaction"}}},"ContactCenterSettings":{"type":"object","properties":{"removeSkillsFromBlindTransfer":{"type":"boolean","description":"Strip skills from transfer"}}},"RoutingSettings":{"type":"object","properties":{"resetAgentScoreOnPresenceChange":{"type":"boolean","description":"Reset agent score when agent presence changes from off-queue to on-queue"}}},"RoutingSkill":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the skill."},"dateModified":{"type":"string","format":"date-time","description":"Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UtilizationLabel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LabelUtilizationRequest":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of interactions with this label that an agent can handle at one time."},"interruptingLabelIds":{"type":"array","description":"Defines other labels that can interrupt an interaction with this label.","uniqueItems":true,"items":{"type":"string"}}}},"LabelUtilizationResponse":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of interactions with this label that an agent can handle at one time."},"interruptingLabelIds":{"type":"array","description":"Defines other labels that can interrupt an interaction with this label.","uniqueItems":true,"items":{"type":"string"}},"labelName":{"type":"string","description":"Name of the label this utilization relates to."}}},"MediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type. Values include call, chat, email, callback, and message.","items":{"type":"string"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization"}}},"UtilizationResponse":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}}}},"UtilizationRequest":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}}}},"BenefitAssessment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"queues":{"type":"array","description":"The list of queues that are assessed for Predictive Routing benefit.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}},"kpiAssessments":{"type":"array","description":"A set of key performance indicators applied on the queue to determine suitability of Predictive Routing.","readOnly":true,"items":{"$ref":"#/definitions/KeyPerformanceIndicatorAssessment"}},"state":{"type":"string","description":"State of the benefit assessment.","readOnly":true,"enum":["Created","Finished","Failed"]},"jobId":{"type":"string","description":"The unique identifier of job that created this benefit assessment.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Creation Date of the benefit assessment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Modified Date of the benefit assessment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Check":{"type":"object","properties":{"result":{"type":"string","description":"The result of a check executed. This indicates if the check was successful or not.","readOnly":true,"enum":["Passed","Failed","Unknown","Skipped","Error"]},"type":{"type":"string","description":"The type of check executed.","readOnly":true,"enum":["HandleTimeValue","TransferRateValue","SalesConversionRateValue","SalesAmountValue","RetentionRateValue","ChurnRateValue","InteractionVolume","UserVariance","DataCoverage","ModelQuality"]}}},"KeyPerformanceIndicatorAssessment":{"type":"object","properties":{"kpi":{"type":"string","description":"Name of the key performance indicator assessed.","readOnly":true},"assessmentResult":{"type":"string","description":"The overall result of the assessment for a key performance indicator.","readOnly":true,"enum":["Unknown","NotSupported","High","Low","Error"]},"checks":{"type":"array","description":"Set of checks executed as part of an assessment.","readOnly":true,"items":{"$ref":"#/definitions/Check"}}}},"CreateBenefitAssessmentRequest":{"type":"object","required":["queueIds"],"properties":{"queueIds":{"type":"array","description":"The list of queue ids that are to be assessed for Predictive Routing benefit.","items":{"type":"string"}}}},"AssessmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BenefitAssessment"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"BenefitAssessmentJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"State of the benefit assessment job.","readOnly":true,"enum":["Created","Finished"]},"dateCreated":{"type":"string","format":"date-time","description":"Creation Date of the benefit assessment job. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Modified Date of the benefit assessment job. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateBenefitAssessmentJobRequest":{"type":"object","properties":{"divisionIds":{"type":"array","description":"The list of division ids for routing queues that are to be assessed for Predictive Routing benefit.","items":{"type":"string"}}}},"AssessmentJobListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BenefitAssessmentJob"}},"selfUri":{"type":"string","format":"uri"}}},"RoutingConversationAttributesResponse":{"type":"object","properties":{"priority":{"type":"integer","format":"int32","description":"Current priority value on in-queue conversation. Range:[-25000000, 25000000]"},"skills":{"type":"array","description":"Current routing skills on in-queue conversation","items":{"$ref":"#/definitions/RoutingSkill"}},"language":{"description":"Current language on in-queue conversation","$ref":"#/definitions/Language"},"scoredAgents":{"type":"array","description":"Current scored agents on in-queue conversation","items":{"$ref":"#/definitions/ScoredAgent"}}}},"RequestScoredAgent":{"type":"object","properties":{"id":{"type":"string","description":"Agent's user ID"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"RoutingConversationAttributesRequest":{"type":"object","properties":{"priority":{"type":"integer","format":"int32","description":"Priority for the conversation. Each point of priority is equivalent to one minute of time in queue. Range:[-25000000, 25000000]. To reset, specify 0.","minimum":-25000000,"maximum":25000000},"skillIds":{"type":"array","description":"Skill requirements for the conversation. To remove all skill requirements, specify an empty list, i.e. [].","items":{"type":"string"}},"languageId":{"type":"string","description":"Language requirement for the conversation. To remove the language requirement, specify an empty string, i.e., \"\"."},"requestScoredAgents":{"type":"array","items":{"$ref":"#/definitions/RequestScoredAgent"}}}},"EmailErrorInfo":{"type":"object","properties":{"message":{"type":"string","description":"Error Message","readOnly":true},"code":{"type":"string","description":"Error Code","readOnly":true}}},"ImapSettings":{"type":"object","properties":{"integration":{"description":"The IMAP server integration to use for ingesting emails.","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"Imap Server Status","readOnly":true,"enum":["Active","AwaitingFolders","Error","Inactive","IntegrationDeleted","Unknown"]},"errorInfo":{"description":"Additional Imap Server error information","readOnly":true,"$ref":"#/definitions/EmailErrorInfo"}}},"InboundDomain":{"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"mxRecordStatus":{"type":"string","description":"Mx Record Status","enum":["VALID","INVALID","NOT_AVAILABLE"]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email."},"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"imapSettings":{"description":"The IMAP server integration and settings to use for processing inbound emails.","$ref":"#/definitions/ImapSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MailFromResult":{"type":"object","required":["mailFromDomain"],"properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}},"mailFromDomain":{"type":"string","description":"The custom MAIL FROM domain."}}},"Record":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the record."},"type":{"type":"string","description":"The type of the record. (Example values: MX, TXT, CNAME)"},"value":{"type":"string","description":"The value of the record."}}},"InboundDomainPatchRequest":{"type":"object","properties":{"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"imapSettings":{"description":"The IMAP server integration and settings to use for processing inbound emails.","$ref":"#/definitions/ImapSettings"}}},"VerificationResult":{"type":"object","properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}}}},"TestMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"After the message has been sent, this is the value of the Message-ID email header.","readOnly":true},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message"},"time":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"InboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"OutboundDomain":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"cnameVerificationResult":{"description":"CNAME registration Status","$ref":"#/definitions/VerificationResult"},"dkimVerificationResult":{"description":"DKIM registration Status","$ref":"#/definitions/VerificationResult"},"senderType":{"type":"string","description":"Sender Type","enum":["Unknown","EmailDomain","MockEmailDomain"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DnsRecordEntry":{"type":"object","properties":{"host":{"type":"string","description":"the hostname of the DNS entry"},"recordContents":{"type":"string","description":"the payload of the DNS entry"},"verificationStatus":{"type":"string","description":"the current status of the related verification process","enum":["Pending","Verified","Failed","Unknown"]}}},"EmailOutboundDomainResult":{"type":"object","properties":{"dnsCnameBounceRecord":{"$ref":"#/definitions/DnsRecordEntry"},"dnsTxtSendingRecord":{"$ref":"#/definitions/DnsRecordEntry"},"domainName":{"type":"string"},"senderStatus":{"type":"string","enum":["RequestReceived","ProvisionRequestSentVendor","Provisioned","Error","Deprovisioned"]},"senderType":{"type":"string","enum":["Unknown","EmailDomain","MockEmailDomain"]}}},"OutboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Flow":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"type":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"lockedUser":{"description":"User that has the flow locked.","$ref":"#/definitions/User"},"lockedClient":{"description":"OAuth client that has the flow locked.","$ref":"#/definitions/DomainEntityRef"},"active":{"type":"boolean"},"system":{"type":"boolean"},"deleted":{"type":"boolean"},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"inputSchema":{"type":"object","description":"json schema describing the inputs for the flow"},"outputSchema":{"type":"object","description":"json schema describing the outputs for the flow"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"debugVersion":{"$ref":"#/definitions/FlowVersion"},"publishedBy":{"$ref":"#/definitions/User"},"currentOperation":{"$ref":"#/definitions/Operation"},"nluInfo":{"description":"Information about the natural language understanding configuration for the published version of the flow","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"compatibleFlowTypes":{"type":"array","description":"Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration. Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.","readOnly":true,"items":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The flow version identifier"},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"]},"secure":{"type":"boolean"},"debug":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdByClient":{"$ref":"#/definitions/DomainEntityRef"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"dateCheckedIn":{"type":"integer","format":"int64"},"dateSaved":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"inputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"datePublished":{"type":"string","format":"date-time","description":"The date this version became the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublishedEnd":{"type":"string","format":"date-time","description":"The date this version was no longer the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"nluInfo":{"description":"Information about the natural language understanding configuration for the flow version","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for this version of the flow","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"compatibleFlowTypes":{"type":"array","description":"Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration. Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.","readOnly":true,"items":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Intent":{"type":"object","properties":{"name":{"type":"string"}}},"NluInfo":{"type":"object","properties":{"domain":{"readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"intents":{"type":"array","items":{"$ref":"#/definitions/Intent"}},"engineVersion":{"type":"string"},"nluData":{"$ref":"#/definitions/NluDomainVersion"}}},"Operation":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","CHECKOUT","DEBUG","DELETE","HISTORY","PUBLISH","REVERT","SAVE","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]}}},"Recipient":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this recipient.","$ref":"#/definitions/Flow"},"dateCreated":{"type":"string","format":"date-time","description":"Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this recipient","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that modified this recipient","$ref":"#/definitions/User"},"messengerType":{"type":"string","description":"The messenger type for this recipient","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SupportedLanguage":{"type":"object","properties":{"language":{"type":"string","description":"Architect supported language tag, e.g. en-us, es-us","readOnly":true},"isDefault":{"type":"boolean","description":"Whether or not this language is the default language","readOnly":true}}},"RecipientFlow":{"type":"object","properties":{"id":{"type":"string","description":"The flow identifier"}}},"RecipientRequest":{"type":"object","properties":{"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this recipient.","$ref":"#/definitions/RecipientFlow"}}},"RecipientListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Recipient"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsAddress":{"type":"object","properties":{"id":{"type":"string","description":"The id of this address.","readOnly":true},"name":{"type":"string"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"validated":{"type":"boolean","description":"In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressProvision":{"type":"object","required":["city","countryCode","name","postalCode","region","street"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name associated with this address"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"autoCorrectAddress":{"type":"boolean","description":"This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAddress"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Compliance":{"type":"object","required":["helpSettings","optInSettings","stopSettings"],"properties":{"stopSettings":{"type":"array","description":"List of configurations for 'StopSettings' compliance","items":{"$ref":"#/definitions/StopSettings"}},"optInSettings":{"type":"array","description":"List of configurations for 'OptInSettings' compliance","items":{"$ref":"#/definitions/OptInSettings"}},"helpSettings":{"type":"array","description":"List of configurations for 'HelpSettings' compliance","items":{"$ref":"#/definitions/HelpSettings"}}}},"ComplianceResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Message response"}}},"HelpSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"OptInSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"SmsPhoneNumber":{"type":"object","required":["phoneNumber","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications."},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","readOnly":true,"enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"provisionedThroughPureCloud":{"type":"boolean","description":"Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud"},"phoneNumberStatus":{"type":"string","description":"Status of the provisioned phone number.","enum":["INVALID","ACTIVE","PORTING","PENDING","PENDING_CANCELLATION","INITIATED"]},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","readOnly":true,"items":{"type":"string","enum":["sms","mms","voice"]}},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"dateCreated":{"type":"string","format":"date-time","description":"Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that provisioned this phone number","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that last modified this phone number","$ref":"#/definitions/User"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"purchaseDate":{"type":"string","format":"date-time","description":"Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cancellationDate":{"type":"string","format":"date-time","description":"Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"renewalDate":{"type":"string","format":"date-time","description":"Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoRenewable":{"type":"string","description":"Renewal time period of this phone number, if the phoneNumberType is shortcode.","enum":["Quarterly"]},"addressId":{"description":"The id of an address attached to this phone number.","$ref":"#/definitions/SmsAddress"},"shortCodeBillingType":{"type":"string","description":"BillingType of this phone number, if the phoneNumberType is shortcode.","enum":["Basic","Vanity"]},"provisioningStatus":{"description":"Status of latest asynchronous provisioning action","$ref":"#/definitions/SmsProvisioningStatus"},"country":{"type":"string","description":"Localized country name for the country code this phone number belongs too"},"supportsSms":{"type":"boolean","description":"Set to true if this phone number has the capability to support SMS"},"supportsMms":{"type":"boolean","description":"Set to true if this phone number has the capability to support MMS"},"supportsVoice":{"type":"boolean","description":"Set to true if this phone number has the capability to support voice"},"integration":{"description":"The Genesys Cloud integration this phone number belongs to.","$ref":"#/definitions/DomainEntityRef"},"compliance":{"description":"Compliance configuration for short codes, including help, stop and opt in.","$ref":"#/definitions/Compliance"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsProvisioningStatus":{"type":"object","properties":{"action":{"type":"string","description":"Provisioning action","enum":["Unknown","Create","Update","Delete"]},"state":{"type":"string","description":"Provisioning state","enum":["Running","Completed","Failed"]},"error":{"description":"Any error associated with a Failed state","$ref":"#/definitions/ErrorBody"},"version":{"type":"integer","format":"int64","description":"The phone number version associated with the provisioning action"}}},"StopSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"SMSAvailablePhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAvailablePhoneNumber"}}}},"SmsAvailablePhoneNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234"},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"region":{"type":"string","description":"The region/province/state the phone number is associated with."},"city":{"type":"string","description":"The city the phone number is associated with."},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","items":{"type":"string","enum":["sms","mms","voice"]}},"phoneNumberType":{"type":"string","description":"The type of phone number available for provisioning.","enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"addressRequirement":{"type":"string","description":"The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.","enum":["none","any","local","foreign"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberImport":{"type":"object","required":["countryCode","integrationId","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"integrationId":{"type":"string","description":"The id of the Genesys Cloud integration this phone number belongs to."},"compliance":{"description":"Compliance configuration for short codes, including help, stop and opt in.","$ref":"#/definitions/Compliance"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberProvision":{"type":"object","required":["countryCode","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"name":{"type":"string"},"addressId":{"type":"string","description":"The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsPhoneNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Predictor":{"type":"object","required":["kpi","queues"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"queues":{"type":"array","description":"The queue IDs associated with the predictor.","items":{"$ref":"#/definitions/AddressableEntityRef"}},"kpi":{"type":"string","description":"The KPI that the predictor attempts to maximize/minimize."},"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"state":{"type":"string","description":"The predictor state.","readOnly":true,"enum":["Created","Error","Active"]},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing.","$ref":"#/definitions/PredictorWorkloadBalancing"},"errorCode":{"type":"string","description":"Predictor error code - optional details on why the predictor went into error state.","readOnly":true},"models":{"type":"array","description":"Predictor's models","readOnly":true,"items":{"$ref":"#/definitions/PredictorModelBrief"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PredictorModelBrief":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type of the model.","readOnly":true,"enum":["voice","email","message"]},"dateModified":{"type":"string","format":"date-time","description":"The date the model was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"retrainingErrors":{"type":"array","description":"The model's retraining errors.","readOnly":true,"items":{"$ref":"#/definitions/PredictorModelRetrainingError"}},"state":{"type":"string","description":"The state of the model","readOnly":true,"enum":["Trained","Error","InvalidDataset","Inactive"]}}},"PredictorModelRetrainingError":{"type":"object","required":["dateOfFirstOccurrence","errorCode"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"errorCode":{"type":"string","description":"Error code describing model training failure.","readOnly":true,"enum":["NotEnoughData","ServiceError","UnknownError"]},"dateOfFirstOccurrence":{"type":"string","format":"date-time","description":"Date when the first retraining failure happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PredictorSchedule":{"type":"object","required":["scheduleType"],"properties":{"scheduleType":{"type":"string","description":"The predictor schedule type.","enum":["HourOnHourOff","OngoingValueMonitoring"]},"dateStarted":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor schedule was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PredictorWorkloadBalancing":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Flag to activate and deactivate workload balancing."},"minimumOccupancy":{"type":"integer","format":"int32","description":"Desired minimum occupancy threshold of agents. Must be between 0 and 100."},"maximumOccupancy":{"type":"integer","format":"int32","description":"Desired maximum occupancy threshold of agents. Must be between 0 and 100."}}},"PatchPredictorRequest":{"type":"object","properties":{"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing","$ref":"#/definitions/PredictorWorkloadBalancing"}}},"CreatePredictorRequest":{"type":"object","required":["kpi","queueIds"],"properties":{"queueIds":{"type":"array","description":"The queue IDs associated with the predictor.","items":{"type":"string"}},"kpi":{"type":"string","description":"The KPI that the predictor attempts to maximize/minimize."},"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing","$ref":"#/definitions/PredictorWorkloadBalancing"}}},"PredictorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Predictor"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KeyPerformanceIndicator":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Key Performance Indicator.","readOnly":true},"optimizationType":{"type":"string","description":"The optimization type of the Key Performance Indicator.","readOnly":true,"enum":["Maximization","Minimization"]},"problemType":{"type":"string","description":"The problem type of the Key Performance Indicator.","readOnly":true,"enum":["Classification","Regression"]},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the Key Performance Indicator was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"DateTime indicating when the Key Performance Indicator was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"description":{"type":"string","description":"The description of the Key Performance Indicator.","readOnly":true},"kpiType":{"type":"string","description":"The type of Key Performance Indicator.","readOnly":true,"enum":["SalesConversion","Churn","Retention","SalesValue","HandleTime","NumberOfTransfers"]},"source":{"type":"string","description":"Source of values for Key Performance Indicator.","readOnly":true,"enum":["WrapUpCode","Outcome","None"]},"wrapUpCodeConfig":{"description":"Defines what wrap up codes are mapped to Key Performance Indicator.","readOnly":true,"$ref":"#/definitions/WrapUpCodeConfig"},"outcomeConfig":{"description":"Defines what outcome ids are mapped to Key Performance Indicator.","readOnly":true,"$ref":"#/definitions/OutcomeConfig"},"status":{"type":"string","description":"The status of the Key Performance Indicator.","readOnly":true,"enum":["Enabled","Disabled"]},"kpiGroup":{"type":"string","description":"The group the Key Performance Indicator belongs to.","readOnly":true,"enum":["Standard","Custom"]},"queues":{"type":"array","description":"Queue IDs on which KPI specification is used.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeConfig":{"type":"object","properties":{"values":{"type":"array","description":"A set of valid Outcome UUIDs used to optimize a KPI.","uniqueItems":true,"items":{"type":"string"}}}},"WrapUpCodeConfig":{"type":"object","required":["values"],"properties":{"values":{"type":"array","description":"A set of valid Wrap Up Code UUIDs used to optimize a KPI.","uniqueItems":true,"items":{"type":"string"}}}},"PredictorModelFeature":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of feature.","readOnly":true,"enum":["User","Customer","Other"]},"percentageImportance":{"type":"number","format":"double","description":"The percentage of how important a feature is in the model.","readOnly":true}}},"PredictorModelFeatureListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PredictorModelFeature"}}}},"PredictorModel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"kpi":{"type":"string","description":"The key performance indicator used in the model.","readOnly":true},"queues":{"type":"array","description":"The List of Queues that are assessed for Predictive Routing.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the model was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"DateTime indicating when the model was last trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"mediaType":{"type":"string","description":"The media type of the model.","readOnly":true,"enum":["voice","email","message"]},"features":{"type":"array","items":{"$ref":"#/definitions/PredictorModelFeature"}}}},"PredictorModels":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PredictorModel"}},"predictorModels":{"type":"array","items":{"$ref":"#/definitions/PredictorModel"}}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The queue member's id."},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean"},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"previousUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"}}},"QueueMemberEntityListingV1":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SkillGroupMemberDivisions":{"type":"object","properties":{"addDivisionIds":{"type":"array","items":{"type":"string"}},"removeDivisionIds":{"type":"array","items":{"type":"string"}}}},"SkillGroupMemberDivisionList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Division"}}}},"SkillGroup":{"type":"object","required":["name","skillConditions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Group's filling status","readOnly":true,"enum":["InProgress","Complete"]},"skillConditions":{"type":"array","description":"Conditions for this group","items":{"$ref":"#/definitions/SkillGroupCondition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupCondition":{"type":"object","required":["languageSkillConditions","operation","routingSkillConditions"],"properties":{"routingSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/SkillGroupRoutingCondition"}},"languageSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/SkillGroupLanguageCondition"}},"operation":{"type":"string","description":"Operator that will be applied to the conditions","enum":["And","Not","Or"]}}},"SkillGroupLanguageCondition":{"type":"object","required":["comparator","languageSkill","proficiency"],"properties":{"languageSkill":{"type":"string","example":"English-Written","description":"The language skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the language skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/SkillGroupCondition"}}}},"SkillGroupRoutingCondition":{"type":"object","required":["comparator","proficiency","routingSkill"],"properties":{"routingSkill":{"type":"string","description":"The routing skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the routing skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/SkillGroupCondition"}}}},"SkillGroupMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReferenceWithName"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"SkillGroupWithMemberDivisions":{"type":"object","required":["name","skillConditions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Group's filling status","readOnly":true,"enum":["InProgress","Complete"]},"skillConditions":{"type":"array","description":"Conditions for this group","items":{"$ref":"#/definitions/SkillGroupCondition"}},"memberDivisions":{"type":"array","description":"Member divisions for this skill group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupDefinition":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillGroupDefinition"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"AgentMaxUtilizationResponse":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}},"level":{"type":"string","enum":["Agent","Organization"]}}},"WrapupCodeRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableStarrableDivision"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","description":"The ID of the user that created the wrap-up code."},"modifiedBy":{"type":"string","description":"The ID of the user that modified the wrap-up code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScimConfigResourceType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the resource type.","readOnly":true},"description":{"type":"string","description":"The description of the resource type.","readOnly":true},"schema":{"type":"string","description":"The URI of the primary or base schema for the resource type.","readOnly":true},"schemaExtensions":{"type":"array","description":"The list of schema extensions for the resource type.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceTypeSchemaExtension"}},"endpoint":{"type":"string","description":"The HTTP-addressable endpoint of the resource type. Appears after the base URL.","readOnly":true},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM resource."},"ScimConfigResourceTypeSchemaExtension":{"type":"object","properties":{"schema":{"type":"string","description":"The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether a schema extension is required.","readOnly":true}},"description":"Defines a SCIM resource type's schema extension."},"ScimMetadata":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"lastModified":{"type":"string","format":"date-time","description":"The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true},"location":{"type":"string","format":"uri","description":"The URI of the resource.","readOnly":true},"version":{"type":"string","description":"The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true}},"description":"Defines the SCIM metadata."},"ScimConfigResourceTypesListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceType"}}},"description":"Defines a response for a list of SCIM resource types."},"ScimV2SchemaAttribute":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","readOnly":true},"type":{"type":"string","description":"The data type of the attribute.","readOnly":true,"enum":["string","boolean","decimal","integer","dateTime","reference","complex"]},"subAttributes":{"type":"array","description":"The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"multiValued":{"type":"boolean","description":"Indicates whether an attribute contains multiple values.","readOnly":true},"description":{"type":"string","description":"The description of the attribute.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether an attribute is required.","readOnly":true},"canonicalValues":{"type":"array","description":"The list of standard values that service providers may use. Service providers may ignore unsupported values.","readOnly":true,"items":{"type":"string"}},"caseExact":{"type":"boolean","description":"Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.","readOnly":true},"mutability":{"type":"string","description":"The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".","readOnly":true,"enum":["readWrite","readOnly","immutable","writeOnly"]},"returned":{"type":"string","description":"The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.","readOnly":true,"enum":["always","never","default","request"]},"uniqueness":{"type":"string","description":"The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".","readOnly":true,"enum":["none","server","global"]},"referenceTypes":{"type":"array","description":"The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".","readOnly":true,"items":{"type":"string","enum":["User","Group","external","uri"]}}},"description":"A complex type that defines service provider attributes or subattributes and their qualities."},"ScimV2SchemaDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"name":{"type":"string","description":"The name of the schema.","readOnly":true},"description":{"type":"string","description":"The description of the schema.","readOnly":true},"attributes":{"type":"array","description":"The list of service provider attributes.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM schema."},"ScimV2SchemaListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaDefinition"}}},"description":"Defines the list response for SCIM resource types."},"ScimGroupListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2Group"}}},"description":"Defines a response for a list of SCIM groups."},"ScimV2Group":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"displayName":{"type":"string","description":"The display name of the group.","readOnly":true},"externalId":{"type":"string","description":"The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"members":{"type":"array","description":"The list of members in the group.","items":{"$ref":"#/definitions/ScimV2MemberReference"}},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM group."},"ScimV2MemberReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM group members."},"ScimError":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of schemas for the SCIM error.","readOnly":true,"items":{"type":"string"}},"status":{"type":"string","description":"The HTTP status code returned for the SCIM error.","readOnly":true},"scimType":{"type":"string","description":"The type of SCIM error when httpStatus is a \"400\" error.","readOnly":true,"enum":["invalidFilter","tooMany","uniqueness","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"]},"detail":{"type":"string","description":"The detailed description of the SCIM error.","readOnly":true}},"description":"Defines a SCIM error."},"ScimV2PatchOperation":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"The PATCH operation to perform.","enum":["add","replace","remove"]},"path":{"type":"string","description":"The attribute path that describes the target of the operation. Required for a \"remove\" operation."},"value":{"description":"The value to set in the path.","$ref":"#/definitions/JsonNode"}},"description":"Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimV2PatchRequest":{"type":"object","required":["schemas"],"properties":{"schemas":{"type":"array","description":"The list of schemas used in the PATCH request.","items":{"type":"string"}},"Operations":{"type":"array","description":"The list of operations to perform for the PATCH request.","items":{"$ref":"#/definitions/ScimV2PatchOperation"}}},"description":"Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimServiceProviderConfig":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the service provider's documentation.","readOnly":true},"patch":{"description":"The \"patch\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"filter":{"description":"The \"filter\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigFilterFeature"},"etag":{"description":"The \"etag\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"sort":{"description":"The \"sort\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"bulk":{"description":"The \"bulk\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigBulkFeature"},"changePassword":{"description":"The \"changePassword\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"authenticationSchemes":{"type":"array","description":"The list of supported authentication schemes.","readOnly":true,"items":{"$ref":"#/definitions/ScimServiceProviderConfigAuthenticationScheme"}},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM service provider's configuration."},"ScimServiceProviderConfigAuthenticationScheme":{"type":"object","required":["description","name","type"],"properties":{"name":{"type":"string","description":"The name of the authentication scheme, for example, HTTP Basic.","readOnly":true},"description":{"type":"string","description":"The description of the authentication scheme.","readOnly":true},"specUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's specification.","readOnly":true},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's usage documentation.","readOnly":true},"type":{"type":"string","description":"The type of authentication scheme.","readOnly":true,"enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"]},"primary":{"type":"boolean","description":"Indicates whether this authentication scheme is the primary method of authentication.","readOnly":true}},"description":"Defines an authentication scheme in the SCIM service provider's configuration."},"ScimServiceProviderConfigBulkFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxOperations":{"type":"integer","format":"int32","description":"The maximum number of operations for each bulk request.","readOnly":true},"maxPayloadSize":{"type":"integer","format":"int32","description":"The maximum payload size.","readOnly":true}},"description":"Defines a \"bulk\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigFilterFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxResults":{"type":"integer","format":"int32","description":"The maximum number of results returned from a filtered query.","readOnly":true}},"description":"Defines a \"filter\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigSimpleFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true}},"description":"Defines a request in the SCIM service provider's configuration."},"Manager":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the manager."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the manager's user record.","readOnly":true}},"description":"Defines a SCIM manager."},"ScimEmail":{"type":"object","properties":{"value":{"type":"string","description":"The email address. Is immutable if \"type\" is set to \"other\"."},"type":{"type":"string","description":"The type of email address. \"value\" is immutable if \"type\" is set to \"other\".","enum":["work","other"]},"primary":{"type":"boolean","description":"Indicates whether the email address is the primary email address."}},"description":"Defines a SCIM email address."},"ScimGenesysUserExternalId":{"type":"object","required":["authority","value"],"properties":{"authority":{"type":"string","description":"Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier."},"value":{"type":"string","description":"Identifier of the user in an external system."}},"description":"External Identifiers of user. The external identifier must be unique within the organization and the 'authority'"},"ScimPhoneNumber":{"type":"object","properties":{"value":{"type":"string","description":"The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx."},"type":{"type":"string","description":"The type of phone number.","enum":["work","work2","work3","work4","home","mobile","other","microsoftteams","zoomphone","eightbyeight"]},"primary":{"type":"boolean","description":"Indicates whether the phone number is the primary phone number."}},"description":"Defines a SCIM phone number."},"ScimUserExtensions":{"type":"object","properties":{"routingSkills":{"type":"array","description":"The list of routing skills assigned to a user. Maximum 50 skills.","items":{"$ref":"#/definitions/ScimUserRoutingSkill"}},"routingLanguages":{"type":"array","description":"The list of routing languages assigned to a user. Maximum 50 languages.","items":{"$ref":"#/definitions/ScimUserRoutingLanguage"}},"externalIds":{"type":"array","description":"The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\". ExternalIds are searchable with complex filter query parameter using 'authority' and 'value', e.g., filter=urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds[authority eq \"matchAuthName\" and value eq \"matchingExternalKeyValue\"].","items":{"$ref":"#/definitions/ScimGenesysUserExternalId"}}},"description":"Genesys Cloud user extensions to SCIM RFC."},"ScimUserListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2User"}}},"description":"Defines a response for a list of SCIM users."},"ScimUserRole":{"type":"object","properties":{"value":{"type":"string","description":"The role of the Genesys Cloud user."}},"description":"Defines a user role."},"ScimUserRoutingLanguage":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing language configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."}},"description":"The routing language assigned to a user."},"ScimUserRoutingSkill":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing skill configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."}},"description":"The routing skill assigned to a user."},"ScimV2EnterpriseUser":{"type":"object","properties":{"division":{"type":"string","description":"The division that the user belongs to."},"department":{"type":"string","description":"The department that the user belongs to."},"manager":{"description":"The user's manager.","$ref":"#/definitions/Manager"},"employeeNumber":{"type":"string","description":"The user's employee number."}},"description":"Defines a SCIM enterprise user."},"ScimV2GroupReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM groups."},"ScimV2User":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM user."},"ScimV2CreateUser":{"type":"object","required":["displayName","userName"],"properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"}},"description":"Defines the creation of a SCIM user."},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING","MATCH_ALL","REGEX"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["addresses.email","addresses.voice","addresses.address","addresses.voicemailEnabled","chat.jabberId","department","email","username","siteId","manager.id","hr.employeeId","integration","groups.social.id","groups.official.id","groups.distribution.id","state","id","languages.guid","languages.name","languages.namespace","languages.proficiency","name","primaryContactInfo.voice","primaryContactInfo.sms","primaryContactInfo.email","profileSkills","queueMembership.added","queueMembership.joined","routingSkills.guid","routingSkills.name","routingSkills.namespace","routingSkills.proficiency","title","divisionId","teamId","description","notes","addressFields.city","addressFields.country","addressFields.state","addressFields.street1","addressFields.street2","addressFields.zipcode","addressVerified","emergencyNumber","voicemailId","ownerId","ownerType","deleted","read","callerAddress","callerUser","createdDate","modifiedDate","queueId","wrapupCodeId","body","created","fromUserJid","targetJids"]}}}},"SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","description":"A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.","items":{"type":"string"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/SearchAggregation"}}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SuggestSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"SuggestSearchRequest":{"type":"object","required":["query","types"],"properties":{"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"Suggest query","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"TranscriptConversationDetailSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE"]}}},"TranscriptConversationDetailSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}}}},"ConversationMetrics":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"sentimentScore":{"type":"number","format":"double","description":"The Sentiment Score"},"sentimentTrend":{"type":"number","format":"double","description":"The Sentiment Trend"},"sentimentTrendClass":{"type":"string","description":"The Sentiment Trend Class","enum":["NotCalculated","Declining","SlightlyDeclining","NoChange","SlightlyImproving","Improving"]},"empathyScores":{"type":"array","description":"The Empathy Scores","items":{"$ref":"#/definitions/EmpathyScore"}},"participantMetrics":{"description":"The Participant Metrics","$ref":"#/definitions/ParticipantMetrics"}}},"EmpathyScore":{"type":"object","properties":{"score":{"type":"number","format":"double","description":"Empathy score of the agent involved in the conversation"},"userId":{"type":"string","description":"UserId of the agent involved in the conversation"}}},"ParticipantMetrics":{"type":"object","properties":{"agentDurationPercentage":{"type":"number","format":"double","description":"Percentage of Agent duration in the conversation"},"customerDurationPercentage":{"type":"number","format":"double","description":"Percentage of Customer duration in the conversation"},"silenceDurationPercentage":{"type":"number","format":"double","description":"Percentage of Silence duration in the conversation"},"ivrDurationPercentage":{"type":"number","format":"double","description":"Percentage of IVR duration in the conversation"},"acdDurationPercentage":{"type":"number","format":"double","description":"Percentage of ACD duration in the conversation"},"overtalkDurationPercentage":{"type":"number","format":"double","description":"Percentage of Overtalk duration in the conversation"},"otherDurationPercentage":{"type":"number","format":"double","description":"Percentage of Other events duration in the conversation"},"overtalkCount":{"type":"integer","format":"int32","description":"Number of Overtalks in the conversation"}}},"DictionaryFeedback":{"type":"object","required":["dialect","examplePhrases","term"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"term":{"type":"string","description":"The dictionary term which needs to be added to dictionary feedback system"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"boostValue":{"type":"number","format":"float","description":"A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0"},"source":{"type":"string","description":"The source of the given dictionary feedback","readOnly":true,"enum":["Manual"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of the user who created the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The Id of the user who modified the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"examplePhrases":{"type":"array","description":"A list of at least 3 and up to 20 unique phrases that are example usage of the term","items":{"$ref":"#/definitions/DictionaryFeedbackExamplePhrase"}},"soundsLike":{"type":"array","description":"A list of up to 10 terms that give examples of how the term sounds","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DictionaryFeedbackExamplePhrase":{"type":"object","required":["phrase"],"properties":{"phrase":{"type":"string","description":"The Example Phrase text. At least 3 words and up to 20 words"},"source":{"type":"string","description":"The source of the given Example Phrase","enum":["Manual"]}}},"DictionaryFeedbackEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedDictionaryFeedback"}},"pageSize":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"selfUri":{"type":"string"},"nextUri":{"type":"string"}}},"ListedDictionaryFeedback":{"type":"object","required":["dialect","term"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"term":{"type":"string","description":"The dictionary term which needs to be added to dictionary feedback system"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"boostValue":{"type":"number","format":"float","description":"A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0"},"source":{"type":"string","description":"The source of the given dictionary feedback","readOnly":true,"enum":["Manual"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of the user who created the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The Id of the user who modified the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SentimentFeedback":{"type":"object","required":["dialect","feedbackValue","phrase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phrase":{"type":"string","description":"The phrase for which sentiment feedback is provided"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given phrase, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"feedbackValue":{"type":"string","description":"The sentiment feedback value for the given phrase","enum":["Neutral","Positive","Negative"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when sentiment feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of user who created the sentiment feedback","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SentimentFeedbackEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SentimentFeedback"}}}},"BaseProgramEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EngineIntegration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the transcription engine"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramTranscriptionEngine":{"type":"object","properties":{"engine":{"type":"string","enum":["Genesys","GenesysExtended","TranscriptionConnector"]},"dialects":{"type":"array","items":{"type":"string"}},"engineIntegration":{"$ref":"#/definitions/EngineIntegration"}}},"ProgramTranscriptionEngines":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"program":{"description":"The ID of the program","$ref":"#/definitions/BaseProgramEntity"},"transcriptionEngines":{"type":"array","description":"The program transcription engine settings","items":{"$ref":"#/definitions/ProgramTranscriptionEngine"}},"modifiedBy":{"description":"The user last modified the record","$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The last modified date of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptionEnginesRequest":{"type":"object","required":["transcriptionEngines"],"properties":{"transcriptionEngines":{"type":"array","description":"The transcription engine setting","items":{"$ref":"#/definitions/ProgramTranscriptionEngine"}}}},"SupportedDialectsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SupportedDialectsTranscriptionEngine"}}}},"SupportedDialectsTranscriptionEngine":{"type":"object","properties":{"engine":{"type":"string","enum":["Genesys","GenesysExtended","TranscriptionConnector"]},"dialects":{"type":"array","items":{"type":"string"}},"engineIntegration":{"$ref":"#/definitions/EngineIntegration"}}},"SpeechTextAnalyticsSettingsResponse":{"type":"object","properties":{"defaultProgram":{"description":"Setting to choose name for the default program for topic detection","$ref":"#/definitions/AddressableEntityRef"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}},"textAnalyticsEnabled":{"type":"boolean","description":"Setting to enable/disable text analytics"},"agentEmpathyEnabled":{"type":"boolean","description":"Setting to enable/disable Agent Empathy setting"}}},"SpeechTextAnalyticsSettingsRequest":{"type":"object","properties":{"defaultProgramId":{"type":"string","description":"Setting to choose name for the default program for topic detection"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}},"textAnalyticsEnabled":{"type":"boolean","description":"Setting to enable/disable text analytics"},"agentEmpathyEnabled":{"type":"boolean","description":"Setting to enable/disable Agent Empathy setting"}}},"GeneralProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeneralProgramJobRequest":{"type":"object","required":["dialect"],"properties":{"dialect":{"type":"string","description":"The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]},"mode":{"type":"string","description":"The mode to use for the general program job, default value is Skip","enum":["Skip","Merge","ReplaceMerge"]}}},"GeneralTopic":{"type":"object","properties":{"name":{"type":"string"}}},"GeneralTopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GeneralTopic"}}}},"ProgramMappings":{"type":"object","properties":{"program":{"$ref":"#/definitions/BaseProgramEntity"},"queues":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}},"flows":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ProgramMappingsRequest":{"type":"object","required":["flowIds","queueIds"],"properties":{"queueIds":{"type":"array","description":"The program queues","items":{"type":"string"}},"flowIds":{"type":"array","description":"The program flows","items":{"type":"string"}}}},"ProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramJobRequest":{"type":"object","required":["programIds"],"properties":{"programIds":{"type":"array","description":"The ids of the programs used for this job","items":{"type":"string"}}}},"BaseTopicEntitiy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Program":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The program name"},"description":{"type":"string","description":"The program description"},"topicIds":{"type":"array","description":"The ids of topics associated to the program","items":{"type":"string"}},"tags":{"type":"array","description":"The program tags","items":{"type":"string"}}}},"ProgramsMappingsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ProgramMappings"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ListedProgram":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topicsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedProgram"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TopicJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicJobRequest":{"type":"object","required":["topicIds"],"properties":{"topicIds":{"type":"array","description":"The ids of the topics used for this job","items":{"type":"string"}}}},"Phrase":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The phrase text"},"strictness":{"type":"string","description":"The phrase strictness, default value is null","enum":["1","55","65","72","85","90"]},"sentiment":{"type":"string","description":"The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system.","enum":["Unspecified","Positive","Neutral","Negative"]}}},"Topic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"]},"phrases":{"type":"array","items":{"$ref":"#/definitions/Phrase"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicRequest":{"type":"object","required":["dialect","name"],"properties":{"name":{"type":"string","description":"The topic name"},"description":{"type":"string","description":"The topic description"},"strictness":{"type":"string","description":"The topic strictness, default value is 72","enum":["1","55","65","72","85","90"]},"programIds":{"type":"array","description":"The ids of programs associated to the topic","items":{"type":"string"}},"tags":{"type":"array","description":"The topic tags","items":{"type":"string"}},"dialect":{"type":"string","description":"The topic dialect"},"participants":{"type":"string","description":"The topic participants, default value is All","enum":["External","Internal","All"]},"phrases":{"type":"array","description":"The topic phrases","items":{"$ref":"#/definitions/Phrase"}}}},"ListedTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"]},"programsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"]},"phrasesCount":{"type":"integer","format":"int32"},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedTopic"}},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnifiedGeneralTopic":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["Deprecated","Outdated","Modified","UpToDate","ToBeCreated","CreatedByUser"]}}},"UnifiedGeneralTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnifiedGeneralTopic"}}}},"UnpublishedProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Program"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"JsonSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"TranscriptSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE","RANGE","GREATER_THAN","LESS_THAN"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["transcript.content","language","mediaType","divisionId","communicationId","conversationId","conversationSentimentScore","conversationSentimentTrend","participants.initialDirection","participants.participantPurpose","participants.queueId","participants.userId","topic","transcriptId"]}}}},"TranscriptSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}}}},"TranscriptUrl":{"type":"object","properties":{"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"SegmentUrl":{"type":"object","properties":{"recording":{"description":"The Recording Reference","$ref":"#/definitions/AddressableEntityRef"},"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"TranscriptUrls":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"communicationId":{"type":"string","description":"The Communication ID"},"urls":{"type":"array","description":"List of Transcript URLs","items":{"$ref":"#/definitions/SegmentUrl"}}}},"TeamMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReferenceWithName"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"TeamAddMemberFailure":{"type":"object","properties":{"id":{"type":"string"},"reason":{"type":"string","description":"Specific reason the member could not be added.","readOnly":true,"enum":["UserNotFound","UserGroupLimitExceeded","UserGroupDivisionMismatch"]}}},"TeamMemberAddListingResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}},"failures":{"type":"array","description":"List of any user ids that were not added.","readOnly":true,"items":{"$ref":"#/definitions/TeamAddMemberFailure"}}}},"TeamMembers":{"type":"object","required":["memberIds"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add or remove","items":{"type":"string"}}}},"TeamEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Team"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"TeamsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Team"}}}},"TeamSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TeamSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["description","name"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH"]}}},"TeamSearchRequest":{"type":"object","required":["query"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","description":"Team Search Criteria","items":{"$ref":"#/definitions/TeamSearchCriteria"}}}},"MediaRegions":{"type":"object","properties":{"awsHomeRegion":{"type":"string","description":"The AWS region your organization is in.","readOnly":true},"awsCoreRegions":{"type":"array","description":"The list of AWS regions to which Genesys Cloud is deployed with full functionality including media streaming.","readOnly":true,"items":{"type":"string"}},"awsSatelliteRegions":{"type":"array","description":"The list of AWS regions that Genesys Cloud uses only for media streaming.","readOnly":true,"items":{"type":"string"}}}},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"]},"userId":{"type":"string","description":"The Id of the user currently logged in and associated with the station."},"webRtcUserId":{"type":"string","description":"The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone."},"primaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"secondaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"webRtcMediaDscp":{"type":"integer","format":"int32","description":"The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcPersistentEnabled":{"type":"boolean","description":"The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcForceTurn":{"type":"boolean","description":"Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcCallAppearances":{"type":"integer","format":"int32","description":"The number of call appearances on the station.","readOnly":true},"webRtcRequireMediaHelper":{"type":"boolean","description":"True when the media helper required.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Callheader":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"headers":{"type":"object","description":"parsed SIP headers","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Callmessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"message":{"type":"string","description":"raw SIP message"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubscriberResponse":{"type":"object","required":["status"],"properties":{"messageReturned":{"type":"array","description":"Suggested valid addresses","items":{"type":"string"}},"status":{"type":"string","description":"http status"}}},"ValidateAddressResponse":{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","description":"Was the passed in address valid"},"response":{"description":"Subscriber schema","$ref":"#/definitions/SubscriberResponse"}}},"StreetAddress":{"type":"object","required":["A1","A3","HNO","PC","RD","country"],"properties":{"country":{"type":"string","description":"2 Letter Country code, like US or GB"},"A1":{"type":"string","description":"State or Province"},"A3":{"type":"string","description":"City or township"},"RD":{"type":"string","description":"Number and street"},"HNO":{"type":"string","description":"House Number"},"LOC":{"type":"string","description":"extra location info like suite 300"},"NAM":{"type":"string","description":"Name of the customer"},"PC":{"type":"string","description":"Postal code"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"description":"Address schema","$ref":"#/definitions/StreetAddress"}}},"CertificateAuthorityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainCertificateAuthority":{"type":"object","required":["certificate","name","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type. Managed certificate authorities are generated and maintained by Interactive Intelligence. These are read-only and not modifiable by clients. Remote authorities are customer managed.","enum":["MANAGED","REMOTE"]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"EdgeNetworkDiagnostic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeNetworkDiagnosticRequest":{"type":"object","required":["host"],"properties":{"host":{"type":"string","description":"IPv4/6 address or host to be probed for connectivity. No port allowed."}}},"EdgeNetworkDiagnosticResponse":{"type":"object","properties":{"commandCorrelationId":{"type":"string","description":"UUID of each executed command on edge"},"diagnostics":{"type":"string","description":"Response string of executed command from edge"}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if this address family on the interface is enabled."},"dhcp":{"type":"boolean","description":"True if this address family on the interface is using DHCP."},"metric":{"type":"integer","format":"int32","description":"The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge."},"autoMetric":{"type":"boolean","description":"True if the metric is being calculated automatically for the address family on this interface."},"supportsMetric":{"type":"boolean","description":"True if metric configuration is supported.","readOnly":true},"pingEnabled":{"type":"boolean","description":"Set to true to enable this address family on this interface to respond to ping requests."}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string","description":"The type of address.","enum":["ip","dns","gateway","tdm"]},"address":{"type":"string","description":"An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask."},"persistent":{"type":"boolean","description":"True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false."},"family":{"type":"integer","format":"int32","description":"The address family for this address.","enum":[2,23]}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string","description":"The IPv4 or IPv6 route prefix in CIDR notation."},"nexthop":{"type":"string","description":"The IPv4 or IPv6 nexthop IP address."},"persistent":{"type":"boolean","description":"True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false."},"metric":{"type":"integer","format":"int32","description":"The metric being used for route. Lower values will have a higher priority."},"family":{"type":"integer","format":"int32","description":"The address family for this route.","enum":[2,23]}}},"EdgeRebootParameters":{"type":"object","properties":{"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"ConnectedEdge":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"interfaceName":{"type":"string","description":"Edge interface name used for the connection","readOnly":true},"interfaceIpAddress":{"type":"string","description":"Edge interface IP address","readOnly":true},"edgeConnectionList":{"type":"array","items":{"$ref":"#/definitions/EdgeConnectionInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEdgeSoftwareUpdateDto":{"type":"object","required":["version"],"properties":{"version":{"description":"Version","$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeOnIdle":{"type":"boolean"},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"]},"edgeUri":{"type":"string","format":"uri"},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int64"},"current":{"type":"boolean"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"edgeUri":{"type":"string","format":"uri"},"latestRelease":{"type":"boolean"},"current":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"interfaces":{"type":"array","description":"The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string","description":"The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE."},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","description":"The current status of the Edge.","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED","INITIALIZING"]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"description":"The Site to which the Edge is assigned.","$ref":"#/definitions/Site"},"softwareStatus":{"description":"Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge.","$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean"},"managed":{"type":"boolean"},"edgeDeploymentType":{"type":"string","enum":["HARDWARE","LDM","CDM","CHS","INVALID"]},"certType":{"type":"string","description":"The type of certificate used to communicate with edge-proxy.","enum":["PureCloud","Public","China","NotRequested"]},"callDrainingState":{"type":"string","description":"The current state of the Edge's call draining process before it can be safely rebooted or updated.","readOnly":true,"enum":["NONE","WAIT","WAIT_TIMEOUT","TERMINATE","COMPLETE"]},"conversationCount":{"type":"integer","format":"int32","description":"The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0.","readOnly":true},"proxy":{"type":"string","description":"Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed."},"offlineConfigCalled":{"type":"boolean","description":"True if the offline edge configuration endpoint has been called for this edge.","readOnly":true},"osName":{"type":"string","description":"The name provided by the operating system of the Edge.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeAutoUpdateConfig":{"type":"object","required":["end","rrule","start","timeZone"],"properties":{"timeZone":{"type":"string","description":"The timezone of the window in which any updates to the edges assigned to the site can be applied. The minimum size of the window is 2 hours."},"rrule":{"type":"string","description":"The recurrence rule for updating the Edges assigned to the site. The only supported frequencies are daily and weekly. Weekly frequencies require a day list with at least oneday specified. All other configurations are not supported."},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"}}},"EdgeConnectionInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"interfaceName":{"type":"string","description":"Interface used for the connection on the edge","readOnly":true},"interfaceIpAddress":{"type":"string","description":"IP address of the interface","readOnly":true},"connectionErrors":{"type":"array","description":"Connection errors","readOnly":true,"items":{"type":"string"}},"site":{"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroup":{"type":"object","required":["edgeTrunkBaseAssignment","name","phoneTrunkBases"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"managed":{"type":"boolean","description":"Is this edge group being managed remotely."},"hybrid":{"type":"boolean","description":"Is this edge group hybrid."},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/TrunkBase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]}},"addressFamilyId":{"type":"string"}}},"NTPSettings":{"type":"object","properties":{"servers":{"type":"array","description":"List of NTP servers, in priority order","items":{"type":"string"}}}},"Site":{"type":"object","required":["location","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"primarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"mediaRegionsUseLatencyBased":{"type":"boolean"},"location":{"description":"Location","$ref":"#/definitions/LocationDefinition"},"managed":{"type":"boolean"},"ntpSettings":{"description":"Network Time Protocol settings for the site","$ref":"#/definitions/NTPSettings"},"mediaModel":{"type":"string","description":"Media model for the site","enum":["Premises","Cloud"]},"coreSite":{"type":"boolean","description":"Is this site a core site"},"siteConnections":{"type":"array","description":"The site connections","items":{"$ref":"#/definitions/SiteConnection"}},"mediaRegions":{"type":"array","description":"The ordered list of AWS regions through which media can stream.","items":{"type":"string"}},"callerId":{"type":"string","description":"The caller ID value for the site."},"callerName":{"type":"string","description":"The caller name for the site."},"cloudProxyForceTurn":{"type":"boolean","description":"Enables premises Edge Force Turn "},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SiteConnection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"managed":{"type":"boolean"},"type":{"type":"string","description":"Connection method from site to site (Direct, Indirect, CloudProxy","enum":["Direct","Indirect","CloudProxy"]},"enabled":{"type":"boolean","description":"Indicates if the current site is linked"},"mediaModel":{"type":"string","description":"Media model for the current site.","readOnly":true,"enum":["Premises","Cloud"]},"edgeList":{"type":"array","description":"All of the edges to which the site connects","readOnly":true,"items":{"$ref":"#/definitions/ConnectedEdge"}},"coreSite":{"type":"boolean","description":"The core site","readOnly":true},"primaryCoreSites":{"type":"array","description":"List of site ids names and selfUris for the primary core sites","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"secondaryCoreSites":{"type":"array","description":"List of site ids names and selfUris for the secondary core sites","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"TrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned."},"site":{"description":"Used to determine the media regions for inbound and outbound calls through a trunk. Also determines the dial plan to use for calls that came in on a trunk and have to be sent out on it as well.","$ref":"#/definitions/DomainEntityRef"},"inboundSite":{"description":"Allows a customer to set the site to which inbound calls will be routed","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/TrunkBase"}}},"EdgeServiceStateRequest":{"type":"object","required":["inService"],"properties":{"inService":{"type":"boolean","description":"A boolean that sets the Edge in-service or out-of-service."},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"DomainEdgeSoftwareVersionDtoEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RegionTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RegionTimeZone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"DomainLogicalInterface":{"type":"object","required":["friendlyName","hardwareAddress","name","physicalAdapterId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string","description":"Friendly Name"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string","description":"Hardware Address"},"physicalAdapterId":{"type":"string","description":"Physical Adapter Id"},"ifStatus":{"type":"string"},"interfaceType":{"type":"string","description":"The type of this network interface.","readOnly":true,"enum":["DIAGNOSTIC","SYSTEM"]},"publicNatAddressIpV4":{"type":"string","description":"IPv4 NENT IP Address"},"publicNatAddressIpV6":{"type":"string","description":"IPv6 NENT IP Address"},"routes":{"type":"array","description":"The list of routes assigned to this interface.","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","description":"The list of IP addresses on this interface. Priority of dns addresses are based on order in the list.","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"description":"IPv4 interface settings.","$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"description":"IPv6 interface settings.","$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group."},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 phone trunk base assignment will be inherited from the Edge Group."},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group."},"useForIndirectEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end."},"useForCloudProxyEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option."},"useForWanInterface":{"type":"boolean","description":"This interface will be used for all communication with the internet.","readOnly":true},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"traceEnabled":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean"},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean"},"team":{"type":"boolean"}}},"DomainPhysicalInterface":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDPool":{"type":"object","required":["endPhoneNumber","name","startPhoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"number":{"type":"string","description":"The number of the DID formatted as E164."},"assigned":{"type":"boolean","description":"True if this DID is assigned to an entity. False otherwise."},"didPool":{"description":"A Uri reference to the DID Pool this DID is a part of.","$ref":"#/definitions/AddressableEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID. The owner's type can be found in ownerType. If the DID is unassigned, this will be NULL.","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","description":"The type of the entity that owns this DID. If the DID is unassigned, this will be NULL.","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an unassigned or assigned DID in a DID Pool."},"DIDNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DID":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/DomainEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeTrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"site":{"description":"Used to determine the media regions for inbound and outbound calls through a trunk. Also determines the dial plan to use for calls that came in on a trunk and have to be sent out on it as well.","$ref":"#/definitions/DomainEntityRef"},"inboundSite":{"description":"Allows a customer to set the site to which inbound calls will be routed","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPool":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. The number must be between 3 and 9 digits in length and the same length as the endNumber."},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. The number must be between 3 and 9 digits in length and the same length as the startNumber."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPoolDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The extension pool identifier"},"name":{"type":"string","description":"The start number of the extension pool."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPoolDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPoolDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Extension":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"extensionPool":{"$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineBase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"lineMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Line":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"description":"The edge group associated with the line. (Deprecated)","$ref":"#/definitions/DomainEntityRef"},"template":{"$ref":"#/definitions/DomainEntityRef"},"site":{"$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"description":"The primary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"secondaryEdge":{"description":"The secondary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/DomainEntityRef"},"defaultForUser":{"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJob":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobFile":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud. Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobUploadRequest":{"type":"object","required":["fileIds"],"properties":{"fileIds":{"type":"array","description":"A list of file ids to upload.","items":{"type":"string"}}}},"EdgeLogsJobResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string","description":"A relative directory to the root Edge log folder to query from."},"query":{"type":"string","description":"The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter."},"recurse":{"type":"boolean","description":"Boolean whether or not to recurse into directories."}}},"EdgeMetrics":{"type":"object","properties":{"edge":{"$ref":"#/definitions/DomainEntityRef"},"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"upTimeMsec":{"type":"integer","format":"int64"},"processors":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsProcessor"}},"memory":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsMemory"}},"disks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsDisk"}},"subsystems":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsSubsystem"}},"networks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsNetwork"}}}},"EdgeMetricsDisk":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"partitionName":{"type":"string","description":"Disk partition name."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsMemory":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"type":{"type":"string","description":"Type of memory. Virtual or physical."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsNetwork":{"type":"object","properties":{"ifname":{"type":"string","description":"Identifier for the network adapter."},"sentBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes sent per second."},"receivedBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes received per second."},"bandwidthBitsPerSec":{"type":"number","format":"double","description":"Total bandwidth of the adapter in bits per second."},"utilizationPct":{"type":"number","format":"double","description":"Percent utilization of the network adapter."}}},"EdgeMetricsProcessor":{"type":"object","properties":{"activeTimePct":{"type":"number","format":"double","description":"Percent time processor was active."},"cpuId":{"type":"string","description":"Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources."},"idleTimePct":{"type":"number","format":"double","description":"Percent time processor was idle."},"privilegedTimePct":{"type":"number","format":"double","description":"Percent time processor spent in privileged mode."},"userTimePct":{"type":"number","format":"double","description":"Percent time processor spent in user mode."}}},"EdgeMetricsSubsystem":{"type":"object","properties":{"delayMs":{"type":"integer","format":"int32","description":"Delay in milliseconds."},"processName":{"type":"string","description":"Name of the Edge process."},"mediaSubsystem":{"description":"Subsystem for an Edge device.","$ref":"#/definitions/EdgeMetricsSubsystem"}}},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"NumberPlan":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRoute":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"site":{"description":"The site associated to the outbound route.","readOnly":true,"$ref":"#/definitions/Site"},"managed":{"type":"boolean","description":"Is this outbound route being managed remotely.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneBase":{"type":"object","required":["lines","name","phoneMetaBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"phoneMetaBase":{"description":"A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.","$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"The list of linebases associated with the phone base.","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean"},"registers":{"type":"boolean"},"dualRegisters":{"type":"boolean"},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean"},"noRebalance":{"type":"boolean"},"noCloudProvisioning":{"type":"boolean"},"mediaCodecs":{"type":"array","items":{"type":"string","enum":["audio/opus","audio/pcmu","audio/pcma","audio/g729","audio/g722"]}},"cdm":{"type":"boolean"}}},"PhoneBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Metabase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"type":{"type":"string","enum":["EXTERNAL","EXTERNAL_PCV","EXTERNAL_PCV_AWS","EXTERNAL_BYOC_CARRIER","EXTERNAL_BYOC_PBX","STATION_CDM","STATION_CDM_WEBRTC","STATION","TIE","TIE_DIRECT","TIE_INDIRECT","TIE_CLOUD_PROXY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line."},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Phone":{"type":"object","required":["lines","name","phoneBaseSettings","site"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"site":{"description":"The site associated to the phone.","$ref":"#/definitions/DomainEntityRef"},"phoneBaseSettings":{"description":"Phone Base Settings","$ref":"#/definitions/PhoneBaseSettings"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"phoneMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"Lines","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"userAgentInfo":{"description":"User Agent Information for this phone. This includes model, firmware version, and manufacturer.","readOnly":true,"$ref":"#/definitions/UserAgentInfo"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.","$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneBaseSettings":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this phone base settings"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE","UNKNOWN"]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"]},"eventCreationTime":{"type":"string","description":"Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London"},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object. Deprecated. Do not use."}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"UserAgentInfo":{"type":"object","properties":{"firmwareVersion":{"type":"string","description":"The firmware version of the phone."},"manufacturer":{"type":"string","description":"The manufacturer of the phone."},"model":{"type":"string","description":"The model of the phone."}}},"PhoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","description":"The list of phone Ids to reboot.","items":{"type":"string"}},"siteId":{"type":"string","description":"ID of the site for which to reboot all phones at that site.\nno.active.edge and phone.cannot.resolve errors are ignored."}}},"ExpiredEdgeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"SiteConnections":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"siteConnections":{"type":"array","description":"List of site connections","readOnly":true,"items":{"$ref":"#/definitions/SiteConnection"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DisableSiteConnectionsRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"SiteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRouteBase":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRouteBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetrics":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logicalInterface":{"$ref":"#/definitions/DomainEntityRef"},"trunk":{"$ref":"#/definitions/DomainEntityRef"},"calls":{"$ref":"#/definitions/TrunkMetricsCalls"},"qos":{"$ref":"#/definitions/TrunkMetricsQoS"}}},"TrunkMetricsCalls":{"type":"object","properties":{"inboundCallCount":{"type":"integer","format":"int32"},"outboundCallCount":{"type":"integer","format":"int32"}}},"TrunkMetricsQoS":{"type":"object","required":["mismatchCount"],"properties":{"mismatchCount":{"type":"integer","format":"int32","description":"Total number of QoS mismatches over the course of the last 24-hour period (sliding window)."}}},"TrunkBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrunkBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"Trunk":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/DomainEntityRef"},"inService":{"type":"boolean","description":"True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.","readOnly":true},"enabled":{"type":"boolean","description":"True if the Edge used by this trunk is in-service"},"logicalInterface":{"description":"The Logical Interface on the Edge to which the trunk is assigned.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"connectedStatus":{"description":"The connected status of the trunk","readOnly":true,"$ref":"#/definitions/TrunkConnectedStatus"},"optionsStatus":{"type":"array","description":"The trunk optionsStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsOptions"}},"registersStatus":{"type":"array","description":"The trunk registersStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsRegisters"}},"ipStatus":{"description":"The trunk ipStatus","readOnly":true,"$ref":"#/definitions/TrunkMetricsNetworkTypeIp"},"optionsEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"]},"registersEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"]},"family":{"type":"integer","format":"int32","description":"The IP Network Family of the trunk","readOnly":true},"proxyAddressList":{"type":"array","description":"The list of proxy addresses (ports if provided) for the trunk","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkConnectedStatus":{"type":"object","properties":{"connected":{"type":"boolean"},"connectedStateTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrunkEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkErrorInfo":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string"},"details":{"$ref":"#/definitions/TrunkErrorInfoDetails"}}},"TrunkErrorInfoDetails":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"hostname":{"type":"string"}}},"TrunkMetricsNetworkTypeIp":{"type":"object","properties":{"address":{"type":"string","description":"Assigned IP Address for the interface"},"errorInfo":{"description":"Information about the error.","$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsOptions":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this options array element represents."},"optionState":{"type":"boolean"},"optionStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the option state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsRegisters":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this registers array element represents."},"registerState":{"type":"boolean","description":"True if last REGISTER message had positive response; false if error response or no response."},"registerStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the register state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"MetaData":{"type":"object","properties":{"pairing-token":{"type":"string"},"pairing-trust":{"type":"array","items":{"type":"string"}},"pairing-url":{"type":"string"}}},"VmPairingInfo":{"type":"object","properties":{"meta-data":{"description":"This is to be used to complete the setup process of a locally deployed virtual edge device.","$ref":"#/definitions/MetaData"},"edge-id":{"type":"string"},"auth-token":{"type":"string"},"org-id":{"type":"string"}}},"HomerRecord":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"date":{"type":"string","format":"date-time","description":"metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milliTs":{"type":"string","description":"metadata associated to the SIP calls"},"microTs":{"type":"string","description":"metadata associated to the SIP calls"},"method":{"type":"string","description":"metadata associated to the SIP calls"},"replyReason":{"type":"string","description":"metadata associated to the SIP calls"},"ruri":{"type":"string","description":"metadata associated to the SIP calls"},"ruriUser":{"type":"string","description":"metadata associated to the SIP calls"},"ruriDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromUser":{"type":"string","description":"metadata associated to the SIP calls"},"fromDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromTag":{"type":"string","description":"metadata associated to the SIP calls"},"toUser":{"type":"string","description":"metadata associated to the SIP calls"},"toDomain":{"type":"string","description":"metadata associated to the SIP calls"},"toTag":{"type":"string","description":"metadata associated to the SIP calls"},"pidUser":{"type":"string","description":"metadata associated to the SIP calls"},"contactUser":{"type":"string","description":"metadata associated to the SIP calls"},"authUser":{"type":"string","description":"metadata associated to the SIP calls"},"callid":{"type":"string","description":"metadata associated to the SIP calls"},"callidAleg":{"type":"string","description":"metadata associated to the SIP calls"},"via1":{"type":"string","description":"metadata associated to the SIP calls"},"via1Branch":{"type":"string","description":"metadata associated to the SIP calls"},"cseq":{"type":"string","description":"metadata associated to the SIP calls"},"diversion":{"type":"string","description":"metadata associated to the SIP calls"},"reason":{"type":"string","description":"metadata associated to the SIP calls"},"contentType":{"type":"string","description":"metadata associated to the SIP calls"},"auth":{"type":"string","description":"metadata associated to the SIP calls"},"userAgent":{"type":"string","description":"metadata associated to the SIP calls"},"sourceIp":{"type":"string","description":"metadata associated to the SIP calls"},"sourcePort":{"type":"string","description":"metadata associated to the SIP calls"},"destinationIp":{"type":"string","description":"metadata associated to the SIP calls"},"destinationPort":{"type":"string","description":"metadata associated to the SIP calls"},"contactIp":{"type":"string","description":"metadata associated to the SIP calls"},"contactPort":{"type":"string","description":"metadata associated to the SIP calls"},"originatorIp":{"type":"string","description":"metadata associated to the SIP calls"},"originatorPort":{"type":"string","description":"metadata associated to the SIP calls"},"correlationId":{"type":"string","description":"metadata associated to the SIP calls"},"proto":{"type":"string","description":"metadata associated to the SIP calls"},"family":{"type":"string","description":"metadata associated to the SIP calls"},"rtpStat":{"type":"string","description":"metadata associated to the SIP calls"},"type":{"type":"string","description":"metadata associated to the SIP calls"},"node":{"type":"string","description":"metadata associated to the SIP calls"},"trans":{"type":"string","description":"metadata associated to the SIP calls"},"dbnode":{"type":"string","description":"metadata associated to the SIP calls"},"msg":{"type":"string","description":"metadata associated to the SIP calls"},"sourceAlias":{"type":"string","description":"metadata associated to the SIP calls"},"destinationAlias":{"type":"string","description":"metadata associated to the SIP calls"},"conversationId":{"type":"string","description":"metadata associated to the SIP calls"},"participantId":{"type":"string","description":"metadata associated to the SIP calls"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipSearchResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"integer","format":"int32","description":"Status of the search request"},"sid":{"type":"string","description":"Session id associated to the search request"},"auth":{"type":"string","description":"Auth token used for this search request"},"message":{"type":"string","description":"Any messages returned from homer as part of the response"},"data":{"type":"array","description":"Homer search data that is returned","items":{"$ref":"#/definitions/HomerRecord"}},"count":{"type":"integer","format":"int32","description":"Number of records returned"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipDownloadResponse":{"type":"object","properties":{"downloadId":{"type":"string","description":"unique id of the downloaded file"},"documentId":{"type":"string","description":"Document id of pcap file"}}},"SIPSearchPublicRequest":{"type":"object","required":["dateEnd","dateStart"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"callId":{"type":"string","description":"unique identification of the placed call"},"toUser":{"type":"string","description":"SIP user to who the call was placed"},"fromUser":{"type":"string","description":"SIP user who placed the call"},"conversationId":{"type":"string","description":"Unique identification of the conversation"},"participantId":{"type":"string","description":"Unique identification of the participant"},"dateStart":{"type":"string","format":"date-time","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SignedUrlResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","format":"url","description":"Url of the downloaded pcap file"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AcceleratorSpecification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"name of this accelerator","readOnly":true},"description":{"type":"string","description":"a description of the general purpose of this accelerator","readOnly":true},"origin":{"type":"string","description":"where the accelerator originated","readOnly":true,"enum":["Community","Partner","Genesys"]},"type":{"type":"string","description":"type of the artifact","readOnly":true,"enum":["Module","Accelerator","Blueprint"]},"classification":{"type":"string","description":"architectural classification into which the accelerator belongs","readOnly":true},"tags":{"type":"array","description":"tags","readOnly":true,"items":{"type":"string"}},"permissions":{"type":"array","description":"Genesys Cloud permissions required to install the accelerator","readOnly":true,"items":{"type":"string"}},"products":{"type":"array","description":"Genesys Cloud products required to install the accelerator","readOnly":true,"items":{"type":"string"}},"documentation":{"type":"array","description":"additional documentation about the artifact","readOnly":true,"items":{"$ref":"#/definitions/MetadataDocumentation"}},"presentation":{"type":"array","description":"presentation of data fields to be gathered for the accelerator","readOnly":true,"items":{"$ref":"#/definitions/MetadataPresentation"}},"results":{"description":"resources created or modified as a result of running the accelerator","readOnly":true,"$ref":"#/definitions/MetadataResults"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Metadata for a CX infrastructure as code accelerator"},"MetadataDocumentation":{"type":"object","properties":{"description":{"type":"string","description":"description of the documentation","readOnly":true},"location":{"type":"string","description":"location where the documentation can be accessed","readOnly":true}},"description":"Additional documentation about an artifact"},"MetadataPresentation":{"type":"object","properties":{"title":{"type":"string","description":"title for a set of data to be gathered","readOnly":true},"schema":{"description":"description of the contents of the data gathering interface","readOnly":true,"$ref":"#/definitions/MetadataSchema"}},"description":"A representation of data fields to be gathered for installing the accelerator"},"MetadataProperty":{"type":"object","properties":{"type":{"type":"string","description":"the data type of the input property","readOnly":true},"displayname":{"type":"string","description":"user-friendly name of the input property","readOnly":true},"description":{"type":"string","description":"brief description of the input property","readOnly":true},"sensitive":{"type":"string","description":"whether the property's value should be hidden from display","readOnly":true},"help":{"type":"string","description":"optional URL with addition information about the input property","readOnly":true},"default":{"type":"string","description":"optional default value of the input property","readOnly":true},"enum":{"type":"array","description":"set of possible values if the input property is an enumeration","readOnly":true,"items":{"type":"string"}}},"description":"Data property required as input for installing an accelerator"},"MetadataResultEntity":{"type":"object","properties":{"type":{"type":"string","description":"object type of the modified resource","readOnly":true},"description":{"type":"string","description":"description of the modified resource","readOnly":true},"visibility":{"type":"string","description":"whether the modified resource is visible or hidden","readOnly":true,"enum":["Visible","Hidden"]}},"description":"A Genesys Cloud resource created or modified as a result of running an accelerator"},"MetadataResults":{"type":"object","properties":{"entities":{"type":"array","description":"list of resources","readOnly":true,"items":{"$ref":"#/definitions/MetadataResultEntity"}}},"description":"List of resources created or modified as a result of running an accelerator"},"MetadataSchema":{"type":"object","properties":{"title":{"type":"string","description":"title for the data gathering page","readOnly":true},"description":{"type":"string","description":"description of the data being gathered on this page","readOnly":true},"type":{"type":"string","description":"type of data being gathered","readOnly":true},"properties":{"type":"array","description":"list of properties for which input is to be gathered, bother required and optional","readOnly":true,"items":{"type":"object","additionalProperties":{"$ref":"#/definitions/MetadataProperty"}}},"required":{"type":"array","description":"list of required properties","readOnly":true,"items":{"type":"string"}}},"description":"A description of the contents of a data gathering interface for an accelerator"},"AcceleratorList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AcceleratorMetadata"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AcceleratorMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"name of this accelerator","readOnly":true},"description":{"type":"string","description":"a description of the general purpose of this accelerator","readOnly":true},"origin":{"type":"string","description":"where the accelerator originated","readOnly":true,"enum":["Community","Partner","Genesys"]},"type":{"type":"string","description":"type of the artifact","readOnly":true,"enum":["Module","Accelerator","Blueprint"]},"classification":{"type":"string","description":"architectural classification into which the accelerator belongs","readOnly":true},"tags":{"type":"array","description":"tags","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Metadata for a CX infrastructure as code accelerator"},"InfrastructureascodeJob":{"type":"object","required":["dryRun"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dryRun":{"type":"boolean","description":"dryRun"},"acceleratorId":{"type":"string","description":"acceleratorId","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"dateSubmitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"submittedBy":{"description":"submittedBy","readOnly":true,"$ref":"#/definitions/UserReference"},"status":{"type":"string","description":"status","readOnly":true,"enum":["Created","Queued","Running","Complete","Failed","Incomplete"]},"errorInfo":{"description":"errorInfo","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"results":{"type":"string","description":"results","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Information about a CX infrastructure as code job"},"AcceleratorInput":{"type":"object","required":["acceleratorId"],"properties":{"dryRun":{"type":"boolean","description":"Set this true to test the job without making any changes. Defaults to false."},"acceleratorId":{"type":"string","description":"Accelerator ID"},"parameters":{"type":"array","description":"Parameters required for this accelerator","items":{"$ref":"#/definitions/AcceleratorParameter"}}},"description":"Identity of a CX infrastructure as code accelerator to be run and its inputs"},"AcceleratorParameter":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Parameter Name"},"value":{"type":"string","description":"Parameter Value"}},"description":"Input parameter for a CX infrastructure as code accelerator"},"Format":{"type":"object","properties":{"flags":{"type":"array","description":"The Set of prompt segment format flags i.e. each entry is a part of describing the overall format. E.g. \"format\": { \"flags\": [StringPlayChars] }","uniqueItems":true,"items":{"type":"string","enum":["BoolPlayYesNo","CurrencyAsMinorUnits","CurrencyMajorUnitsOnly","CurrencyMinorUnitsOnly","CurrencyPlayDigits","DateLongYear","DateShortYear","DateShortMonthAndDay","DateDayOfWeekOnly","DateDayOnly","DateMonthOnly","DateShortYearOnly","DateLongYearOnly","TimeTwentyFourHours","TimeTwelveHours","TimePartDays","TimePartHours","TimePartMinutes","TimePartSeconds","StringPlayChars","NumberPlayDigits","NumberOrdinal","LanguageCaseArticle","LanguageCaseAccusative","LanguageCaseDative","LanguageCaseGenitive","LanguageCaseNominative","LanguageQuantityPlural","LanguageQuantitySingular","LanguageGenderCommon","LanguageGenderFeminine","LanguageGenderMasculine","LanguageGenderNeuter","CaseArticle","CaseAccusative","CaseDative","CaseGenitive","CaseNominative","QuantityPlural","QuantitySingular","GenderCommon","GenderFeminine","GenderMasculine","GenderNeuter"]}}}},"TextBotDisconnectAction":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason for the disconnect.","enum":["TriggeredByUser","TriggeredByFlow","SessionExpired","Error","RecognitionFailure"]},"reasonExtendedInfo":{"type":"string","description":"Extended information related to the reason, if available."},"flowLocation":{"description":"Describes where in the Bot Flow the user was when the disconnect occurred.","$ref":"#/definitions/TextBotFlowLocation"},"flowOutcomes":{"type":"array","description":"The list of Flow Outcomes for the bot flow and their details.","items":{"$ref":"#/definitions/TextBotFlowOutcome"}}},"description":"Settings for a next-action of disconnecting, including the reason code for the disconnect."},"TextBotExitAction":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason for the exit.","enum":["TriggeredByUser","AgentRequestedByUser","TriggeredByFlow","Error","RecognitionFailure"]},"reasonExtendedInfo":{"type":"string","description":"Extended information related to the reason, if available."},"activeIntent":{"type":"string","description":"The active intent at the time of the exit."},"flowLocation":{"description":"Describes where in the Bot Flow the user was when the exit occurred.","$ref":"#/definitions/TextBotFlowLocation"},"outputData":{"description":"The output data for the bot flow.","$ref":"#/definitions/TextBotInputOutputData"},"flowOutcomes":{"type":"array","description":"The list of Flow Outcomes for the bot flow and their details.","items":{"$ref":"#/definitions/TextBotFlowOutcome"}}},"description":"Settings for a next-action of exiting the bot flow. Any output variables are available in the details."},"TextBotFlowLocation":{"type":"object","required":["actionName","actionNumber","sequenceName"],"properties":{"actionName":{"type":"string","description":"The name of the action that was active when the event of interest happened."},"actionNumber":{"type":"integer","format":"int32","description":"The number of the action that was active when the event of interest happened."},"sequenceName":{"type":"string","description":"The name of the state or task which was active when the event of interest happened."}},"description":"Describes a flow location."},"TextBotFlowMilestone":{"type":"object","required":["dateReached","id","sequence"],"properties":{"id":{"type":"string","description":"The Milestone's ID."},"dateReached":{"type":"string","format":"date-time","description":"The timestamp of when the milestone was reached. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sequence":{"type":"integer","format":"int64","description":"The sequence number of the milestone."}}},"TextBotFlowOutcome":{"type":"object","properties":{"outcomeId":{"type":"string","description":"The Flow Outcome ID."},"outcomeValue":{"type":"string","description":"The value of the FlowOutcome.","enum":["SUCCESS","FAILURE"]},"dateStart":{"type":"string","format":"date-time","description":"The timestamp for when the Flow Outcome began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The timestamp for when the Flow Outcome finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milestones":{"type":"array","description":"The Flow Milestones for the Flow Outcome.","items":{"$ref":"#/definitions/TextBotFlowMilestone"}}},"description":"Flow Outcome data related to a bot flow which is exiting gracefully."},"TextBotFlowTurnResponse":{"type":"object","required":["id","nextActionType"],"properties":{"id":{"type":"string","description":"The ID of the bot flow turn. If additional turns are needed, supply this ID as the previous turn in your next turn request."},"previousTurn":{"description":"The reference to a previous turn, if applicable.","$ref":"#/definitions/TextBotTurnReference"},"prompts":{"description":"The output prompts for this turn.","$ref":"#/definitions/TextBotOutputPrompts"},"nextActionType":{"type":"string","description":"Indicates the suggested next action. If appropriate, the matching output event object includes additional information.","enum":["NoOp","Disconnect","WaitForInput","Exit"]},"nextActionDisconnect":{"description":"The next action directive for this turn if it is a Disconnect type.","$ref":"#/definitions/TextBotDisconnectAction"},"nextActionWaitForInput":{"description":"The next action directive for this turn if it is a WaitForInput type.","$ref":"#/definitions/TextBotWaitForInputAction"},"nextActionExit":{"description":"The next action directive for this turn if it is an Exit type.","$ref":"#/definitions/TextBotExitAction"}},"description":"Information related to a success bot flow turn request."},"TextBotInputOutputData":{"type":"object","required":["variables"],"properties":{"variables":{"type":"object","description":"The input/output variables using the format as appropriate for the variable data type in the flow definition.","additionalProperties":{"type":"object"}}},"description":"Input/Output data related to a bot flow which is exiting gracefully."},"TextBotModeConstraints":{"type":"object","properties":{"text":{"description":"Mode constraints that apply to text scenarios.","$ref":"#/definitions/TextBotTextModeConstraints"}},"description":"Mode constraints to observe when operating on a bot flow."},"TextBotModeOutputPrompts":{"type":"object","required":["segments"],"properties":{"segments":{"type":"array","description":"The list of prompt segments.","items":{"$ref":"#/definitions/TextBotPromptSegment"}}},"description":"Prompt information related to a bot flow turn."},"TextBotOutputPrompts":{"type":"object","required":["outputLanguage"],"properties":{"outputLanguage":{"type":"string","description":"The ISO code of the output language for this prompt item."},"textPrompts":{"description":"Text output prompts, if any.","$ref":"#/definitions/TextBotModeOutputPrompts"}},"description":"Prompt information related to a bot flow turn."},"TextBotPromptSegment":{"type":"object","required":["text","type"],"properties":{"text":{"type":"string","description":"The text of this prompt segment."},"type":{"type":"string","description":"The segment type which describes any semantics about the 'text' and also indicates which other field might include additional relevant info.","enum":["Text","RichMedia"]},"format":{"description":"Additional details describing the segment’s contents, which the client should honour where possible.","$ref":"#/definitions/Format"},"content":{"type":"array","description":"Details to display Rich Media content. This is only populated when the segment 'type' is 'Rich Media'.","items":{"$ref":"#/definitions/MessageContent"}}},"description":"Data for a single bot flow prompt segment."},"TextBotTextModeConstraints":{"type":"object","required":["languagePreferences"],"properties":{"languagePreferences":{"type":"array","description":"The list of language preferences by their ISO language code.","items":{"type":"string"}},"noInputTimeoutMilliseconds":{"type":"integer","format":"int32","description":"The amount of time, in milliseconds, before the client should send the 'NoInput' event\n to trigger the \"no input\" bot response and handling on digital channels.\n Note: This optional field will only be returned for 'Digital Bot Flow' turns."}},"description":"Mode constraints to observe when operating on a bot flow."},"TextBotTurnReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the turn."}},"description":"A reference to a bot flow turn."},"TextBotWaitForInputAction":{"type":"object","required":["modeConstraints"],"properties":{"modeConstraints":{"description":"The mode constraints for the user input.","$ref":"#/definitions/TextBotModeConstraints"}},"description":"Settings for a next-action of waiting for additional user input and sending the data as an input action to the bot flow."},"TextBotErrorInputEvent":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The error code."},"message":{"type":"string","description":"The error message."}},"description":"Settings for an input event to the bot flow indicating an error has occurred."},"TextBotFlowTurnRequest":{"type":"object","required":["inputEventType"],"properties":{"previousTurn":{"description":"The reference to a previous turn if appropriate, used to avoid race conditions.","$ref":"#/definitions/TextBotTurnReference"},"inputEventType":{"type":"string","description":"Indicates the type of input event being requested. If appropriate, fill out the matching user input object details on this request.","enum":["NoOp","UserInput","Error","NoMatch","NoInput","UserDisconnect","ClientSessionExpired"]},"inputEventUserInput":{"description":"The data for the input event of this turn if it is a user input event. Only one inputEvent may be set.","$ref":"#/definitions/TextBotUserInputEvent"},"inputEventError":{"description":"The data for the input event of this turn if it is an error event. Only one inputEvent may be set.","$ref":"#/definitions/TextBotErrorInputEvent"}},"description":"Settings for a turn request to a bot flow."},"TextBotTranscript":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the transcript item."},"confidence":{"type":"number","format":"float","description":"The confidence factor, expressed as a decimal between 0.0 and 1.0, of the transcript item."}},"description":"Data for a single bot flow transcript."},"TextBotUserInputAlternative":{"type":"object","required":["transcript"],"properties":{"transcript":{"description":"The user input transcript.","$ref":"#/definitions/TextBotTranscript"}},"description":"User input data used in a bot flow turn."},"TextBotUserInputEvent":{"type":"object","required":["alternatives","mode"],"properties":{"mode":{"type":"string","description":"The input mode.","enum":["Text"]},"alternatives":{"type":"array","description":"The input alternatives.","items":{"$ref":"#/definitions/TextBotUserInputAlternative"}}},"description":"Settings for an input event to the bot flow indicating user input is available."},"TextBotFlowLaunchResponse":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The session ID of the bot flow, used to send to subsequent turn requests"}},"description":"Information related to a successful launch of a bot flow. The ID will be used in subsequent turn requests of the bot flow."},"TextBotChannel":{"type":"object","required":["inputModes","name","outputModes","userAgent"],"properties":{"name":{"type":"string","description":"The name of the channel.","enum":["Chat","Call","Messaging"]},"inputModes":{"type":"array","description":"The input modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text"]}},"outputModes":{"type":"array","description":"The output modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text"]}},"userAgent":{"description":"Information about the end user agent calling the bot flow.","$ref":"#/definitions/TextBotUserAgent"}},"description":"Channel information relevant to a bot flow."},"TextBotFlow":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Bot Flow ID."}},"description":"Description of the Bot Flow."},"TextBotFlowLaunchRequest":{"type":"object","required":["channel","externalSessionId","flow"],"properties":{"flow":{"description":"Specifies which Bot Flow to launch.","$ref":"#/definitions/TextBotFlow"},"externalSessionId":{"type":"string","description":"The ID of the external session that is associated with the bot flow."},"conversationId":{"type":"string","description":"A conversation ID to associate with the bot flow, if available."},"inputData":{"description":"Input values to the flow. Valid values are defined by the flow's input JSON schema.","$ref":"#/definitions/TextBotInputOutputData"},"channel":{"description":"Channel information relevant to the bot flow.","$ref":"#/definitions/TextBotChannel"},"language":{"type":"string","description":"The language that the bot will use in the session. Validated against list of supported languages and if the value is omitted or is invalid, the default language will be used."}},"description":"Settings for launching an instance of a bot flow."},"PostTextMessage":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Message type","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"text":{"type":"string","description":"Message text. If type is structured, used as fallback for clients that do not support particular structured content"},"content":{"type":"array","description":"A list of content elements in message","items":{"$ref":"#/definitions/ConversationMessageContent"}}}},"PostTextResponse":{"type":"object","required":["botState"],"properties":{"botState":{"type":"string","description":"The state of the bot after completion of the request","enum":["Complete","Failed","MoreData"]},"replyMessages":{"type":"array","description":"The list of messages to respond with, if any","items":{"$ref":"#/definitions/PostTextMessage"}},"intentName":{"type":"string","description":"The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected."},"slots":{"type":"object","description":"Data parameters detected and filled by the bot.","additionalProperties":{"type":"string"}},"botCorrelationId":{"type":"string","description":"The optional ID specified in the request"},"amazonLex":{"type":"object","description":"Raw data response from AWS (if called)","additionalProperties":{"type":"object"}},"googleDialogFlow":{"type":"object","description":"Raw data response from Google Dialogflow (if called)","additionalProperties":{"type":"object"}},"genesysDialogEngine":{"type":"object","description":"Raw data response from Genesys' Dialogengine (if called)","additionalProperties":{"type":"object"}},"genesysBotConnector":{"type":"object","description":"Raw data response from Genesys' BotConnector (if called)","additionalProperties":{"type":"object"}},"nuanceMixDlg":{"type":"object","description":"Raw data response from Nuance Mix Dlg (if called)","additionalProperties":{"type":"object"}}}},"AmazonLexRequest":{"type":"object","properties":{"requestAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs","additionalProperties":{"type":"string"}},"sessionAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs","additionalProperties":{"type":"string"}}}},"GenesysBotConnector":{"type":"object","properties":{"queryParameters":{"type":"object","description":"User defined name/value parameters passed to the BotConnector bot.","additionalProperties":{"type":"string"}}}},"GoogleDialogflowCustomSettings":{"type":"object","properties":{"environment":{"type":"string","description":"If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions"},"eventName":{"type":"string","description":"If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text. See https://cloud.google.com/dialogflow/es/docs/events-overview"},"webhookQueryParameters":{"type":"object","description":"Parameters passed to the fulfillment webhook of the bot (if any).","additionalProperties":{"type":"string"}},"eventInputParameters":{"type":"object","description":"Parameters passed to the event input of the bot.","additionalProperties":{"type":"string"}}}},"NuanceMixDlgSettings":{"type":"object","properties":{"channelId":{"type":"string","description":"The Nuance channel ID to use when launching the Nuance bot, which must one of the code names of the bot's registered input channels."},"inputParameters":{"type":"object","description":"Name/value pairs of input variables to be sent to the Nuance bot. The values must be in the appropriate format for the variable's type (see https://docs.mix.nuance.com/dialog-grpc/v1/#simple-variable-types for help)","additionalProperties":{"type":"object"}}}},"PostTextRequest":{"type":"object","required":["botId","botSessionId","integrationId","postTextMessage"],"properties":{"botId":{"type":"string","description":"ID of the bot to send the text to."},"botAlias":{"type":"string","description":"Alias/Version of the bot"},"integrationId":{"type":"string","description":"the integration service id for the bot's credentials"},"botSessionId":{"type":"string","description":"GUID for this bot's session"},"postTextMessage":{"description":"Message to send to the bot","$ref":"#/definitions/PostTextMessage"},"languageCode":{"type":"string","description":"The launguage code the bot will run under"},"botSessionTimeoutMinutes":{"type":"integer","format":"int32","description":"Override timeout for the bot session. This should be greater than 10 minutes."},"botChannels":{"type":"array","description":"The channels this bot is utilizing","items":{"type":"string","enum":["Call","Callback","Messaging","Webchat"]}},"botCorrelationId":{"type":"string","description":"Id for tracking the activity - this will be returned in the response"},"messagingPlatformType":{"type":"string","description":"If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"]},"amazonLexRequest":{"description":"Provider specific settings, if any","$ref":"#/definitions/AmazonLexRequest"},"googleDialogflow":{"description":"Provider specific settings, if any","$ref":"#/definitions/GoogleDialogflowCustomSettings"},"genesysBotConnector":{"description":"Provider specific settings, if any","$ref":"#/definitions/GenesysBotConnector"},"nuanceMixDlg":{"description":"Provider specific settings, if any","$ref":"#/definitions/NuanceMixDlgSettings"}}},"BotSearchResponse":{"type":"object","required":["botType","id","name"],"properties":{"id":{"type":"string","description":"The id of the bot"},"name":{"type":"string","description":"The name of the bot"},"botType":{"type":"string","description":"The provider of the bot","enum":["GenesysBotConnector","GenesysDialogEngine","AmazonLex","GoogleDialogFlowES","GoogleDialogFlowCX","NuanceDlg","GenesysBotFlow"]},"description":{"type":"string","description":"The description of the bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BotSearchResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotSearchResponse"}}}},"IdleTokenTimeout":{"type":"object","properties":{"idleTokenTimeoutSeconds":{"type":"integer","format":"int32","description":"Token timeout length in seconds. Must be at least 5 minutes and 8 hours or less (if HIPAA is disabled) or 15 minutes or less (if HIPAA is enabled).","minimum":300},"enableIdleTokenTimeout":{"type":"boolean","description":"Indicates whether the Token Timeout should be enabled or disabled."}}},"UCI10n":{"type":"object","properties":{"name":{"type":"string"}}},"UCIcon":{"type":"object","required":["vector"],"properties":{"vector":{"type":"string","description":"vector","readOnly":true}}},"UnifiedCommunicationsIntegration":{"type":"object","required":["badgeIcons","i10n","icon","integrationPresenceSource","pbxPermission","polledPresence","ucIntegrationKey","userPermissions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ucIntegrationKey":{"description":"ucIntegrationKey","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"integrationPresenceSource":{"type":"string","description":"integrationPresenceType","readOnly":true,"enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"pbxPermission":{"type":"string","description":"pbxPermission","readOnly":true},"icon":{"description":"icon","readOnly":true,"$ref":"#/definitions/UCIcon"},"badgeIcons":{"type":"object","description":"badgeIcon","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCIcon"}},"i10n":{"type":"object","description":"i10n","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCI10n"}},"polledPresence":{"type":"boolean","description":"polledPresence","readOnly":true},"pollIntervalSec":{"type":"integer","format":"int32","description":"pollIntervalSec","readOnly":true},"userPermissions":{"type":"array","description":"userPermissions","readOnly":true,"items":{"type":"string"}},"oauthScopes":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"UC Integration UI configuration data"},"UnifiedCommunicationsIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnifiedCommunicationsIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UCIntegration":{"type":"object","required":["badgeIcons","i10n","icon","integrationPresenceSource","pbxPermission","polledPresence","ucIntegrationKey","userPermissions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ucIntegrationKey":{"type":"string","description":"ucIntegrationKey","readOnly":true},"integrationPresenceSource":{"type":"string","description":"integrationPresenceType","readOnly":true,"enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"pbxPermission":{"type":"string","description":"pbxPermission","readOnly":true},"icon":{"description":"icon","readOnly":true,"$ref":"#/definitions/UCIcon"},"badgeIcons":{"type":"object","description":"badgeIcon","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCIcon"}},"i10n":{"type":"object","description":"i10n","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCI10n"}},"polledPresence":{"type":"boolean","description":"polledPresence","readOnly":true},"userPermissions":{"type":"array","description":"userPermissions","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"UC Integration UI configuration data"},"UCIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UCIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UCThirdPartyPresence":{"type":"object","required":["email","presence"],"properties":{"email":{"type":"string","description":"Primary Email address of the associated Genesys Cloud user."},"presence":{"type":"string","description":"Integration presence value."},"message":{"type":"string","description":"Integration presence message."},"dateModified":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of presence value change."}},"description":"Update a Genesys Cloud user's presence from a given 3rd-party integration"},"ApiUsageOrganizationQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"]},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"]}},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","UserId","TemplateUri","HttpMethod"]}}}},"ApiUsageSimpleSearch":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Date","ClientName","HttpMethod","TemplateUri","Status200","Status300","Status400","Status500","Status429"]}},"oauthClientNames":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of OAuth client names to be queried.","items":{"type":"string"}},"httpMethods":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of HTTP methods to be queried.","items":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","HEAD","CONNECT","OPTIONS","TRACE"]}},"templateUris":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of Template Uris to be queried.","items":{"type":"string"}}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserExternalIdentifier":{"type":"object","required":["authorityName","externalKey"],"properties":{"authorityName":{"type":"string","description":"Authority or System of Record which owns the External Identifier"},"externalKey":{"type":"string","description":"External Key"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a link between an External Identifier and Authority pair to a Entity Type and Entity Identifier pair. Represents the two way, one to one mapping of an External Authority or System of Record's identifier to a PureCloud entity. e.g. (ExternalId='05001',Authority='XyzCRM') to (entityType=user,entityId='8eb03b33-3acb-4bc1-a244-50b9b9f19495')"},"ChangeMyPasswordRequest":{"type":"object","required":["newPassword","oldPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"},"oldPassword":{"type":"string","description":"Your current password"}}},"FieldConfigs":{"type":"object","properties":{"org":{"$ref":"#/definitions/FieldConfig"},"person":{"$ref":"#/definitions/FieldConfig"},"group":{"$ref":"#/definitions/FieldConfig"},"externalContact":{"$ref":"#/definitions/FieldConfig"}}},"UserMe":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 non-divisioned presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"divisionedPresenceDefinitions":{"type":"array","description":"The presence definitions that the user has access to","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"locationDefinitions":{"type":"array","description":"The first 100 site locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/LocationDefinition"}},"orgAuthorization":{"type":"array","description":"The first 100 organization roles, with applicable permission policies, for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationRole"}},"favorites":{"type":"array","description":"The first 50 favorited users.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"superiors":{"type":"array","description":"The first 50 superiors of this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","description":"The first 50 direct reports to this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"adjacents":{"description":"The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.","readOnly":true,"$ref":"#/definitions/Adjacents"},"routingSkills":{"type":"array","description":"The first 50 routing skills for user's organizations","readOnly":true,"items":{"$ref":"#/definitions/RoutingSkill"}},"fieldConfigs":{"description":"The field config for all entities types of user's organization","readOnly":true,"$ref":"#/definitions/FieldConfigs"},"token":{"description":"Information about the current token","readOnly":true,"$ref":"#/definitions/TokenInfo"},"trustors":{"type":"array","description":"Organizations having this user as a trustee","readOnly":true,"items":{"$ref":"#/definitions/Trustor"}},"orgProducts":{"type":"array","description":"Products enabled in this organization","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChangePasswordRequest":{"type":"object","required":["newPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"}}},"UpdateUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email address, phone number, and/or extension for this user. One entry is allowed per media type","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"username":{"type":"string"},"preferredName":{"type":"string","description":"Preferred full name of agent"},"manager":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","items":{"$ref":"#/definitions/Group"}},"state":{"type":"string","description":"The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.","enum":["active","inactive","deleted"]},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguagePost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing language to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings."},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id."},"UserLanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingSkillPost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing skill to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserSkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserSkillGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillGroup"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"UserState":{"type":"object","properties":{"state":{"type":"string","description":"User's current state.","enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Version of this user."},"stateChangeReason":{"type":"string","description":"Reason for a change in the user's state.","enum":["Voluntary","Seasonal","Leave","Performance","Conduct","Unknown"]},"stateChangeDate":{"type":"string","format":"date-time","description":"Date that the state was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PatchUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"preferredName":{"type":"string","description":"Preferred full name of agent"},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"}}},"CreateUser":{"type":"object","required":["divisionId","email","name"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"},"divisionId":{"type":"string","description":"The division to which this user will belong"},"state":{"type":"string","description":"Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.","enum":["active","inactive","deleted"]}}},"UsersSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/User"}}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/UserSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["addresses.email","addresses.voice","addresses.address","addresses.voicemailEnabled","chat.jabberId","department","email","username","siteId","manager.id","hr.employeeId","integration","groups.social.id","groups.official.id","groups.distribution.id","state","id","languages.guid","languages.name","languages.namespace","languages.proficiency","name","primaryContactInfo.voice","primaryContactInfo.sms","primaryContactInfo.email","profileSkills","queueMembership.added","queueMembership.joined","routingSkills.guid","routingSkills.name","routingSkills.namespace","routingSkills.proficiency","title","divisionId","teamId"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL","QUERY_STRING"]}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"integrationPresenceSource":{"type":"string","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"enforcePermissions":{"type":"boolean","description":"This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"}}},"VoicemailCopyRecord":{"type":"object","properties":{"user":{"description":"The user that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/Group"},"date":{"type":"string","format":"date-time","description":"The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"description":"The conversation that the voicemail message is associated with","readOnly":true,"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","description":"Whether the voicemail message is marked as read"},"audioRecordingDurationSeconds":{"type":"integer","format":"int32","description":"The voicemail message's audio recording duration in seconds","readOnly":true},"audioRecordingSizeBytes":{"type":"integer","format":"int64","description":"The voicemail message's audio recording size in bytes","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"deletedDate":{"type":"string","format":"date-time","description":"The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"callerAddress":{"type":"string","description":"The caller address","readOnly":true},"callerName":{"type":"string","description":"Optionally the name of the caller that left the voicemail message if the caller was a known user","readOnly":true},"callerUser":{"description":"Optionally the user that left the voicemail message if the caller was a known user","readOnly":true,"$ref":"#/definitions/User"},"deleted":{"type":"boolean","description":"Whether the voicemail message has been marked as deleted"},"note":{"type":"string","description":"An optional note"},"user":{"description":"The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue","readOnly":true,"$ref":"#/definitions/Group"},"queue":{"description":"The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group","readOnly":true,"$ref":"#/definitions/Queue"},"copiedFrom":{"description":"Represents where this voicemail message was copied from","readOnly":true,"$ref":"#/definitions/VoicemailCopyRecord"},"copiedTo":{"type":"array","description":"Represents where this voicemail has been copied to","readOnly":true,"items":{"$ref":"#/definitions/VoicemailCopyRecord"}},"deleteRetentionPolicy":{"description":"The retention policy for this voicemail when deleted is set to true","$ref":"#/definitions/VoicemailRetentionPolicy"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailRetentionPolicy":{"type":"object","properties":{"voicemailRetentionPolicyType":{"type":"string","description":"The retention policy type","enum":["RETAIN_INDEFINITELY","RETAIN_WITH_TTL","IMMEDIATE_DELETE"]},"numberOfDays":{"type":"integer","format":"int32","description":"If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"}},"description":"Governs how the voicemail is retained"},"VoicemailGroupPolicy":{"type":"object","properties":{"name":{"type":"string"},"group":{"description":"The group associated with the policy","readOnly":true,"$ref":"#/definitions/Group"},"enabled":{"type":"boolean","description":"Whether voicemail is enabled for the group"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to group members when a new voicemail is received"},"disableEmailPii":{"type":"boolean","description":"Removes any PII from group emails. This is overridden by the analogous organization configuration value. This is always true if HIPAA is enabled or unknown for an organization."},"includeEmailTranscriptions":{"type":"boolean","description":"Whether to include the voicemail transcription in a group notification email"},"languagePreference":{"type":"string","description":"The language preference for the group. Used for group voicemail transcription"},"rotateCallsSecs":{"type":"integer","format":"int32","description":"How many seconds to ring before rotating to the next member in the group"},"stopRingingAfterRotations":{"type":"integer","format":"int32","description":"How many rotations to go through"},"overflowGroupId":{"type":"string","description":"A fallback group to contact when all of the members in this group did not answer the call."},"groupAlertType":{"type":"string","description":"Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.","enum":["RANDOM","ROUND_ROBIN","SEQUENTIAL"]},"interactiveResponsePromptId":{"type":"string","description":"The prompt to use when connecting a user to a Group Ring call"},"interactiveResponseRequired":{"type":"boolean","description":"Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64","description":"The total number of bytes for all voicemail message audio recordings","readOnly":true},"totalCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages","readOnly":true},"unreadCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as unread","readOnly":true},"deletedCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as deleted","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"newestUnreadDate":{"type":"string","format":"date-time","description":"The date of the most recent unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"oldestUnreadDate":{"type":"string","format":"date-time","description":"The date of the most oldest unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"newestReadDate":{"type":"string","format":"date-time","description":"The date of the most recent read voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"oldestReadDate":{"type":"string","format":"date-time","description":"The date of the most oldest read voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the user has voicemail enabled","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds to ring the user's phone before a call is transfered to voicemail"},"pin":{"type":"string","description":"The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to the user when a new voicemail is received"}}},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"CopyVoicemailMessage":{"type":"object","required":["voicemailMessageId"],"properties":{"voicemailMessageId":{"type":"string","description":"The id of the VoicemailMessage to copy"},"userId":{"type":"string","description":"The id of the User to copy the VoicemailMessage to"},"groupId":{"type":"string","description":"The id of the Group to copy the VoicemailMessage to"}},"description":"Used to copy a VoicemailMessage to either a User or a Group"},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voicemail is enabled for this organization","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The organization's default number of seconds to ring a user's phone before a call is transferred to voicemail"},"pinConfiguration":{"description":"The configuration for user PINs to access their voicemail from a phone","$ref":"#/definitions/PINConfiguration"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval. The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone."},"interactiveResponseRequired":{"type":"boolean","description":"Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting."},"includeEmailTranscriptions":{"type":"boolean","description":"Whether to include the voicemail transcription in the notification email"},"disableEmailPii":{"type":"boolean","description":"Removes any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization."},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32","description":"Default value for the maximum length of time in seconds of a recorded voicemail"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/VoicemailMessage"}}}},"VoicemailSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["voicemailId","ownerId","ownerType","deleted","read","callerAddress","callerUser","createdDate","modifiedDate"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"]}}},"VoicemailSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}}}},"RegisterArchitectJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"presignedUrl":{"type":"string","description":"Presigned URL to upload the file in S3","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArchitectJobMessage":{"type":"object","properties":{"dateTime":{"type":"string","format":"date-time","description":"The DateTime when the message was generated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The message type.","enum":["Error","Warning"]},"text":{"type":"string","description":"The text of the message."}}},"ArchitectJobStateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"Flow created from the Architect Job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"Status of the Architect Job","enum":["Registered","Started","Success","Failure"]},"command":{"type":"string","description":"The command executed by the Architect Job","enum":["Publish","Create","Update"]},"messages":{"type":"array","description":"Warnings and Errors messages of the Architect Job","items":{"$ref":"#/definitions/ArchitectJobMessage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The dependency type identifier"},"name":{"type":"string"},"versioned":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"User that initiated the build.","$ref":"#/definitions/User"},"client":{"description":"OAuth client that initiated the build.","$ref":"#/definitions/DomainEntityRef"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"DependencyTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmergencyCallFlow":{"type":"object","properties":{"emergencyFlow":{"description":"The call flow to execute in an emergency.","$ref":"#/definitions/DomainEntityRef"},"ivrs":{"type":"array","description":"The IVR(s) to route to the call flow during an emergency.","items":{"$ref":"#/definitions/DomainEntityRef"}}},"description":"An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it."},"EmergencyGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"enabled":{"type":"boolean","description":"True if an emergency is occurring and the associated emergency call flow(s) should be used. False otherwise."},"emergencyCallFlows":{"type":"array","description":"The emergency call flow(s) to use during an emergency.","items":{"$ref":"#/definitions/EmergencyCallFlow"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of emergency call flows to use in an emergency."},"EmergencyGroupDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The emergency group identifier"},"name":{"type":"string","description":"The emergency group name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of call flows."},"EmergencyGroupDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroupDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmergencyGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowRuntimeExecution":{"type":"object","required":["dateLaunched","flowVersion","status"],"properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The Version of the flow definition of the flow execution.","$ref":"#/definitions/FlowVersion"},"dateLaunched":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED","FAILED"]},"dateCompleted":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"outputData":{"type":"object","description":"List of the flow's output variables, if any. Output variables are only supplied for Completed flows.","additionalProperties":{"type":"object"}},"conversation":{"description":"The conversation to which this Flow execution is related","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow execution"},"FlowExecutionLaunchResponse":{"type":"object","properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The version of the flow that launched","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Response object from launching a flow."},"FlowExecutionLaunchRequest":{"type":"object","required":["flowId"],"properties":{"flowId":{"type":"string","description":"ID of the flow to launch."},"flowVersion":{"type":"string","description":"The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version."},"inputData":{"type":"object","description":"Input values to the flow. Valid values are defined by a flow's input JSON schema.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"A displayable name to assign to the new flow execution"}},"description":"Parameters for launching a flow."},"ConfusionInfo":{"type":"object","properties":{"intents":{"type":"array","description":"Confusion details between this utterance and other intents.","items":{"$ref":"#/definitions/ConfusionIntentInfo"}}}},"ConfusionIntentInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances in this intent which are similar to parent utterance."}}},"FlowHealthErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"messageWithParams":{"type":"string","description":"Error message with params included."},"messageParams":{"type":"object","description":"Map of variables and params for the error message.","additionalProperties":{"type":"object"}}}},"FlowHealthIntent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/FlowHealthIntentVersionInfo"},"language":{"type":"string","description":"Language provided for this intent's health.","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]},"health":{"description":"Health computation details for given language.","$ref":"#/definitions/HealthInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthIntentUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found for this utterance."},"staticValidationResults":{"type":"array","description":"Validation results for this utterance.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"outlierInfo":{"description":"Details about this utterance being an outlier or not.","$ref":"#/definitions/OutlierInfo"},"confusionInfo":{"description":"Confusion details with other utterances.","$ref":"#/definitions/ConfusionInfo"}}},"FlowHealthIntentVersionInfo":{"type":"object","properties":{"nluVersion":{"description":"NLU Version Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flowVersion":{"description":"Given flow's Version Info.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"nluDomain":{"description":"NLU Domain Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"HealthInfo":{"type":"object","properties":{"status":{"type":"string","description":"Status of health computation for this intent.","enum":["InProgress","Completed","Error"]},"errorInfo":{"description":"Error details for the intent, if any.","$ref":"#/definitions/FlowHealthErrorInfo"},"overallScore":{"type":"number","format":"float","description":"Overall health score for the intent ranged between 0 and 100 as 100 is the perfect health score."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found in the intent."},"staticValidationResults":{"type":"array","description":"Validation results for the intent.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"utterances":{"type":"array","description":"Utterances for this intent.","items":{"$ref":"#/definitions/FlowHealthIntentUtterance"}}}},"OutlierInfo":{"type":"object","properties":{"outlier":{"type":"boolean","description":"Boolean to identify if an outlier or not."},"score":{"type":"number","format":"float","description":"Outlier score for this utterance. The score is always 0 or greater and higher the score, the more outlier."}}},"ConfusionDetails":{"type":"object","properties":{"intents":{"type":"array","description":"Confusion details between this utterance and other intents.","items":{"$ref":"#/definitions/ConfusionIntentDetails"}}}},"ConfusionIntentDetails":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances in this intent which are similar to parent utterance."},"utterances":{"type":"array","description":"List of utterance which are similar to parent utterance.","items":{"$ref":"#/definitions/ConfusionUtterance"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConfusionUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"similarity":{"type":"number","format":"float","description":"Utterance's similarity score, 0 being dissimilar and 1 being very similar."}}},"FlowHealthUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found for this utterance."},"language":{"type":"string","description":"Language provided for this utterance's health.","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]},"staticValidationResults":{"type":"array","description":"Validation results for the utterance.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"outlierInfo":{"description":"Details about this utterance being an outlier or not.","$ref":"#/definitions/OutlierInfo"},"confusionInfo":{"description":"Confusion details with other utterances.","$ref":"#/definitions/ConfusionDetails"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealth":{"type":"object","properties":{"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/FlowHealthVersionInfo"},"languageInfo":{"type":"object","description":"Each language's status about its health computation.","additionalProperties":{"$ref":"#/definitions/LocaleInfo"}},"intents":{"type":"array","description":"Health metrics information for the intents.","items":{"$ref":"#/definitions/FlowHealthIntentInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthIntentInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageHealth":{"type":"object","description":"Health computation info for each language.","additionalProperties":{"$ref":"#/definitions/LocaleHealth"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthVersionInfo":{"type":"object","properties":{"flowVersion":{"description":"Given flow's Version Info.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"nluDomain":{"description":"NLU Domain Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LocaleFlowVersionInfo":{"type":"object","properties":{"nluVersion":{"description":"NLU Version Info for this flow version.","$ref":"#/definitions/AddressableEntityRef"}}},"LocaleHealth":{"type":"object","properties":{"overallScore":{"type":"number","format":"float","description":"Overall health score for the intent."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found in the intent."},"staticValidationResults":{"type":"array","description":"Validation results for the intent.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}}}},"LocaleInfo":{"type":"object","properties":{"status":{"type":"string","description":"Status of health computation for this flow version.","enum":["InProgress","Completed","Error"]},"errorInfo":{"description":"Error details for the flow version, if any.","$ref":"#/definitions/FlowHealthErrorInfo"},"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/LocaleFlowVersionInfo"}}},"FlowMilestone":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier","readOnly":true},"name":{"type":"string","description":"The flow milestone name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The flow milestone description."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowMilestoneDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier"},"name":{"type":"string","description":"The flow milestone name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowMilestoneDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestoneDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowMilestoneListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowOutcome":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"currentOperation":{"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowOutcomeDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowOutcomeDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcomeDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowOutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HistoryEntry":{"type":"object","properties":{"action":{"type":"string","description":"The action performed","enum":["CHECKIN","CHECKOUT","CREATE","DEACTIVATE","DEBUG","DELETE","PUBLISH","REVERT","SAVE","TRANSCODE","UPDATE","UPLOAD"]},"resource":{"type":"string","description":"For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name. For example, for actions performed on prompt resources, this will be the prompt resource name."},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"User associated with this entry.","$ref":"#/definitions/User"},"client":{"description":"OAuth client associated with this entry.","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"string"},"secure":{"type":"boolean"}}},"HistoryListing":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","CHECKOUT","DEBUG","DELETE","HISTORY","PUBLISH","REVERT","SAVE","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"},"started":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completed":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/HistoryEntry"}},"pageCount":{"type":"integer","format":"int32"}}},"FlowVersionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"description":{"type":"string","description":"the flow description"},"inputSchema":{"description":"json schema describing the inputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"description":"json schema describing the outputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"publishedVersion":{"description":"published version information if there is a published version","$ref":"#/definitions/FlowVersion"},"debugVersion":{"description":"debug version information if there is a debug version","$ref":"#/definitions/FlowVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IVR":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"dnis":{"type":"array","description":"The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number.","items":{"type":"string"}},"openHoursFlow":{"description":"The Architect flow to execute during the hours an organization is open.","$ref":"#/definitions/DomainEntityRef"},"closedHoursFlow":{"description":"The Architect flow to execute during the hours an organization is closed.","$ref":"#/definitions/DomainEntityRef"},"holidayHoursFlow":{"description":"The Architect flow to execute during an organization's holiday hours.","$ref":"#/definitions/DomainEntityRef"},"scheduleGroup":{"description":"The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR."},"IVREntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IVRDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The ivr identifier"},"name":{"type":"string","description":"The ivr name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An ivr."},"IVRDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVRDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"Prompt resource language","readOnly":true},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAssetCreate":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"The prompt language."},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Prompt":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The prompt identifier"},"name":{"type":"string","description":"The prompt name."},"description":{"type":"string"},"resources":{"type":"array","description":"List of resources associated with this prompt","readOnly":true,"items":{"$ref":"#/definitions/PromptAsset"}},"currentOperation":{"description":"Current prompt operation status","readOnly":true,"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"timeZone":{"type":"string","description":"The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones."},"openSchedules":{"type":"array","description":"The schedules defining the hours an organization is open.","items":{"$ref":"#/definitions/DomainEntityRef"}},"closedSchedules":{"type":"array","description":"The schedules defining the hours an organization is closed.","items":{"$ref":"#/definitions/DomainEntityRef"}},"holidaySchedules":{"type":"array","description":"The schedules defining the hours an organization is closed for the holidays.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of schedules that define the operating hours of an organization."},"ScheduleGroupDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The schedule group identifier"},"name":{"type":"string","description":"The schedule group name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A schedule group."},"ScheduleGroupDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroupDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Schedule":{"type":"object","required":["end","name","start"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string. It is required to be set for schedules determining when upgrades to the Edge software can be applied."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used."},"ScheduleDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SchedulesDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchedulesDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The schedule identifier"},"name":{"type":"string","description":"The schedule name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A schedule."},"ScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPromptAsset":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string","description":"The asset resource language"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"text":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["created","uploaded","transcoded","transcodeFailed"]},"hasDefault":{"type":"boolean"},"languageDefault":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The system prompt identifier"},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WebChatConfig":{"type":"object","properties":{"webChatSkin":{"type":"string","description":"css class to be applied to the web chat widget.","enum":["basic","modern-caret-skin"]}}},"WebChatDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"authenticationRequired":{"type":"boolean"},"authenticationUrl":{"type":"string","description":"URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples"},"disabled":{"type":"boolean"},"webChatConfig":{"$ref":"#/definitions/WebChatConfig"},"allowedDomains":{"type":"array","items":{"type":"string"}},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"WebChatSettings":{"type":"object","properties":{"requireDeployment":{"type":"boolean"}}},"WebChatGuestMediaRequest":{"type":"object","required":["state","types"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"types":{"type":"array","description":"The types of media being requested.","items":{"type":"string","enum":["COBROWSE","SCREENSHARE"]}},"state":{"type":"string","description":"The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED.","enum":["PENDING","ACCEPTED","DECLINED","TIMEDOUT","CANCELLED","ERRORED"]},"communicationId":{"type":"string","description":"The ID of the new media communication, if applicable."},"securityKey":{"type":"string","description":"The security information related to a media request."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Object representing the guest model of a media request of a chat conversation."},"WebChatGuestMediaRequestEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}}},"WebChatMemberInfoEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMemberInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentVideoSettings":{"type":"object","properties":{"allowCamera":{"type":"boolean","description":"whether or not agent camera is allowed"},"allowScreenShare":{"type":"boolean","description":"whether or not agent screen share is allowed"},"background":{"type":"string","description":"background for agent","enum":["BLUR","NONE","IMAGE"]},"backgroundImage":{"description":"background image settings for agent","$ref":"#/definitions/BackgroundImageSettings"}},"description":"The settings for Agent Video"},"AuthenticationSettings":{"type":"object","required":["enabled","integrationId"],"properties":{"enabled":{"type":"boolean","description":"Indicate if these auth is required for this deployment. If, for example, this flag is set to true then webmessaging sessions can not send messages unless the end-user is authenticated."},"integrationId":{"type":"string","description":"The integration identifier which contains the auth settings required on the deployment."},"allowSessionUpgrade":{"type":"boolean","description":"Allow end-users to upgrade an anonymous session to authenticated conversation."}},"description":"Settings for authenticated webdeployments."},"AutoStart":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not auto start is enabled"}}},"BackgroundImageSettings":{"type":"object","properties":{"url":{"type":"string","description":"BackgroundImage URL for agent video settings"}},"description":"The settings to Agent Video background image"},"BotMessengerProfile":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Bot"},"avatarUrl":{"type":"string","description":"Avatar for Bot"}}},"CobrowseSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not cobrowse is enabled"},"allowAgentControl":{"type":"boolean","description":"Whether the viewer should have option to request control"},"allowAgentNavigation":{"type":"boolean","description":"Whether the viewer should have option to request navigation"},"maskSelectors":{"type":"array","description":"Mask patterns that will apply to pages being shared","items":{"type":"string"}},"channels":{"type":"array","description":"Cobrowse channels for web messenger","items":{"type":"string","enum":["Webmessaging","Voice"]}},"readonlySelectors":{"type":"array","description":"Readonly patterns that will apply to pages being shared","items":{"type":"string"}}},"description":"Settings concerning cobrowse"},"ConversationAppSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The toggle to enable or disable conversations"},"showAgentTypingIndicator":{"type":"boolean","description":"The toggle to enable or disable typing indicator for messenger"},"showUserTypingIndicator":{"type":"boolean","description":"The toggle to enable or disable typing indicator for messenger"},"autoStart":{"description":"The auto start for the messenger conversation","$ref":"#/definitions/AutoStart"},"markdown":{"description":"The markdown for the messenger app","$ref":"#/definitions/Markdown"},"conversationDisconnect":{"description":"The conversation disconnect settings for the messenger app","$ref":"#/definitions/ConversationDisconnectSettings"},"conversationClear":{"description":"The conversation clear settings for the messenger app","$ref":"#/definitions/ConversationClearSettings"},"humanize":{"description":"The humanize conversations settings for the messenger app","$ref":"#/definitions/Humanize"}},"description":"Conversation settings that handles chats within the messenger"},"ConversationClearSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not conversation clear setting is enabled"}}},"ConversationDisconnectSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not conversation disconnect setting is enabled"},"type":{"type":"string","description":"Conversation disconnect type","enum":["Send","ReadOnly"]}}},"CustomI18nLabels":{"type":"object","properties":{"language":{"type":"string","description":"Language of localized labels in homescreen app (eg. en-us, de-de)"},"localizedLabels":{"type":"array","description":"Contains localized labels used in homescreen app","items":{"$ref":"#/definitions/LocalizedLabels"}}},"description":"The localization settings for homescreen"},"FileUploadMode":{"type":"object","properties":{"fileTypes":{"type":"array","description":"A list of supported content types for uploading files","items":{"type":"string","enum":["image/jpeg","image/gif","image/png"]}},"maxFileSizeKB":{"type":"integer","format":"int64","description":"The maximum file size for file uploads in kilobytes. Default is 10240 (10 MB)"}}},"FileUploadSettings":{"type":"object","properties":{"enableAttachments":{"type":"boolean","description":"whether or not attachments is enabled"},"modes":{"type":"array","description":"The list of supported file upload modes","items":{"$ref":"#/definitions/FileUploadMode"}}},"description":"File upload settings for messenger"},"FormsTrackTrigger":{"type":"object","required":["captureDataOnFormAbandon","captureDataOnFormSubmit","formName","selector"],"properties":{"selector":{"type":"string","description":"Form element that triggers the form submitted or abandoned event."},"formName":{"type":"string","description":"Prefix for the form submitted or abandoned event name."},"captureDataOnFormAbandon":{"type":"boolean","description":"Whether to capture the form data in the form abandoned event."},"captureDataOnFormSubmit":{"type":"boolean","description":"Whether to capture the form data in the form submitted event."}},"description":"Details about a forms tracking event trigger"},"Humanize":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not humanize conversations setting is enabled"},"bot":{"description":"Bot messenger profile setting","$ref":"#/definitions/BotMessengerProfile"}}},"IdleEventTrigger":{"type":"object","required":["eventName"],"properties":{"eventName":{"type":"string","description":"Name of event triggered after period of inactivity."},"idleAfterSeconds":{"type":"integer","format":"int64","description":"Number of seconds of inactivity before an event is triggered."}},"description":"Details about an idle event trigger"},"JourneyEventsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not journey event collection is enabled."},"excludedQueryParameters":{"type":"array","description":"List of parameters to be excluded from the query string.","items":{"type":"string"}},"shouldKeepUrlFragment":{"type":"boolean","description":"Whether or not to keep the URL fragment."},"searchQueryParameters":{"type":"array","description":"List of query parameters used for search (e.g. 'q').","items":{"type":"string"}},"pageviewConfig":{"type":"string","description":"Controls how the pageview events are tracked.","enum":["Auto","Once","Off"]},"clickEvents":{"type":"array","description":"Tracks when and where a visitor clicks on a webpage.","items":{"$ref":"#/definitions/SelectorEventTrigger"}},"formsTrackEvents":{"type":"array","description":"Controls how the form submitted and form abandoned events are tracked after a visitor interacts with a form element.","items":{"$ref":"#/definitions/FormsTrackTrigger"}},"idleEvents":{"type":"array","description":"Tracks when and where a visitor becomes inactive on a webpage.","items":{"$ref":"#/definitions/IdleEventTrigger"}},"inViewportEvents":{"type":"array","description":"Tracks when elements become visible or hidden on screen.","items":{"$ref":"#/definitions/SelectorEventTrigger"}},"scrollDepthEvents":{"type":"array","description":"Tracks when a visitor scrolls to a specific percentage of a webpage.","items":{"$ref":"#/definitions/ScrollPercentageEventTrigger"}}},"description":"Settings concerning journey events"},"Knowledge":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not knowledge base is enabled"},"knowledgeBase":{"description":"The knowledge base for messenger","$ref":"#/definitions/AddressableEntityRef"}}},"LauncherButtonSettings":{"type":"object","properties":{"visibility":{"type":"string","description":"The visibility settings for the button","enum":["On","Off","OnDemand"]}},"description":"The settings for the launcher button"},"LocalizedLabels":{"type":"object","properties":{"key":{"type":"string","description":"Contains localized label key used in messenger homescreen","enum":["MessengerHomeHeaderTitle","MessengerHomeHeaderSubTitle"]},"value":{"type":"string","description":"Contains localized label value used in messenger homescreen"}},"description":"Contains localized labels used in messenger apps"},"Markdown":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not markdown is enabled"}}},"MessengerApps":{"type":"object","properties":{"conversations":{"description":"The conversation settings that handles chats within the messenger","$ref":"#/definitions/ConversationAppSettings"},"knowledge":{"description":"The knowledge base config for messenger","$ref":"#/definitions/Knowledge"}},"description":"The apps embedded in the messenger"},"MessengerHomeScreen":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not homescreen is enabled"},"logoUrl":{"type":"string","description":"to capture uploaded company logoUrl"}}},"MessengerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not messenger is enabled"},"styles":{"description":"The style settings for messenger","$ref":"#/definitions/MessengerStyles"},"launcherButton":{"description":"The launcher button settings for messenger","$ref":"#/definitions/LauncherButtonSettings"},"fileUpload":{"description":"The file upload settings for messenger","$ref":"#/definitions/FileUploadSettings"},"apps":{"description":"The apps embedded in the messenger","$ref":"#/definitions/MessengerApps"},"homeScreen":{"description":"The homescreen settings for messenger","$ref":"#/definitions/MessengerHomeScreen"}},"description":"Settings concerning messenger"},"MessengerStyles":{"type":"object","properties":{"primaryColor":{"type":"string","example":"#a7017c","description":"The primary color of messenger in hexadecimal"}}},"PauseCriteria":{"type":"object","properties":{"urlFragment":{"type":"string"},"condition":{"type":"string","enum":["Includes","DoesNotInclude","StartsWith","EndsWith","Equals"]}}},"PositionSettings":{"type":"object","properties":{"alignment":{"type":"string","description":"The alignment for position","enum":["Auto","Left","Right"]},"sideSpace":{"type":"integer","format":"int32","description":"The sidespace value for position"},"bottomSpace":{"type":"integer","format":"int32","description":"The bottomspace value for position"}},"description":"Settings concerning position"},"ScrollPercentageEventTrigger":{"type":"object","required":["eventName","percentage"],"properties":{"percentage":{"type":"integer","format":"int32","description":"Percentage of a webpage at which an event is triggered."},"eventName":{"type":"string","description":"Name of event triggered after scrolling to the specified percentage."}},"description":"Details about a scroll percentage event trigger"},"SelectorEventTrigger":{"type":"object","required":["eventName","selector"],"properties":{"selector":{"type":"string","description":"Element that triggers event."},"eventName":{"type":"string","description":"Name of event triggered when element matching selector is interacted with."}},"description":"Details about a selector event trigger"},"SupportCenterCategory":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"selfUri":{"type":"string","format":"uri"},"image":{"description":"Image attributes for a featured category","$ref":"#/definitions/SupportCenterImage"}}},"SupportCenterCompactCategoryModuleTemplate":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Whether this template is active or not"}}},"SupportCenterCustomMessage":{"type":"object","required":["defaultValue","type"],"properties":{"defaultValue":{"type":"string","description":"Default value for the message","minLength":0,"maxLength":300},"type":{"type":"string","description":"Type of the message","enum":["Welcome","Fallback"]}}},"SupportCenterDetailedCategoryModuleSidebar":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether sidebar is enabled or not"}}},"SupportCenterDetailedCategoryModuleTemplate":{"type":"object","required":["active","sidebar"],"properties":{"active":{"type":"boolean","description":"Whether this template is active or not"},"sidebar":{"description":"Sidebar settings for the template","$ref":"#/definitions/SupportCenterDetailedCategoryModuleSidebar"}}},"SupportCenterFeedbackSettings":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether or not requesting customer feedback on article content and article search results is enabled"}}},"SupportCenterGlobalStyle":{"type":"object","required":["backgroundColor","fontFamily","primaryColor","primaryColorDark","primaryColorLight","textColor"],"properties":{"backgroundColor":{"type":"string","description":"Global background color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColor":{"type":"string","description":"Global primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColorDark":{"type":"string","description":"Global dark primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColorLight":{"type":"string","description":"Global light primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"textColor":{"type":"string","description":"Global text color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fontFamily":{"type":"string","description":"Global font family"}}},"SupportCenterHeroStyle":{"type":"object","required":["backgroundColor","textColor"],"properties":{"backgroundColor":{"type":"string","description":"Background color for hero section, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"textColor":{"type":"string","description":"Text color for hero section, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"image":{"description":"Background image for hero section","$ref":"#/definitions/SupportCenterImage"}}},"SupportCenterImage":{"type":"object","required":["source"],"properties":{"source":{"description":"Source URLs for image","$ref":"#/definitions/SupportCenterImageSource"}}},"SupportCenterImageSource":{"type":"object","required":["defaultUrl"],"properties":{"defaultUrl":{"type":"string","description":"Default URL for image"}}},"SupportCenterModuleSetting":{"type":"object","required":["enabled","type"],"properties":{"type":{"type":"string","description":"Screen module type","enum":["Search","Categories","FAQ","Contact","Results","Article","TopViewedArticles"]},"enabled":{"type":"boolean","description":"Whether or not knowledge portal (previously support center) screen module is enabled"},"compactCategoryModuleTemplate":{"description":"Compact category module template","$ref":"#/definitions/SupportCenterCompactCategoryModuleTemplate"},"detailedCategoryModuleTemplate":{"description":"Detailed category module template","$ref":"#/definitions/SupportCenterDetailedCategoryModuleTemplate"}}},"SupportCenterScreen":{"type":"object","required":["moduleSettings","type"],"properties":{"type":{"type":"string","description":"The type of the screen","enum":["Home","Category","SearchResults","Article"]},"moduleSettings":{"type":"array","description":"Module settings for the screen, valid modules for each screenType: Home: Search, Categories, TopViewedArticles; Category: Search, Categories; SearchResults: Search, Results; Article: Search, Article;","items":{"$ref":"#/definitions/SupportCenterModuleSetting"}}}},"SupportCenterSettings":{"type":"object","required":["enabled","enabledCategories","knowledgeBase","screens","styleSetting"],"properties":{"enabled":{"type":"boolean","description":"Whether or not knowledge portal (previously support center) is enabled"},"knowledgeBase":{"description":"The knowledge base for knowledge portal (previously support center)","$ref":"#/definitions/AddressableEntityRef"},"customMessages":{"type":"array","description":"Customizable display texts for knowledge portal (previously support center)","items":{"$ref":"#/definitions/SupportCenterCustomMessage"}},"routerType":{"type":"string","description":"Router type for knowledge portal (previously support center)","enum":["Hash","Browser"]},"screens":{"type":"array","description":"Available screens for the knowledge portal (previously support center) with its modules","items":{"$ref":"#/definitions/SupportCenterScreen"}},"enabledCategories":{"type":"array","description":"Featured categories for knowledge portal (previously support center) home screen","items":{"$ref":"#/definitions/SupportCenterCategory"}},"styleSetting":{"description":"Style attributes for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterStyleSetting"},"feedback":{"description":"Customer feedback settings","$ref":"#/definitions/SupportCenterFeedbackSettings"}},"description":"Settings concerning knowledge portal (previously support center)"},"SupportCenterStyleSetting":{"type":"object","required":["globalStyle","heroStyle"],"properties":{"heroStyle":{"description":"Knowledge portal (previously support center) hero customizations","$ref":"#/definitions/SupportCenterHeroStyle"},"globalStyle":{"description":"Knowledge portal (previously support center) global customizations","$ref":"#/definitions/SupportCenterGlobalStyle"}}},"UserVideoSettings":{"type":"object","properties":{"allowCamera":{"type":"boolean","description":"whether or not user camera is allowed"},"allowScreenShare":{"type":"boolean","description":"whether or not user screen share is allowed"}},"description":"The settings for User Video"},"VideoSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not video is enabled"},"agent":{"description":"Video Settings for agent","$ref":"#/definitions/AgentVideoSettings"},"user":{"description":"Video Settings for user","$ref":"#/definitions/UserVideoSettings"}},"description":"The settings to enable video chat"},"WebDeploymentConfigurationVersion":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The configuration version ID","readOnly":true},"name":{"type":"string","description":"The configuration version name"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration","readOnly":true},"headlessMode":{"description":"Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.","$ref":"#/definitions/WebDeploymentHeadlessMode"},"description":{"type":"string","description":"The description of the configuration"},"languages":{"type":"array","example":"en-us, de-de","description":"A list of languages supported on the configuration required if the messenger is enabled","items":{"type":"string"}},"defaultLanguage":{"type":"string","example":"en-us, de-de","description":"The default language to use for the configuration required if the messenger is enabled"},"customI18nLabels":{"type":"array","description":"The localization settings for homescreen app","items":{"$ref":"#/definitions/CustomI18nLabels"}},"messenger":{"description":"The settings for messenger","$ref":"#/definitions/MessengerSettings"},"position":{"description":"The settings for position","$ref":"#/definitions/PositionSettings"},"supportCenter":{"description":"The settings for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterSettings"},"cobrowse":{"description":"The settings for cobrowse","$ref":"#/definitions/CobrowseSettings"},"journeyEvents":{"description":"The settings for journey events","$ref":"#/definitions/JourneyEventsSettings"},"authenticationSettings":{"description":"The settings for authenticated deployments","$ref":"#/definitions/AuthenticationSettings"},"dateCreated":{"type":"string","format":"date-time","description":"The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"createdUser":{"description":"A reference to the user who created the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"publishedUser":{"description":"A reference to the user who published the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The current status of the configuration version","enum":["Pending","Active","Inactive","Error","Deleting"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the configuration version of a Web Deployment"},"WebDeploymentHeadlessMode":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not Headless Mode is enabled"}}},"WebDeploymentConfigurationVersionEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"selfUri":{"type":"string","format":"uri"}}},"WebDeployment":{"type":"object","required":["configuration","name"],"properties":{"id":{"type":"string","description":"The deployment ID","readOnly":true},"name":{"type":"string","description":"The deployment name"},"description":{"type":"string","description":"The description of the config"},"allowAllDomains":{"type":"boolean","description":"Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true."},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"supportedContent":{"description":"The supported content profile for a deployment","$ref":"#/definitions/SupportedContentReference"},"snippet":{"type":"string","description":"Javascript snippet used to load the config","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the deployment","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flow":{"description":"A reference to the inboundshortmessage flow used by this deployment","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"The current status of the deployment","enum":["Pending","Active","Inactive","Error","Deleting"]},"configuration":{"description":"The config version this deployment uses","$ref":"#/definitions/WebDeploymentConfigurationVersionEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a Web Deployment"},"WebDeploymentConfigurationVersionEntityRef":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The configuration version ID"},"name":{"type":"string","description":"The configuration version name"},"selfUri":{"type":"string","format":"uri"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration"}}},"WebDeploymentActiveConfigurationOnDeployment":{"type":"object","properties":{"configurationVersion":{"description":"The active configuration on a deployment","$ref":"#/definitions/WebDeploymentConfigurationVersion"},"deployment":{"description":"The web deployment associated with the active configuration","$ref":"#/definitions/WebDeployment"}},"description":"Details about the active configuration on a deployment"},"ExpandableWebDeployment":{"type":"object","required":["configuration","name"],"properties":{"id":{"type":"string","description":"The deployment ID","readOnly":true},"name":{"type":"string","description":"The deployment name"},"description":{"type":"string","description":"The description of the config"},"allowAllDomains":{"type":"boolean","description":"Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true."},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"supportedContent":{"description":"The supported content profile for a deployment","$ref":"#/definitions/SupportedContentReference"},"snippet":{"type":"string","description":"Javascript snippet used to load the config","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the deployment","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flow":{"description":"A reference to the inboundshortmessage flow used by this deployment","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"The current status of the deployment","enum":["Pending","Active","Inactive","Error","Deleting"]},"configuration":{"description":"The config version this deployment uses","$ref":"#/definitions/WebDeploymentConfigurationVersionResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a Web Deployment"},"ExpandableWebDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExpandableWebDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"WebDeploymentConfigurationVersionResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The configuration version ID"},"name":{"type":"string","description":"The configuration version name"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration"},"headlessMode":{"description":"Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.","$ref":"#/definitions/WebDeploymentHeadlessMode"},"description":{"type":"string","description":"The description of the configuration"},"languages":{"type":"array","example":"en-us, de-de","description":"A list of languages supported on the configuration required if the messenger is enabled","items":{"type":"string"}},"defaultLanguage":{"type":"string","example":"en-us, de-de","description":"The default language to use for the configuration required if the messenger is enabled"},"customI18nLabels":{"type":"array","description":"The localization settings for homescreen app","items":{"$ref":"#/definitions/CustomI18nLabels"}},"messenger":{"description":"The settings for messenger","$ref":"#/definitions/MessengerSettings"},"position":{"description":"The settings for position","$ref":"#/definitions/PositionSettings"},"supportCenter":{"description":"The settings for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterSettings"},"cobrowse":{"description":"The settings for cobrowse","$ref":"#/definitions/CobrowseSettings"},"journeyEvents":{"description":"The settings for journey events","$ref":"#/definitions/JourneyEventsSettings"},"authenticationSettings":{"description":"The settings for authenticated deployments","$ref":"#/definitions/AuthenticationSettings"},"dateCreated":{"type":"string","format":"date-time","description":"The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"createdUser":{"description":"A reference to the user who created the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"publishedUser":{"description":"A reference to the user who published the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The current status of the configuration version","enum":["Pending","Active","Inactive","Error","Deleting"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the configuration version of a Web Deployment"},"WebMessagingAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","readOnly":true,"enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment.","readOnly":true},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml).","readOnly":true},"text":{"type":"string","description":"Text associated with attachment such as an image caption.","readOnly":true},"sha256":{"type":"string","description":"Secure hash of the attachment content.","readOnly":true},"filename":{"type":"string","description":"Suggested file name for attachment.","readOnly":true},"fileSize":{"type":"integer","format":"int32","description":"The file size associated with the file","readOnly":true}},"description":"Attachment object."},"WebMessagingButtonResponse":{"type":"object","required":["payload","text"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"WebMessagingChannel":{"type":"object","properties":{"from":{"description":"Information about the recipient the message is received from.","readOnly":true,"$ref":"#/definitions/WebMessagingRecipient"},"to":{"description":"Information about the recipient the message is sent to.","readOnly":true,"$ref":"#/definitions/WebMessagingRecipient"},"time":{"type":"string","format":"date-time","description":"When the message was processed by Genesys Cloud. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"messageId":{"type":"string","description":"Unique provider ID of the message.","readOnly":true}},"description":"Channel-specific information that describes the message and the message channel/provider."},"WebMessagingContent":{"type":"object","properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","readOnly":true,"enum":["Attachment","QuickReply","ButtonResponse","GenericTemplate","Card","Carousel"]},"attachment":{"description":"Attachment content.","readOnly":true,"$ref":"#/definitions/WebMessagingAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/WebMessagingQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/WebMessagingButtonResponse"},"generic":{"description":"Generic content (Deprecated).","$ref":"#/definitions/WebMessagingGeneric"},"card":{"description":"Card content","$ref":"#/definitions/ContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ContentCarousel"}},"description":"Message content element."},"WebMessagingEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Presence"]},"coBrowse":{"description":"Cobrowse event.","$ref":"#/definitions/WebMessagingEventCoBrowse"},"presence":{"description":"Presence event.","$ref":"#/definitions/WebMessagingEventPresence"}},"description":"Message event element. Examples include: system messages, typing indicators, cobrowse offerings."},"WebMessagingEventCoBrowse":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Cobrowse event.","enum":["Offering","OfferingExpired","OfferingAccepted","OfferingRejected"]},"sessionId":{"type":"string","description":"The Cobrowse session ID."},"sessionJoinToken":{"type":"string","description":"The Cobrowse session join token."}},"description":"A Cobrowse event."},"WebMessagingEventPresence":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Presence event.","enum":["Join","Disconnect","Clear","SignIn"]}},"description":"A Presence event."},"WebMessagingGeneric":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"actions":{"description":"Actions to be taken.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Generic content object. (Deprecated"},"WebMessagingMessage":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/WebMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/WebMessagingContent"}},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/WebMessagingEvent"}},"direction":{"type":"string","description":"The direction of the message. Direction is always from the perspective of the Genesys Cloud platform. An Inbound message is one sent from a guest to the Genesys Cloud Platform. An Outbound message is one sent from the Genesys Cloud Platform to a guest.","enum":["Inbound","Outbound"]},"originatingEntity":{"type":"string","description":"Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.","enum":["Human","Bot"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"A web messaging message"},"WebMessagingMessageEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebMessagingMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"WebMessagingQuickReply":{"type":"object","required":["payload","text"],"properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object"},"WebMessagingRecipient":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/RecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to or received from."},"CoachingAnnotation":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"The user who created the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"text":{"type":"string","description":"The text of the annotation."},"isDeleted":{"type":"boolean","description":"Flag indicating whether the annotation is deleted.","readOnly":true},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","readOnly":true,"enum":["Public","Private"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAnnotationCreateRequest":{"type":"object","required":["accessType","text"],"properties":{"text":{"type":"string","description":"The text of the annotation."},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","enum":["Public","Private"]}}},"CoachingAnnotationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAnnotation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddConversationResponse":{"type":"object","properties":{"conversation":{"description":"The conversation reference","readOnly":true,"$ref":"#/definitions/ConversationReference"},"appointment":{"description":"The appointment reference","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"}}},"CoachingAppointmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddConversationRequest":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The id of the conversation to add"}},"description":"Update coaching appointment request"},"CoachingAppointmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of coaching appointment","readOnly":true},"description":{"type":"string","description":"The description of coaching appointment","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes","readOnly":true},"status":{"type":"string","description":"The status of coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"facilitator":{"description":"The facilitator of coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"attendees":{"type":"array","description":"The list of attendees attending the coaching","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"createdBy":{"description":"The user who created the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversations":{"type":"array","description":"The list of conversations associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/ConversationReference"}},"documents":{"type":"array","description":"The list of documents associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/DocumentReference"}},"isOverdue":{"type":"boolean","description":"Whether the appointment is overdue.","readOnly":true},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"},"dateCompleted":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was set to completed status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Coaching appointment response"},"DocumentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmBusinessUnitReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the business unit"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmScheduleReference":{"type":"object","required":["businessUnit","id","weekDate"],"properties":{"id":{"type":"string","description":"The ID of the WFM schedule"},"businessUnit":{"description":"A reference to a Workforce Management Business Unit","$ref":"#/definitions/WfmBusinessUnitReference"},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateCoachingAppointmentRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"status":{"type":"string","description":"The status of the coaching appointment.","enum":["Scheduled","InProgress","Completed"]},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","$ref":"#/definitions/WfmScheduleReference"},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","items":{"type":"string"}}},"description":"Update coaching appointment request"},"CoachingAppointmentStatusResponse":{"type":"object","properties":{"appointment":{"description":"The coaching appointment this status belongs to","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"},"createdBy":{"description":"User who updated the status","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]}}},"CoachingAppointmentStatusResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the coaching appointment","enum":["Scheduled","InProgress","Completed"]}}},"CoachingAppointmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/QueryResponseGroupedData"}}}},"QueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},"metrics":{"type":"array","description":"A list of aggregated metrics","items":{"$ref":"#/definitions/QueryResponseMetric"}}}},"QueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/QueryResponseData"}}}},"QueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/QueryResponseStats"}}},"QueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"CoachingAppointmentAggregateRequest":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"A list of metrics to aggregate. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"]}},"groupBy":{"type":"array","description":"An optional list of items by which to group the result data.","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data","$ref":"#/definitions/QueryRequestFilter"}}},"QueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/QueryRequestPredicate"}}}},"QueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data","items":{"$ref":"#/definitions/QueryRequestClause"}}}},"QueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"The dimension to be filtered","enum":["attendeeId","facilitatorId","status"]},"value":{"type":"string","description":"The value to filter by"}}},"CreateCoachingAppointmentRequest":{"type":"object","required":["attendeeIds","dateStart","description","lengthInMinutes","name"],"properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"facilitatorId":{"type":"string","description":"The facilitator ID of coaching appointment."},"attendeeIds":{"type":"array","description":"IDs of attendees in the coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","$ref":"#/definitions/WfmScheduleReference"},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","items":{"type":"string"}}},"description":"Create coaching appointment request"},"CoachingAppointmentResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the appointment for this notification.","readOnly":true},"markedAsRead":{"type":"boolean","description":"Indicates if notification is read or unread"},"actionType":{"type":"string","description":"Action causing the notification.","readOnly":true,"enum":["Create","Update","Delete","StatusChange"]},"relationship":{"type":"string","description":"The relationship of this user to this notification's appointment","readOnly":true,"enum":["Attendee","Creator","Facilitator"]},"dateStart":{"type":"string","format":"date-time","description":"The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of the appointment on this notification","readOnly":true},"status":{"type":"string","description":"The status of the appointment for this notification","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"user":{"description":"The user of this notification","readOnly":true,"$ref":"#/definitions/UserReference"},"appointment":{"description":"The appointment","readOnly":true,"$ref":"#/definitions/CoachingAppointmentResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingNotificationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingNotification"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AvailableTime":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start of the availability period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of availability period in minutes","readOnly":true},"isPaid":{"type":"boolean","description":"Indicates if this availability period is paid in Workforce Management schedule","readOnly":true},"activityCategory":{"type":"string","description":"Workforce Management activity category for this availability period","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]},"wfmSchedule":{"description":"Workforce Management schedule information associated with the available time","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"}}},"CoachingSlot":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start date and time of scheduled coaching appointment slot. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of coaching appointment slot in minutes","readOnly":true},"staffingDifference":{"type":"number","format":"double","description":"Difference between scheduled and forecast headcount for this slot after scheduling the coaching appointment","readOnly":true},"differenceRating":{"type":"string","description":"Rating based on the staffing difference for scheduled slot","readOnly":true,"enum":["Poor","Neutral","Good"]},"wfmSchedule":{"description":"Workforce Management schedule information associated with the slot","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"}}},"CoachingSlotsResponse":{"type":"object","properties":{"suggestedSlots":{"type":"array","description":"List of slots where coaching appointment can be scheduled","readOnly":true,"items":{"$ref":"#/definitions/CoachingSlot"}},"attendeeSchedules":{"type":"array","description":"Periods of availability for attendees to schedule coaching appointment","readOnly":true,"items":{"$ref":"#/definitions/UserAvailableTimes"}},"facilitatorSchedules":{"type":"array","description":"Periods of availability for facilitators to schedule coaching appointment","readOnly":true,"items":{"$ref":"#/definitions/UserAvailableTimes"}},"wfmScheduleActivities":{"type":"array","description":"Detailed data for WFM scheduled activities","readOnly":true,"items":{"$ref":"#/definitions/WfmScheduleActivity"}}}},"FullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"ScheduleActivity":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"UserAvailableTimes":{"type":"object","properties":{"user":{"description":"User reference","readOnly":true,"$ref":"#/definitions/UserReference"},"availableTimes":{"type":"array","description":"Periods of availability to schedule coaching appointment for an user","readOnly":true,"items":{"$ref":"#/definitions/AvailableTime"}}}},"WfmScheduleActivity":{"type":"object","properties":{"userReference":{"description":"ID of user that the schedule is for","readOnly":true,"$ref":"#/definitions/UserReference"},"activities":{"type":"array","description":"List of user's scheduled activities","readOnly":true,"items":{"$ref":"#/definitions/ScheduleActivity"}},"fullDayTimeOffMarkers":{"type":"array","description":"List of user's days off","readOnly":true,"items":{"$ref":"#/definitions/FullDayTimeOffMarker"}}}},"CoachingSlotsRequest":{"type":"object","required":["attendeeIds","interval","lengthInMinutes"],"properties":{"interval":{"type":"string","description":"Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes"},"attendeeIds":{"type":"array","description":"List of attendees to determine coaching appointment slots","uniqueItems":true,"items":{"type":"string"}},"facilitatorIds":{"type":"array","description":"List of facilitators to determine coaching appointment slots","uniqueItems":true,"items":{"type":"string"}},"interruptibleAppointmentIds":{"type":"array","description":"List of appointment ids to exclude from consideration when determining blocked slots","uniqueItems":true,"items":{"type":"string"}}}},"DevelopmentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created activity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date activity was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this activity","readOnly":true},"isPassed":{"type":"boolean","description":"True if the activity was passed","readOnly":true},"isLatest":{"type":"boolean","description":"True if this is the latest version of assignment assigned to the user"},"isModuleArchived":{"type":"boolean","description":"True if the associated module is archived"},"archivalMode":{"type":"string","description":"Module archive type","enum":["Graceful","Immediate"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","position":2,"description":"The name of the activity"},"type":{"type":"string","position":3,"description":"The type of activity","enum":["Informational","Coaching","AssessedContent","Assessment","External"]},"status":{"type":"string","position":4,"description":"The status of the activity","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"dateDue":{"type":"string","format":"date-time","position":5,"description":"Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"facilitator":{"position":6,"description":"Facilitator of the activity","$ref":"#/definitions/UserReference"},"attendees":{"type":"array","position":7,"description":"List of users attending the activity","items":{"$ref":"#/definitions/UserReference"}},"isOverdue":{"type":"boolean","position":8,"description":"Indicates if the activity is overdue"}},"description":"Development Activity object"},"DevelopmentActivityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DevelopmentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DevelopmentActivityAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseMetric"}}}},"DevelopmentActivityAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseData"}}}},"DevelopmentActivityAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseStatistics"}}},"DevelopmentActivityAggregateQueryResponseStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"},"min":{"type":"number","description":"The minimum value in this metric"},"max":{"type":"number","description":"The maximum value in this metric"},"sum":{"type":"number","description":"The total of the values for this metric"}}},"DevelopmentActivityAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseGroupedData"}}}},"DevelopmentActivityAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter.","$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestFilter"}}},"DevelopmentActivityAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestPredicate"}}}},"DevelopmentActivityAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestClause"}}}},"DevelopmentActivityAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId","isPassed"]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational, AssessedContent, Assessment, Coaching, External"}}},"AssessmentQuestionGroupScore":{"type":"object","required":["questionGroupId"],"properties":{"questionGroupId":{"type":"string","description":"The ID of the question group"},"totalScore":{"type":"number","format":"float","description":"The total score for the questions","readOnly":true},"maxTotalScore":{"type":"number","format":"float","description":"The maximum total score for the questions","readOnly":true},"markedNA":{"type":"boolean","description":"True if this question group is marked NA"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"totalCriticalScore":{"type":"number","format":"float","description":"The total score for the critical questions","readOnly":true},"maxTotalCriticalScore":{"type":"number","format":"float","description":"The maximum total score for the critical questions","readOnly":true},"totalNonCriticalScore":{"type":"number","format":"float","description":"The total score for the non-critical questions","readOnly":true},"maxTotalNonCriticalScore":{"type":"number","format":"float","description":"The maximum total score for the non-critical questions","readOnly":true},"totalScoreUnweighted":{"type":"number","format":"float","description":"The unweighted total score for this question group","readOnly":true},"maxTotalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for this question group","readOnly":true},"totalCriticalScoreUnweighted":{"type":"number","format":"float","description":"The unweighted total score for the critical questions","readOnly":true},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for the critical questions","readOnly":true},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"The total unweighted score for the non-critical questions","readOnly":true},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for the non-critical questions","readOnly":true},"questionScores":{"type":"array","description":"The individual question scores","items":{"$ref":"#/definitions/AssessmentQuestionScore"}}}},"AssessmentQuestionScore":{"type":"object","required":["questionId"],"properties":{"failedKillQuestion":{"type":"boolean","description":"True if this was a failed Kill question","readOnly":true},"comments":{"type":"string","description":"Comments provided for the answer"},"questionId":{"type":"string","description":"The ID of the question"},"answerId":{"type":"string","description":"The ID of the selected answer"},"score":{"type":"integer","format":"int32","description":"The score received for this question","readOnly":true},"markedNA":{"type":"boolean","description":"True if this question was marked as NA"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"freeTextAnswer":{"type":"string","description":"Answer for free text answer type"}}},"AssessmentScoringSet":{"type":"object","required":["questionGroupScores"],"properties":{"totalScore":{"type":"number","format":"float","description":"The total score of the answers","readOnly":true},"totalCriticalScore":{"type":"number","format":"float","description":"The total score for the critical questions","readOnly":true},"totalNonCriticalScore":{"type":"number","format":"float","description":"The total score for the non-critical questions","readOnly":true},"questionGroupScores":{"type":"array","description":"The individual scores for each question group","items":{"$ref":"#/definitions/AssessmentQuestionGroupScore"}},"failureReasons":{"type":"array","description":"If the assessment was not passed, the reasons for failure.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["Score","CriticalScore","KillQuestion"]}},"comments":{"type":"string","description":"Comments provided for these answers."},"agentComments":{"type":"string","description":"Comments provided by agent."},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true}}},"AssessmentForm":{"type":"object","required":["passPercent","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"contextId":{"type":"string","description":"The unique Id for all versions of this assessment form","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"published":{"type":"boolean","position":2,"description":"If true, assessment form is published","readOnly":true},"passPercent":{"type":"integer","format":"int32","position":3,"description":"The pass percent for the assessment form"},"questionGroups":{"type":"array","position":4,"description":"A list of question groups","items":{"$ref":"#/definitions/AssessmentFormQuestionGroup"}}}},"AssessmentFormQuestion":{"type":"object","required":["text"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"text":{"type":"string","description":"The question text"},"helpText":{"type":"string"},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by Free Text question types."},"isKill":{"type":"boolean","description":"Does an incorrect answer to this question mark the form as having a failed kill question. Only used by Multiple Choice type questions."},"isCritical":{"type":"boolean","description":"Does this question contribute to the critical score. Only used by Multiple Choice type questions."}}},"AssessmentFormQuestionGroup":{"type":"object","required":["name","questions","type"],"properties":{"id":{"type":"string","description":"The ID of the question group,"},"name":{"type":"string","description":"The question group name"},"type":{"type":"string","description":"The question group type"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","description":"The list of questions for this question group","items":{"$ref":"#/definitions/AssessmentFormQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssessmentScoringRequest":{"type":"object","required":["answers","assessmentForm"],"properties":{"assessmentForm":{"position":1,"description":"The assessment form to score against","$ref":"#/definitions/AssessmentForm"},"answers":{"position":2,"description":"The answers to score","$ref":"#/definitions/AssessmentScoringSet"}}},"LearningAssignmentAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseMetric"}}}},"LearningAssignmentAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseData"}}}},"LearningAssignmentAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/LearningAssignmentAggregateQueryResponseStats"}}},"LearningAssignmentAggregateQueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"},"min":{"type":"number","description":"The minimum value in this metric"},"max":{"type":"number","description":"The maximum value in this metric"},"sum":{"type":"number","description":"The total of the values for this metric"}}},"LearningAssignmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseGroupedData"}}}},"LearningAssignmentAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter. ","$ref":"#/definitions/LearningAssignmentAggregateQueryRequestFilter"}}},"LearningAssignmentAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryRequestPredicate"}}}},"LearningAssignmentAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryRequestClause"}}}},"LearningAssignmentAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId","isPassed"]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational, AssessedContent, Assessment, External"}}},"LearningAssessment":{"type":"object","properties":{"assessmentId":{"type":"string","description":"The Id of the assessment","readOnly":true},"contextId":{"type":"string","description":"The context Id of the related assessment form","readOnly":true},"assessmentFormId":{"type":"string","description":"The Id of the related assessment form","readOnly":true},"status":{"type":"string","description":"Status of the assessment","readOnly":true,"enum":["Pending","InProgress","Finished"]},"answers":{"description":"Answers for the assessment","$ref":"#/definitions/AssessmentScoringSet"},"dateCreated":{"type":"string","format":"date-time","description":"Date the assessment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date the assessment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"Date the assessment was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"LearningAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"assessment":{"description":"The assessment associated with this assignment","$ref":"#/definitions/LearningAssessment"},"createdBy":{"description":"The user who created the assignment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the assignment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified the assignment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date when the assignment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"isOverdue":{"type":"boolean","description":"True if the assignment is overdue","readOnly":true},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment","readOnly":true},"isRule":{"type":"boolean","description":"True if this assignment was created by a Rule","readOnly":true},"isManual":{"type":"boolean","description":"True if this assignment was created manually","readOnly":true},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true},"isLatest":{"type":"boolean","description":"True if the assignment is based on latest module","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"state":{"type":"string","position":2,"description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"dateRecommendedForCompletion":{"type":"string","format":"date-time","position":3,"description":"The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"version":{"type":"integer","format":"int32","position":4,"description":"The version of Learning module assigned"},"module":{"position":5,"description":"The Learning module object associated with this assignment","$ref":"#/definitions/LearningModule"},"user":{"position":6,"description":"The user to whom the assignment is assigned","$ref":"#/definitions/UserReference"},"assessmentForm":{"position":7,"description":"The assessment form associated with this assignment","$ref":"#/definitions/AssessmentForm"},"lengthInMinutes":{"type":"integer","format":"int32","position":8,"description":"The length in minutes of the assignment"}},"description":"Learning module assignment with user information"},"LearningAssignmentStep":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the learning assignment step","readOnly":true},"moduleStep":{"description":"The module step data for this step","readOnly":true,"$ref":"#/definitions/LearningModuleInformStep"},"structure":{"type":"array","description":"The structure for any SCO associated with this step","readOnly":true,"items":{"$ref":"#/definitions/LearningAssignmentStepScoStructure"}},"successStatus":{"type":"string","description":"The success status of this step","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the assignment step","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage for this step"},"percentageScore":{"type":"number","format":"float","description":"The percentage score for this step","readOnly":true},"shareableContentObject":{"description":"The SCO (Shareable Content Object) data","$ref":"#/definitions/LearningShareableContentObject"},"signedCookie":{"description":"The signed cookie information needed to access the content of this step (if required)","readOnly":true,"$ref":"#/definitions/LearningAssignmentStepSignedCookie"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning assignment step"},"LearningAssignmentStepScoStructure":{"type":"object","properties":{"id":{"type":"string","description":"The id of this SCO in the course manifest","readOnly":true},"name":{"type":"string","description":"The name of this SCO in the course manifest","readOnly":true},"successStatus":{"type":"string","description":"The success status of this SCO","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","readOnly":true,"items":{"$ref":"#/definitions/LearningAssignmentStepScoStructure"}}}},"LearningAssignmentStepSignedCookie":{"type":"object","properties":{"url":{"type":"string","description":"The base URL for the signed cookie","readOnly":true},"cookieValues":{"type":"object","description":"The cookie values required to access content from the base URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"LearningCoverArtThumbnail":{"type":"object","properties":{"resolution":{"type":"string","position":1,"description":"Resolution of thumbnail"},"url":{"type":"string","position":2,"description":"The URL for the thumbnail"}}},"LearningModule":{"type":"object","required":["completionTimeInDays","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of learning module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"createdBy":{"description":"The user who created learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time learning module was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time learning module was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module","readOnly":true},"externalId":{"type":"string","description":"The external ID of the learning module","readOnly":true},"source":{"type":"string","description":"The source of the learning module","readOnly":true,"enum":["UserCreated","GenesysBeyond"]},"rule":{"description":"The rule for learning module; read-only, and only populated when requested via expand param.","readOnly":true,"$ref":"#/definitions/LearningModuleRule"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"isArchived":{"type":"boolean","description":"If true, learning module is archived","readOnly":true},"isPublished":{"type":"boolean","description":"If true, learning module is published","readOnly":true},"description":{"type":"string","position":1,"description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","position":2,"description":"The completion time of learning module in days"},"type":{"type":"string","position":3,"description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"informSteps":{"type":"array","position":5,"description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStep"}},"assessmentForm":{"position":6,"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"summaryData":{"position":7,"description":"The learning module summary data","$ref":"#/definitions/LearningModuleSummary"},"reassignSummaryData":{"position":8,"description":"The learning module reassign summary data","$ref":"#/definitions/LearningModuleReassignSummary"},"coverArt":{"position":9,"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtResponse"},"lengthInMinutes":{"type":"integer","format":"int32","position":10,"description":"The recommended time in minutes to complete the module"},"archivalMode":{"type":"string","position":11,"description":"The mode of archival for learning module","enum":["Graceful","Immediate"]}},"description":"Learning module response"},"LearningModuleCoverArtResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"url":{"type":"string","position":1,"description":"The URL for the cover art"},"thumbnails":{"type":"array","position":2,"description":"Thumbnails for the cover art","items":{"$ref":"#/definitions/LearningCoverArtThumbnail"}}},"description":"Learning module cover art response"},"LearningModuleInformStep":{"type":"object","required":["order","type","value"],"properties":{"type":{"type":"string","position":1,"description":"The learning module inform step type","enum":["Url","Content","GenesysBuiltInCourse","RichText","Scorm"]},"name":{"type":"string","position":2,"description":"The name of the inform step or content"},"value":{"type":"string","position":3,"description":"The value for inform step"},"sharingUri":{"type":"string","position":4,"description":"The sharing uri for Content type inform step"},"contentType":{"type":"string","position":5,"description":"The document type for Content type Inform step"},"order":{"type":"integer","format":"int32","position":6,"description":"The order of inform step in a learning module"},"displayName":{"type":"string","position":7,"description":"The display name for the inform step"},"description":{"type":"string","position":8,"description":"The description for the inform step"}}},"LearningModuleReassignSummary":{"type":"object","properties":{"totalReassigned":{"type":"integer","format":"int32","description":"The total number of users for whom assignment is reassigned"},"completedCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in Completed state"},"inProgressCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in InProgress state"},"assignedCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in Assigned state"},"notCompletedCount":{"type":"integer","format":"int32","description":"The total number of users who have their assignment overdue"}},"description":"Learning module reassign summary data"},"LearningModuleRule":{"type":"object","required":["isActive","parts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"If true, rule is active"},"parts":{"type":"array","description":"The parts of a learning module rule","items":{"$ref":"#/definitions/LearningModuleRuleParts"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningModuleRuleParts":{"type":"object","required":["operation","order","selector","value"],"properties":{"operation":{"type":"string","description":"The learning module rule operation","enum":["Include","Exclude"]},"selector":{"type":"string","description":"The learning module rule selector","enum":["AcdSkills","AgentName","Division","Group","Location","Queue","Role","Team"]},"value":{"type":"array","description":"The value of rules","items":{"type":"string"}},"order":{"type":"integer","format":"int32","description":"The order of rules in learning module rule"}}},"LearningModuleSummary":{"type":"object","properties":{"assignedCount":{"type":"integer","format":"int32","description":"The total number of assignments assigned for a learning module"},"completedCount":{"type":"integer","format":"int32","description":"The number of assignments completed for a learning module"},"passedCount":{"type":"integer","format":"int32","description":"The number of assignments passed for a learning module"},"completedSum":{"type":"number","format":"float","description":"The sum of assignment scores for a learning module"}},"description":"Learning module summary data"},"LearningShareableContentObject":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the SCO from the course manifest."},"lessonStatus":{"type":"string","description":"The status of the SCO. Maps to the SCORM 1.2 cmi.core.lesson_status property.","enum":["Passed","Completed","Failed","Incomplete","Browsed","NotAttempted"]},"exit":{"type":"string","description":"Indicates how or why the learner left the SCO. Maps to the SCORM 1.2 cmi.core.exit property.","enum":["Timeout","Suspend","Logout","Empty"]},"location":{"type":"string","description":"The learner’s current location in the SCO. Maps to the SCORM 1.2 cmi.core.lesson_location property."},"scoreRaw":{"type":"number","format":"float","description":"The score of the most recent attempt on the SCO. Maps to the SCORM 1.2 cmi.core.score.raw property."},"scoreMax":{"type":"number","format":"float","description":"The maximum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.max property."},"scoreMin":{"type":"number","format":"float","description":"The minimum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.min property."},"suspendData":{"type":"string","description":"The unique information generated by the SCO from previous uses. Maps to the SCORM 1.2 cmi.suspend_data property."},"credit":{"type":"string","description":"Whether completing this course counts towards the overall assignment. Maps to the SCORM 1.2 cmi.core.credit property.","readOnly":true,"enum":["Credit","NoCredit"]},"entry":{"type":"string","description":"Whether the learner has previously accessed this SCO. Maps to the SCORM 1.2 cmi.core.entry property.","readOnly":true,"enum":["AbInitio","Resume","Empty"]},"mode":{"type":"string","description":"Identifies the mode in which the SCO should be presented to the learner. Maps to the SCORM 1.2 cmi.core.lesson_mode property.","readOnly":true,"enum":["Browse","Normal","Review"]},"totalTime":{"type":"string","description":"The total amount of time the learner has spent in the SCO expressed as an ISO 8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.total_time property.","readOnly":true},"sessionTime":{"type":"string","description":"The amount of time spent in the SCO in this session expressed as an ISO-8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.session_time property."},"href":{"type":"string","description":"The href from the course manifest for this SCO.","readOnly":true},"parameters":{"type":"string","description":"The parameters from the course manifest for this SCO.","readOnly":true},"launchData":{"type":"string","description":"The launch data from the course manifest for this SCO.","readOnly":true}},"description":"Learning assignment SCO (Shareable Content Object)"},"ReviewAssessmentResults":{"type":"object","properties":{}},"LearningAssignmentCreate":{"type":"object","required":["moduleId","userId"],"properties":{"moduleId":{"type":"string","position":1,"description":"The Learning module Id associated with this assignment"},"userId":{"type":"string","position":2,"description":"The User for whom the assignment is assigned"},"recommendedCompletionDate":{"type":"string","format":"date-time","position":3,"description":"The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","position":4,"description":"The length in minutes of assignment"}}},"LearningAssignmentUpdate":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"assessment":{"description":"An updated Assessment","$ref":"#/definitions/LearningAssessment"}}},"LearningAssignmentReschedule":{"type":"object","required":["dateRecommendedForCompletion"],"properties":{"dateRecommendedForCompletion":{"type":"string","format":"date-time","description":"The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of the assignment"}}},"LearningAssignmentsDomainEntity":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningAssignment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningAssignmentReassign":{"type":"object","properties":{"recommendedCompletionDate":{"type":"string","format":"date-time","description":"The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of assignment"}}},"DisallowedEntityLearningAssignmentItem":{"type":"object","properties":{"errorCode":{"type":"string","description":"The error code associated with this disallowed entity"},"entity":{"description":"The entity that was disallowed","$ref":"#/definitions/LearningAssignmentItem"}}},"LearningAssignmentBulkAddResponse":{"type":"object","properties":{"entities":{"type":"array","description":"The learning assignments that were assigned correctly","items":{"$ref":"#/definitions/LearningAssignment"}},"disallowedEntities":{"type":"array","description":"The items that were not allowed to be assigned","items":{"$ref":"#/definitions/DisallowedEntityLearningAssignmentItem"}}}},"LearningAssignmentItem":{"type":"object","required":["moduleId","userId"],"properties":{"moduleId":{"type":"string","position":1,"description":"The Learning Module ID associated with this assignment"},"userId":{"type":"string","position":2,"description":"The User ID associated with this assignment"}}},"DisallowedEntityLearningAssignmentReference":{"type":"object","properties":{"errorCode":{"type":"string","description":"The error code associated with this disallowed entity"},"entity":{"description":"The entity that was disallowed","$ref":"#/definitions/LearningAssignmentReference"}}},"LearningAssignmentBulkRemoveResponse":{"type":"object","properties":{"entities":{"type":"array","description":"The learning assignments that were removed successfully","items":{"$ref":"#/definitions/LearningAssignmentEntity"}},"disallowedEntities":{"type":"array","description":"The learning assignments that were not removed due to missing permissions","items":{"$ref":"#/definitions/DisallowedEntityLearningAssignmentReference"}}}},"LearningAssignmentEntity":{"type":"object","properties":{"assignmentId":{"type":"string"}}},"LearningAssignmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssignmentUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssignmentUserListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningAssignmentUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64","description":"The number of users matching search term"},"unfilteredTotal":{"type":"integer","format":"int32","description":"The total number of users"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"List of users matching the learning module rule"},"LearningAssignmentUserQuery":{"type":"object","required":["rule"],"properties":{"rule":{"description":"Learning module rule object","$ref":"#/definitions/LearningModuleRule"},"searchTerm":{"type":"string","description":"The user name to be searched for"}},"description":"Learning module users query request model"},"LearningModuleJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of learning module job","enum":["Accepted","Running","Completed","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning module job response"},"LearningModuleCoverArtRequest":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The key identifier for the cover art"}}},"LearningModuleInformStepRequest":{"type":"object","required":["order","type","value"],"properties":{"type":{"type":"string","position":1,"description":"The learning module inform step type","enum":["Url","Content","GenesysBuiltInCourse","RichText","Scorm"]},"name":{"type":"string","position":2,"description":"The name of the inform step or content"},"value":{"type":"string","position":3,"description":"The value for inform step"},"sharingUri":{"type":"string","position":4,"description":"The sharing uri for Content type inform step"},"contentType":{"type":"string","position":5,"description":"The document type for Content type Inform step"},"order":{"type":"integer","format":"int32","position":6,"description":"The order of inform step in a learning module"},"displayName":{"type":"string","position":7,"description":"The display name for the inform step"},"description":{"type":"string","position":8,"description":"The description for the inform step"}},"description":"Learning module inform steps request"},"LearningModuleRequest":{"type":"object","required":["completionTimeInDays","name"],"properties":{"name":{"type":"string","description":"The name of learning module"},"description":{"type":"string","description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","description":"The completion time of learning module in days"},"informSteps":{"type":"array","description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStepRequest"}},"type":{"type":"string","description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"assessmentForm":{"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"coverArt":{"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtRequest"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The recommended time in minutes to complete the module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"externalId":{"type":"string","description":"The external ID of the learning module. Maximum length: 50 characters.","minLength":0,"maxLength":50}},"description":"Learning module request"},"LearningModulesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningModule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningModulePublishResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning module publish response"},"LearningModulePublishRequest":{"type":"object","properties":{"termsAndConditionsAccepted":{"type":"boolean","description":"Whether the terms and conditions were accepted"}},"description":"Learning module publish request"},"LearningModuleJobRequest":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":"The type for the learning module job","enum":["Reassign","GracefulArchive","ImmediateArchive","Unarchive"]}},"description":"Learning module job request"},"AssignedLearningModule":{"type":"object","required":["completionTimeInDays","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of learning module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"createdBy":{"description":"The user who created learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time learning module was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time learning module was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module","readOnly":true},"externalId":{"type":"string","description":"The external ID of the learning module","readOnly":true},"source":{"type":"string","description":"The source of the learning module","readOnly":true,"enum":["UserCreated","GenesysBeyond"]},"rule":{"description":"The rule for learning module; read-only, and only populated when requested via expand param.","readOnly":true,"$ref":"#/definitions/LearningModuleRule"},"currentAssignments":{"type":"array","description":"The current assignments for the requested users","items":{"$ref":"#/definitions/LearningAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"isArchived":{"type":"boolean","description":"If true, learning module is archived","readOnly":true},"isPublished":{"type":"boolean","description":"If true, learning module is published","readOnly":true},"description":{"type":"string","position":1,"description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","position":2,"description":"The completion time of learning module in days"},"type":{"type":"string","position":3,"description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"informSteps":{"type":"array","position":5,"description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStep"}},"assessmentForm":{"position":6,"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"summaryData":{"position":7,"description":"The learning module summary data","$ref":"#/definitions/LearningModuleSummary"},"reassignSummaryData":{"position":8,"description":"The learning module reassign summary data","$ref":"#/definitions/LearningModuleReassignSummary"},"coverArt":{"position":9,"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtResponse"},"lengthInMinutes":{"type":"integer","format":"int32","position":10,"description":"The recommended time in minutes to complete the module"},"archivalMode":{"type":"string","position":11,"description":"The mode of archival for learning module","enum":["Graceful","Immediate"]}},"description":"Learning module response"},"AssignedLearningModuleDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AssignedLearningModule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningAssignmentExternalUpdate":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"percentageScore":{"type":"number","format":"float","description":"The score"},"isPassed":{"type":"boolean","description":"Was the assignment marked as passed"}}},"LearningScheduleSlotsQueryResponse":{"type":"object","properties":{"suggestedSlots":{"type":"array","description":"List of slots where Learning activity can be scheduled","items":{"$ref":"#/definitions/LearningSlot"}},"wfmScheduleActivities":{"type":"array","description":"Detailed data for WFM scheduled activities","items":{"$ref":"#/definitions/LearningSlotWfmScheduleActivity"}}}},"LearningSlot":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start date and time of scheduled Learning activity slot. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of Learning activity slot in minutes"},"staffingDifference":{"type":"number","format":"double","description":"Difference between scheduled and forecast headcount for this slot after scheduling the Learning activity"},"differenceRating":{"type":"string","description":"Rating based on the staffing difference for scheduled slot","enum":["Poor","Neutral","Good"]}}},"LearningSlotFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"LearningSlotScheduleActivity":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"LearningSlotWfmScheduleActivity":{"type":"object","properties":{"user":{"description":"User that the schedule is for","$ref":"#/definitions/UserReference"},"activities":{"type":"array","description":"List of user's scheduled activities","items":{"$ref":"#/definitions/LearningSlotScheduleActivity"}},"fullDayTimeOffMarkers":{"type":"array","description":"List of user's days off","items":{"$ref":"#/definitions/LearningSlotFullDayTimeOffMarker"}}}},"LearningScheduleSlotsQueryRequest":{"type":"object","required":["interval","lengthInMinutes","userIds"],"properties":{"interval":{"type":"string","description":"Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment to schedule in 15 minutes granularity"},"userIds":{"type":"array","description":"The user IDs for which to fetch schedules. Must be only 1.","items":{"type":"string"}},"interruptibleAssignmentId":{"type":"string","description":"Assignment ID to exclude from consideration when determining blocked slots"}}},"WidgetClientConfig":{"type":"object","properties":{"v1":{"$ref":"#/definitions/WidgetClientConfigV1"},"v2":{"$ref":"#/definitions/WidgetClientConfigV2"},"v1-http":{"$ref":"#/definitions/WidgetClientConfigV1Http"},"third-party":{"$ref":"#/definitions/WidgetClientConfigThirdParty"}}},"WidgetClientConfigThirdParty":{"type":"object"},"WidgetClientConfigV1":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV1Http":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV2":{"type":"object"},"WidgetDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A human-readable description of this Deployment."},"authenticationRequired":{"type":"boolean","description":"When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation."},"disabled":{"type":"boolean","description":"When true, all create chat operations using this Deployment will be rejected."},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"clientType":{"type":"string","description":"The type of display widget for which this Deployment is configured, which controls the administrator settings shown.","enum":["v1","v2","v1-http","third-party"]},"clientConfig":{"description":"The client configuration options that should be made available to the clients of this Deployment.","$ref":"#/definitions/WidgetClientConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WidgetDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WidgetDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"ActivityCode":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","description":"The name of the activity code. Default activity codes will be created with an empty name"},"isActive":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"isDefault":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The activity code's category.","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ActivityCodeContainer":{"type":"object","required":["metadata"],"properties":{"activityCodes":{"type":"object","description":"Map of activity code id to activity code","additionalProperties":{"$ref":"#/definitions/ActivityCode"}},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WfmVersionedEntityMetadata":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","description":"The version of the associated entity. Used to prevent conflicts on concurrent edits"},"modifiedBy":{"description":"The user who last modified the associated entity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user who created the associated entity, if available","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"EstimateAvailableFullDayTimeOffResponse":{"type":"object","required":["date","durationMinutes","flexible","payableMinutes"],"properties":{"date":{"type":"string","format":"date","description":"Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"durationMinutes":{"type":"integer","format":"int32","description":"An estimation of time off request length in minutes"},"payableMinutes":{"type":"integer","format":"int32","description":"An estimation of payable part of time off request in minutes"},"flexible":{"type":"boolean","description":"Whether there is flexibility for a user to choose different hours than the system estimated"}}},"EstimateAvailablePartialDayTimeOffResponse":{"type":"object","required":["date","durationMinutes","flexible","payableMinutes"],"properties":{"date":{"type":"string","format":"date-time","description":"Start date-time in ISO-8601 format for partial day request"},"durationMinutes":{"type":"integer","format":"int32","description":"An estimation of time off request length in minutes"},"payableMinutes":{"type":"integer","format":"int32","description":"An estimation of payable part of time off request in minutes"},"flexible":{"type":"boolean","description":"Whether there is flexibility for a user to choose different hours than the system estimated"}}},"EstimateAvailableTimeOffResponse":{"type":"object","required":["activityCodeId","paid","user"],"properties":{"fullDayDates":{"type":"array","description":"Full day dates. partialDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailableFullDayTimeOffResponse"}},"partialDayDates":{"type":"array","description":"Partial day dates. fullDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailablePartialDayTimeOffResponse"}},"user":{"description":"The user to whom the time off request belongs","$ref":"#/definitions/UserReference"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this estimate is for a paid time off request"}}},"EstimateAvailableFullDayTimeOffRequest":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date","description":"Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"requestedDurationMinutes":{"type":"integer","format":"int32","description":"A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting"}}},"EstimateAvailablePartialDayTimeOffRequest":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date-time","description":"Start date-time in ISO-8601 format for partial day request"},"requestedDurationMinutes":{"type":"integer","format":"int32","description":"A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting"}}},"EstimateAvailableTimeOffRequest":{"type":"object","required":["activityCodeId","paid"],"properties":{"fullDayDates":{"type":"array","description":"Full day dates. partialDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailableFullDayTimeOffRequest"}},"partialDayDates":{"type":"array","description":"Partial day dates. fullDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailablePartialDayTimeOffRequest"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this estimate is for a paid time off request"}}},"BusinessUnitActivityCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"defaultCode":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The category of the activity code","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code","items":{"$ref":"#/definitions/SecondaryPresence"}},"metadata":{"description":"Version metadata of this activity code","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitActivityCodeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"SecondaryPresence":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateActivityCodeRequest":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code","items":{"$ref":"#/definitions/SecondaryPresence"}}}},"ListWrapperSecondaryPresence":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/SecondaryPresence"}}}},"UpdateActivityCodeRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category. Attempting to change the category of a default activity code will return an error","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"description":"The secondary presences of this activity code","$ref":"#/definitions/ListWrapperSecondaryPresence"},"metadata":{"description":"Version metadata for the associated business unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ForecastAbandonRateResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The target percent abandon rate goal"}}},"ForecastAverageSpeedOfAnswerResponse":{"type":"object","properties":{"seconds":{"type":"integer","format":"int32","description":"the average speed of answer goal in seconds"}}},"ForecastPlanningGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the planning group"},"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Route path configuration for this planning group","items":{"$ref":"#/definitions/RoutePathResponse"}},"serviceGoalTemplate":{"description":"Service goals for this planning group","$ref":"#/definitions/ForecastServiceGoalTemplateResponse"}}},"ForecastServiceGoalTemplateImpactOverrideResponse":{"type":"object","properties":{"serviceLevel":{"description":"Allowed service level percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"},"averageSpeedOfAnswer":{"description":"Allowed average speed of answer percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"},"abandonRate":{"description":"Allowed abandon rate percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"}}},"ForecastServiceGoalTemplateResponse":{"type":"object","properties":{"serviceLevel":{"description":"The service level goal for this forecast","$ref":"#/definitions/ForecastServiceLevelResponse"},"averageSpeedOfAnswer":{"description":"The average speed of answer goal for this forecast","$ref":"#/definitions/ForecastAverageSpeedOfAnswerResponse"},"abandonRate":{"description":"The abandon rate goal for this forecast","$ref":"#/definitions/ForecastAbandonRateResponse"},"impactOverride":{"description":"The service goal impact overrides for this forecast","$ref":"#/definitions/ForecastServiceGoalTemplateImpactOverrideResponse"}}},"ForecastServiceLevelResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The percent of calls to answer in the number of seconds defined"},"seconds":{"type":"integer","format":"int32","description":"The number of seconds to define for the percent of calls to be answered"}}},"LanguageReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathResponse":{"type":"object","properties":{"queue":{"description":"The ID of the queue associated with the route path","$ref":"#/definitions/QueueReference"},"mediaType":{"type":"string","description":"The media type of the given queue associated with the route path","enum":["Voice","Chat","Email","Callback","Message"]},"language":{"description":"The ID of the language associated with the route path","$ref":"#/definitions/LanguageReference"},"skills":{"type":"array","description":"The set of skills associated with the route path","uniqueItems":true,"items":{"$ref":"#/definitions/RoutingSkillReference"}}}},"RoutingSkillReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmIntradayPlanningGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"noDataReason":{"type":"string","description":"The reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"]}}},"WfmServiceGoalImpact":{"type":"object","required":["decreaseByPercent","increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"The maximum allowed percent increase from the configured goal"},"decreaseByPercent":{"type":"number","format":"double","description":"The maximum allowed percent decrease from the configured goal"}}},"AsyncIntradayResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuIntradayResponse"}}},"BuIntradayDataGroup":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type associated with this intraday group","enum":["Voice","Chat","Email","Callback","Message"]},"forecastDataSummary":{"description":"Forecast data summary for this date range","$ref":"#/definitions/BuIntradayForecastData"},"forecastDataPerInterval":{"type":"array","description":"Forecast data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayForecastData"}},"scheduleDataSummary":{"description":"Schedule data summary for this date range","$ref":"#/definitions/BuIntradayScheduleData"},"scheduleDataPerInterval":{"type":"array","description":"Schedule data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayScheduleData"}},"performancePredictionDataSummary":{"description":"Performance prediction data summary for this date range","$ref":"#/definitions/IntradayPerformancePredictionData"},"performancePredictionDataPerInterval":{"type":"array","description":"Performance prediction data per interval for this date range","items":{"$ref":"#/definitions/IntradayPerformancePredictionData"}}}},"BuIntradayForecastData":{"type":"object","properties":{"offered":{"type":"number","format":"double","description":"The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer"},"averageHandleTimeSeconds":{"type":"number","format":"double","description":"The average handle time in seconds an agent spent handling interactions"}}},"BuIntradayResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The aggregation period in minutes, which determines the interval duration of the returned data"},"noDataReason":{"type":"string","description":"If not null, the reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"]},"categories":{"type":"array","description":"The categories to which this data corresponds","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"]}},"shortTermForecast":{"description":"Short term forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"schedule":{"description":"Schedule reference","$ref":"#/definitions/BuScheduleReference"},"intradayDataGroupings":{"type":"array","description":"Intraday data grouped by a single media type and set of planning group IDs","items":{"$ref":"#/definitions/BuIntradayDataGroup"}}}},"BuIntradayScheduleData":{"type":"object","properties":{"onQueueTimeSeconds":{"type":"integer","format":"int64","description":"The total on-queue time in seconds for all agents in this group"}}},"BuScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"description":{"type":"string","description":"The description of the short term forecast","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntradayPerformancePredictionData":{"type":"object","properties":{"serviceLevelPercent":{"type":"number","format":"double","description":"Percentage of interactions that meets service level target as defined in the matching service goal templates"},"averageSpeedOfAnswerSeconds":{"type":"number","format":"double","description":"Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed"},"occupancyPercent":{"type":"number","format":"double","description":"Percentage of on-queue time for all agents in this group that are occupied handling interactions"}}},"IntradayPlanningGroupRequest":{"type":"object","required":["businessUnitDate","categories"],"properties":{"businessUnitDate":{"type":"string","format":"date","description":"Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"categories":{"type":"array","description":"The metric categories","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"]}},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups","items":{"type":"string"}},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data. Required, defaults to 15"}}},"BuImportShortTermForecastSchema":{"type":"object","required":["description","planningGroups","weekCount"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks covered by the forecast"},"planningGroups":{"type":"array","description":"The short term planning group data","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"longTermPlanningGroups":{"type":"array","description":"The long term planning group data","items":{"$ref":"#/definitions/LongTermForecastPlanningGroupData"}},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"}}},"ForecastPlanningGroupData":{"type":"object","required":["averageHandleTimeSecondsPerInterval","offeredPerInterval","planningGroupId"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerInterval":{"type":"array","description":"Forecast offered counts per 15 minute interval for this week of the forecast","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerInterval":{"type":"array","description":"Forecast average handle time per 15 minute interval in seconds","items":{"type":"number","format":"double"}}}},"ImportForecastUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/BuImportShortTermForecastSchema"}}},"LongTermForecastPlanningGroupData":{"type":"object","required":["averageHandleTimeSecondsPerDay","offeredPerDay","planningGroupId"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerDay":{"type":"array","description":"Forecast offered counts per day for this planning group","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerDay":{"type":"array","description":"Forecast average handle time per day in seconds","items":{"type":"number","format":"double"}}}},"UploadUrlRequestBody":{"type":"object","required":["contentLengthBytes"],"properties":{"contentLengthBytes":{"type":"integer","format":"int64","description":"The expected content length (in bytes) of the gzip-encoded data that will be PUT to the returned signed URL"}}},"BuForecastGenerationPlanningGroupResult":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group"},"metricResults":{"type":"array","description":"The generation results for the associated planning group","items":{"$ref":"#/definitions/BuForecastTimeSeriesResult"}}}},"BuForecastGenerationResult":{"type":"object","properties":{"planningGroupResults":{"type":"array","description":"Generation results, broken down by planning group","items":{"$ref":"#/definitions/BuForecastGenerationPlanningGroupResult"}}}},"BuForecastModificationResponse":{"type":"object","required":["displayGranularity","enabled","granularity","metric","planningGroupIds","type","values"],"properties":{"type":{"type":"string","description":"The type of the modification","enum":["MinimumPerInterval","MaximumPerInterval","SetValuePerInterval","ChangeValuePerInterval","ChangePercentPerInterval","SetValueOverRange","ChangeValueOverRange","SetValuesForIntervalSet","SetMultiGranularityValuesForIntervalSet"]},"startIntervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate representing the first interval to which this modification applies"},"endIntervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate representing the last interval to which this modification applies"},"metric":{"type":"string","description":"The metric to which this modification applies","enum":["Offered","AverageHandleTimeSeconds"]},"legacyMetric":{"type":"string","description":"The legacy metric to which this modification applies if applicable","enum":["AverageAfterCallWorkTimeSeconds","AverageHandleTimeSeconds","AverageTalkTimeSeconds","Offered"]},"value":{"type":"number","format":"double","description":"The value of the modification"},"values":{"type":"array","description":"The list of modification values. Only applicable for grid-type modifications","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"secondaryValues":{"type":"array","description":"The list of modification secondary values. Only applicable for multi granularity modifications","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"displayGranularity":{"type":"string","description":"The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"granularity":{"type":"string","description":"The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"secondaryGranularity":{"type":"string","description":"The granularity of the 'secondaryValues' modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"enabled":{"type":"boolean","description":"Whether the modification is enabled for the forecast"},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups to which this forecast modification applies","uniqueItems":true,"items":{"type":"string"}}}},"BuForecastTimeSeriesResult":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this result applies to","enum":["Offered","AverageHandleTimeSeconds"]},"forecastingMethod":{"type":"string","description":"The forecasting method that was used for this metric","enum":["AutoRegressiveIntegratedMovingAverage","MovingAverage","SingleExponentialSmoothing","RandomWalk","DecompositionUsingAdditiveSeasonality","DecompositionUsingMultiplicativeSeasonality","HoltWintersAdditiveSeasonality","HoltWintersAdditiveSeasonalityWithDampedTrend","HoltWintersMultiplicativeSeasonality","HoltWintersMultiplicativeSeasonalityWithDampedTrend","DampedLinearExponentialSmoothing","DoubleExponentialSmoothing","DoubleMovingAverage","LinearExponentialSmoothing","LinearWeightedMovingAverage","PointEstimateUsingDampedLinearExponentialSmoothing","PointEstimateUsingDoubleExponentialSmoothing","PointEstimateUsingLatestWeek","PointEstimateUsingLinearExponentialSmoothing","PointEstimateUsingWeightedAverage","CurveFit","MultiLinearRegression","DynamicHarmonicRegression","Theta","Ensemble","Other"]},"forecastType":{"type":"string","description":"The forecasting type in this forecast result","enum":["LongTerm","ShortTerm"]}}},"BuShortTermForecast":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sourceDays":{"type":"array","description":"The source day pointers for this forecast","items":{"$ref":"#/definitions/ForecastSourceDayPointer"}},"modifications":{"type":"array","description":"Any manual modifications applied to this forecast","items":{"$ref":"#/definitions/BuForecastModificationResponse"}},"generationResults":{"description":"Generation result metadata","$ref":"#/definitions/BuForecastGenerationResult"},"timeZone":{"type":"string","description":"The time zone for this forecast"},"planningGroupsVersion":{"type":"integer","format":"int32","description":"The version of the planning groups that was used for this forecast"},"planningGroups":{"description":"A snapshot of the planning groups used for this forecast as of the version number indicated","$ref":"#/definitions/ForecastPlanningGroupsResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ForecastPlanningGroupsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"businessUnitServiceGoalImpact":{"description":"A snapshot of a business unit’s service goal impact settings taken at forecast generation time.","$ref":"#/definitions/WfmServiceGoalImpactSettings"}}},"ForecastSourceDayPointer":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"The forecast day of week for this source data","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","EighthDay"]},"weight":{"type":"integer","format":"int32","description":"The relative weight to apply to this source data item for weighted averages"},"date":{"type":"string","description":"The date this source data represents, in yyyy-MM-dd format"},"fileName":{"type":"string","description":"The name of the source file this data came from if it originated from a data import"},"dataKey":{"type":"string","description":"The key to look up the forecast source data for this source day"}}},"ImportForecastResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Always null, result will come via notification","$ref":"#/definitions/BuShortTermForecast"}}},"WfmForecastModificationIntervalOffsetValue":{"type":"object","required":["intervalIndex","value"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate to which to apply this modification"},"value":{"type":"number","format":"double","description":"The value to set for the given interval"}}},"WfmServiceGoalImpactSettings":{"type":"object","required":["abandonRate","averageSpeedOfAnswer","serviceLevel"],"properties":{"serviceLevel":{"description":"Allowed service level percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"},"averageSpeedOfAnswer":{"description":"Allowed average speed of answer percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"},"abandonRate":{"description":"Allowed abandon rate percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"}}},"WfmProcessUploadRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"The uploadKey provided by the request to get an upload URL"}}},"BuShortTermForecastListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuShortTermForecastListItem"}}}},"AsyncForecastOperationResult":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuShortTermForecast"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"}}},"GenerateBuForecastRequest":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"}}},"BuForecastResult":{"type":"object","properties":{"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"BuForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/BuForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"BuForecastStaffingRequirementsResult":{"type":"object","required":["downloadUrl","downloadUrlExpirationDate","weekNumber"],"properties":{"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"downloadUrl":{"type":"string","description":"The url to get the requirements results for this week"},"downloadUrlExpirationDate":{"type":"string","format":"date-time","description":"The expiration date of the download url, as an ISO-8601 string"},"planningGroupStaffingRequirements":{"type":"array","description":"Results will always come via downloadUrl, however the schema is included for documentation","items":{"$ref":"#/definitions/StaffingRequirementsPlanningGroupData"}}}},"BuForecastStaffingRequirementsResultResponse":{"type":"object","required":["businessUnitId","forecast","intervalLengthMinutes","referenceStartDate","state","weekCount"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which the forecast staffing requirements belongs"},"forecast":{"description":"The forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast as an ISO-8601 string"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data"},"state":{"type":"string","description":"The state of the staffing requirements generation","enum":["Processing","Complete","Error"]},"results":{"type":"array","description":"The forecast staffing requirement results, Will be populated when state == 'Complete'","items":{"$ref":"#/definitions/BuForecastStaffingRequirementsResult"}}}},"StaffingRequirementsPlanningGroupData":{"type":"object","required":["planningGroupId","staffingRequirementsPerInterval"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies"},"staffingRequirementsPerInterval":{"type":"array","description":"Staffing requirements per interval for this week forecast","items":{"type":"number","format":"double"}}}},"LongTermForecastResult":{"type":"object","properties":{"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/LongTermForecastPlanningGroupData"}},"referenceStartDate":{"type":"string","format":"date","description":"The reference start date relative to the business unit time zone in this forecast. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"LongTermForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/LongTermForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"CopyBuForecastRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekDate":{"type":"string","format":"date","description":"The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuSchedulingSettingsResponse":{"type":"object","properties":{"messageSeverities":{"type":"array","description":"Schedule generation message severity configuration","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}},"syncTimeOffProperties":{"type":"array","description":"Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published.","uniqueItems":true,"items":{"type":"string","enum":["PayableMinutes"]}},"serviceGoalImpact":{"description":"Configures the max percent increase and decrease of service goals for this business unit","$ref":"#/definitions/WfmServiceGoalImpactSettings"},"allowWorkPlanPerMinuteGranularity":{"type":"boolean","description":"Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false."}}},"BuShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts"}}},"BusinessUnitResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"settings":{"description":"Settings for this business unit","$ref":"#/definitions/BusinessUnitSettingsResponse"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitSettingsResponse":{"type":"object","required":["metadata","startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsResponse"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"SchedulerMessageTypeSeverity":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory","UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory","UnableToScheduleMaxWeeklyPaidTimeFromTimeOff","UnableToScheduleMaxWorkDayPaidTimeFromTimeOff","UnableToScheduleMinIntershiftTimeFromAgentHistory","UnableToScheduleMinIntershiftTimeFromDst","UnableToScheduleMinShiftStartDistanceFromAgentHistory","UnableToScheduleMinShiftStartDistanceFromDst","UnableToScheduleMinWeeklyPaidTimeFromTimeOff","UnableToScheduleMinWeeklyWorkDaysFromTimeOff","UnableToScheduleMinWorkDayPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff","UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff","UnableToScheduleWorkDayFromTimeOff","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"]},"severity":{"type":"string","description":"The severity of the message","enum":["Ignore","Information","Warning","Error"]}}},"BuSchedulingSettingsRequest":{"type":"object","properties":{"messageSeverities":{"type":"array","description":"Schedule generation message severity configuration","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}},"syncTimeOffProperties":{"description":"Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published.","$ref":"#/definitions/SetWrapperSyncTimeOffProperty"},"serviceGoalImpact":{"description":"Configures the max percent increase and decrease of service goals for this business unit","$ref":"#/definitions/WfmServiceGoalImpactSettings"},"allowWorkPlanPerMinuteGranularity":{"type":"boolean","description":"Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false."}}},"SetWrapperSyncTimeOffProperty":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["PayableMinutes"]}}}},"UpdateBusinessUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be moved"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/UpdateBusinessUnitSettingsRequest"}}},"UpdateBusinessUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format","readOnly":true},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsRequest"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdherenceSettings":{"type":"object","properties":{"severeAlertThresholdMinutes":{"type":"integer","format":"int32","description":"The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence"},"adherenceTargetPercent":{"type":"integer","format":"int32","description":"Target adherence percentage"},"adherenceExceptionThresholdSeconds":{"type":"integer","format":"int32","description":"The threshold in seconds for which agents should not be penalized for being momentarily out of adherence"},"nonOnQueueActivitiesEquivalent":{"type":"boolean","description":"Whether to treat all non-on-queue activities as equivalent for adherence purposes"},"trackOnQueueActivity":{"type":"boolean","description":"Whether to track on-queue activities"},"ignoredActivityCategories":{"description":"Activity categories that should be ignored for adherence purposes","$ref":"#/definitions/IgnoredActivityCategories"}}},"BusinessUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IgnoredActivityCategories":{"type":"object","properties":{"values":{"type":"array","description":"Activity categories list","items":{"type":"string","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]}}}},"ManagementUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"businessUnit":{"description":"The business unit to which this management unit belongs","$ref":"#/definitions/BusinessUnitReference"},"startDayOfWeek":{"type":"string","description":"Start day of week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for the management unit in standard Olson format. Moving to Business Unit"},"settings":{"description":"The configuration settings for this management unit","$ref":"#/definitions/ManagementUnitSettingsResponse"},"metadata":{"description":"Version info metadata for this management unit. Deprecated, use settings.metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"version":{"type":"integer","format":"int32","description":"The version of the underlying entity. Deprecated, use field from settings.metadata instead","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who last modified this entity. Deprecated, use field from settings.metadata instead","readOnly":true,"$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ManagementUnit"}},"pageSize":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"pageNumber":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"total":{"type":"integer","format":"int64","description":"Deprecated, paging is not supported"},"previousUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"lastUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"firstUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"nextUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"pageCount":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"selfUri":{"type":"string","format":"uri"}}},"ManagementUnitSettingsResponse":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit. These settings are only available if you have the permission wfm:managementUnit:view","$ref":"#/definitions/SchedulingSettingsResponse"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningPeriodSettings":{"type":"object","required":["startDate","weekCount"],"properties":{"weekCount":{"type":"integer","format":"int32","description":"Planning period length in weeks"},"startDate":{"type":"string","format":"date","description":"Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"SchedulingSettingsResponse":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/PlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}},"ShiftTradeActivityRule":{"type":"object","required":["action","activityCategory"],"properties":{"activityCategory":{"type":"string","description":"The activity category to which to apply this rule","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"action":{"type":"string","description":"The action this rule invokes","enum":["Replace","DoNotAllowTrade","KeepWithSchedule"]},"activityCodeIdReplacement":{"type":"string","description":"The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID)"}}},"ShiftTradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether shift trading is enabled for this management unit"},"autoReview":{"type":"boolean","description":"Whether automatic shift trade review is enabled according to the rules defined in for this management unit"},"allowDirectTrades":{"type":"boolean","description":"Whether direct shift trades between agents are allowed"},"minHoursInFuture":{"type":"integer","format":"int32","description":"The minimum number of hours in the future shift trades are allowed"},"unequalPaid":{"type":"string","description":"How to handle shift trades which involve unequal paid times","enum":["Allow","Disallow","AdminReview"]},"oneSided":{"type":"string","description":"How to handle one-sided shift trades","enum":["Allow","Disallow","AdminReview"]},"weeklyMinPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly minimum paid time constraint","enum":["Allow","Disallow","AdminReview"]},"weeklyMaxPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly maximum paid time constraint","enum":["Allow","Disallow","AdminReview"]},"requiresMatchingQueues":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching queues"},"requiresMatchingLanguages":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching languages"},"requiresMatchingSkills":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching skills"},"requiresMatchingPlanningGroups":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching planning groups"},"activityCategoryRules":{"type":"array","description":"Rules that specify what to do with activity categories that are part of a shift defined in a trade","items":{"$ref":"#/definitions/ShiftTradeActivityRule"}}}},"ShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of weeks to consider by default when generating a volume forecast"}}},"ShrinkageOverride":{"type":"object","required":["intervalIndex"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week"},"shrinkagePercent":{"type":"number","format":"double","description":"Shrinkage override percent. Setting a null value will reset the interval to the default"}}},"ShrinkageOverrides":{"type":"object","properties":{"clear":{"type":"boolean","description":"Set true to clear the shrinkage interval overrides"},"values":{"type":"array","description":"List of interval shrinkage overrides","items":{"$ref":"#/definitions/ShrinkageOverride"}}}},"TimeOffRequestSettings":{"type":"object","properties":{"submissionRangeEnforced":{"type":"boolean","description":"Whether to enforce a submission range for agent time off requests"},"submissionEarliestDaysFromNow":{"type":"integer","format":"int32","description":"The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past"},"submissionLatestDaysFromNow":{"type":"integer","format":"int32","description":"The latest number of days from now for which an agent can submit a time off request"}}},"CreateBusinessUnitRequest":{"type":"object","required":["divisionId","name","settings"],"properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be added"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/CreateBusinessUnitSettingsRequest"}}},"CreateBusinessUnitSettingsRequest":{"type":"object","required":["startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsRequest"}}},"BusinessUnitListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"authorized":{"type":"boolean","description":"Whether the user has authorization to interact with this business unit","readOnly":true},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitListItem"}}}},"ManagementUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"SchedulingSettingsRequest":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/ValueWrapperPlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}},"UpdateManagementUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the management unit"},"divisionId":{"type":"string","description":"The new division id for the management unit"},"settings":{"description":"Updated settings for the management unit","$ref":"#/definitions/ManagementUnitSettingsRequest"}}},"ValueWrapperPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/PlanningPeriodSettings"}}},"MoveManagementUnitResponse":{"type":"object","properties":{"businessUnit":{"description":"The new business unit","$ref":"#/definitions/BusinessUnitReference"},"status":{"type":"string","description":"The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete'","enum":["Processing","Complete","Canceled","Error"]}}},"MoveManagementUnitRequest":{"type":"object","required":["businessUnitId"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which to move the management unit"}}},"CreateManagementUnitApiRequest":{"type":"object","required":["businessUnitId","name"],"properties":{"name":{"type":"string","description":"The name of the management unit"},"timeZone":{"type":"string","description":"The default time zone to use for this management unit. Moving to Business Unit"},"startDayOfWeek":{"type":"string","description":"The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"settings":{"description":"The configuration for the management unit. If omitted, reasonable defaults will be assigned","$ref":"#/definitions/CreateManagementUnitSettingsRequest"},"divisionId":{"type":"string","description":"The id of the division to which this management unit belongs. Defaults to home division ID"},"businessUnitId":{"type":"string","description":"The id of the business unit to which this management unit belongs"}}},"CreateManagementUnitSettingsRequest":{"type":"object","properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"}}},"ManagementUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this data","$ref":"#/definitions/UserReference"},"workPlan":{"description":"The work plan associated with this agent, if applicable","$ref":"#/definitions/WorkPlanReference"},"workPlanRotation":{"description":"The work plan rotation associated with this agent, if applicable","$ref":"#/definitions/WorkPlanRotationReference"},"acceptDirectShiftTrades":{"type":"boolean","description":"Whether the agent accepts direct shift trade requests"},"workPlanOverrides":{"type":"array","description":"The work plan overrides associated with this agent. Populate with expand=workPlanOverrides","items":{"$ref":"#/definitions/WorkPlanOverride"}},"queues":{"type":"array","description":"List of queues to which this agent is capable of handling","items":{"$ref":"#/definitions/QueueReference"}},"languages":{"type":"array","description":"The list of languages this agent is capable of handling","items":{"$ref":"#/definitions/LanguageReference"}},"skills":{"type":"array","description":"The list of skills this agent is capable of handling","items":{"$ref":"#/definitions/RoutingSkillReference"}},"schedulable":{"type":"boolean","description":"Whether the agent can be included in schedule generation"},"metadata":{"description":"Metadata for this agent","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanOverride":{"type":"object","required":["startDate","weekCount","workPlan"],"properties":{"startDate":{"type":"string","format":"date","description":"The start date in yyyy-MM-dd format of the work plan override. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"Number of weeks for the work plan override"},"workPlan":{"description":"The work plan reference associated with this override","$ref":"#/definitions/WorkPlanReference"}}},"WorkPlanReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"managementUnit":{"description":"The management unit to which this work plan belongs. Nullable in some routes","$ref":"#/definitions/ManagementUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanRotationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleReferenceForMuRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"businessUnit":{"description":"The start week date for this schedule","$ref":"#/definitions/BusinessUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ShiftTradeResponse"}}}},"ShiftTradeResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this shift trade"},"weekDate":{"type":"string","format":"date","description":"The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"A reference to the associated schedule","$ref":"#/definitions/BuScheduleReferenceForMuRoute"},"state":{"type":"string","description":"The state of this shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"initiatingUser":{"description":"The user who initiated this trade","$ref":"#/definitions/UserReference"},"initiatingShiftId":{"type":"string","description":"The ID of the shift offered for trade by the initiating user"},"initiatingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiatingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent","$ref":"#/definitions/UserReference"},"receivingShiftId":{"type":"string","description":"The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift"},"receivingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oneSided":{"type":"boolean","description":"Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)"},"acceptableIntervals":{"type":"array","description":"Time frames when the initiating user is willing to accept trades. Empty means giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}},"reviewedBy":{"description":"The user who reviewed this shift trade","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Version data for this trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdateMuAgentRequest":{"type":"object","required":["userId"],"properties":{"schedulable":{"type":"boolean","description":"Whether the agent can be included in schedule generation"},"userId":{"type":"string","description":"User to be updated"}}},"UpdateMuAgentsRequest":{"type":"object","properties":{"entities":{"type":"array","description":"List of agents to update","items":{"$ref":"#/definitions/UpdateMuAgentRequest"}}}},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}}},"WfmUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}}}},"PlanningGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceGoalTemplate":{"description":"The ID of the service goal template associated with this planning group","$ref":"#/definitions/ServiceGoalTemplateReference"},"routePaths":{"type":"array","description":"Set of route paths associated with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathResponse"}},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceGoalTemplateReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathRequest":{"type":"object","required":["mediaType","queueId"],"properties":{"queueId":{"type":"string","example":"f27450c9-c1a0-451a-804c-2579b268b273","description":"The ID of the queue to associate with the route path"},"mediaType":{"type":"string","example":"Email","description":"The media type of the given queue to associate with the route path","enum":["Voice","Chat","Email","Callback","Message"]},"languageId":{"type":"string","example":"e3d65f6a-c0d2-41da-8152-82d3f075d77c","description":"The ID of the language to associate with the route path"},"skillIds":{"type":"array","example":"[\"33d29376-4267-4968-8042-dcabdf2c1d98\"]","description":"The set of skill IDs to associate with the route path","uniqueItems":true,"items":{"type":"string"}},"sourcePlanningGroup":{"description":"The planning group from which to take route paths. This property is only needed if a route path already exists in another planning group.Note that taking a route path from another planning group will modify the other planning group","$ref":"#/definitions/SourcePlanningGroupRequest"}}},"SetWrapperRoutePathRequest":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}}}},"SourcePlanningGroupRequest":{"type":"object","required":["id","metadata"],"properties":{"id":{"type":"string","description":"The ID of the planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdatePlanningGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"description":"Set of route paths to associate with the planning group","$ref":"#/definitions/SetWrapperRoutePathRequest"},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningGroupList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PlanningGroup"}},"metadata":{"description":"Version metadata for the planning groups","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAbandonRate":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include abandon rate in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Abandon rate percent goal. Required if include == true"}}},"BuAverageSpeedOfAnswer":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include average speed of answer (ASA) in the associated configuration"},"seconds":{"type":"integer","format":"int32","description":"The target average speed of answer (ASA) in seconds. Required if include == true"}}},"BuServiceLevel":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include service level targets in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Service level target percent answered. Required if include == true"},"seconds":{"type":"integer","format":"int32","description":"Service level target answer time. Required if include == true"}}},"ServiceGoalTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceGoalTemplateImpactOverride":{"type":"object","required":["enabled","impact"],"properties":{"enabled":{"type":"boolean","description":"Whether service goal overrides are enabled for this service goal template"},"impact":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/WfmServiceGoalImpactSettings"}}},"CreatePlanningGroupRequest":{"type":"object","required":["name","routePaths","serviceGoalTemplateId"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Set of route paths to associate with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"}}},"UpdateServiceGoalTemplate":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"}}},"ServiceGoalTemplateList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ServiceGoalTemplate"}},"metadata":{"description":"Version metadata for the service goal templates","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"CreateServiceGoalTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"}}},"ShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeMatchesSummaryResponse"}}}},"WeekShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"weekDate":{"type":"string","format":"date","description":"The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"count":{"type":"integer","format":"int32","description":"The number of trades in the Matched state for the given week"}}},"StaffingGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/StaffingGroupResponse"}}}},"StaffingGroupResponse":{"type":"object","required":["metadata","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the staffing group"},"users":{"type":"array","description":"The list of users that belong to the staffing group","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"managementUnit":{"description":"The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit","$ref":"#/definitions/ManagementUnitReference"},"metadata":{"description":"Version metadata for the staffing group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateStaffingGroupRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the staffing group"},"userIds":{"type":"array","description":"The set of user IDs to associate with the staffing group","uniqueItems":true,"items":{"type":"string"}},"managementUnitId":{"type":"string","description":"The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit"}}},"SetWrapperString":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"UpdateStaffingGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the staffing group"},"userIds":{"description":"The set of user Ids to associate with the staffing group","$ref":"#/definitions/SetWrapperString"},"metadata":{"description":"Version metadata for the staffing group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffLimit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"granularity":{"type":"string","description":"Granularity choice for the time off limit","enum":["Daily"]},"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default time off limit value in minutes per granularity interval"},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffLimitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimit"}}}},"CreateTimeOffLimitRequest":{"type":"object","properties":{"granularity":{"type":"string","description":"Granularity choice for time off limit. If not specified, 'Daily' is assumed","enum":["Daily"]},"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default limit value in minutes per granularity. If not specified, then 0 is assumed, which means there are no time off minutes available"}}},"SetTimeOffLimitValuesRequest":{"type":"object","required":["metadata"],"properties":{"values":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimitRange"}},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffLimitRange":{"type":"object","required":["granularity","limitMinutesPerInterval","startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the range. The end date is determined by 'granularity' and the size of 'limitMinutesPerInterval'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"Granularity choice for the time off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"The list of time off limit values in minutes per granularity interval. If 'null' is specified, then interval specific value is cleared. Such interval will have 'defaultLimitMinutes' value","items":{"type":"integer","format":"int32"}}}},"QueryTimeOffLimitValuesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimitValueRange"}}}},"TimeOffLimitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffLimitValueRange":{"type":"object","required":["granularity","startDate"],"properties":{"timeOffLimit":{"description":"The ID of the time off limit","$ref":"#/definitions/TimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists"},"granularity":{"type":"string","description":"Granularity choice for time off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"A list of time off limit values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"allocatedMinutesPerInterval":{"type":"array","description":"A list of allocated time off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedMinutesPerInterval":{"type":"array","description":"A list of waitlisted time off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"LocalDateRange":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endDate":{"type":"string","format":"date","description":"The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"QueryTimeOffLimitValuesRequest":{"type":"object","required":["dateRanges"],"properties":{"timeOffLimitId":{"type":"string","description":"The time off limit object id to retrieve values for. Required if activityCodeId is not specified"},"activityCodeId":{"type":"string","description":"The activity code id to filter the affected limit objects by. Required if timeOffLimitId is not specified"},"dateRanges":{"type":"array","description":"The list of the date ranges to return time off limit, allocated and waitlisted minutes. The valid number of date ranges is between 1 and 30. Maximum total number of days in all ranges in 366.","items":{"$ref":"#/definitions/LocalDateRange"}}}},"UpdateTimeOffLimitRequest":{"type":"object","required":["metadata"],"properties":{"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default time off limit value in minutes per granularity"},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"HrisTimeOffType":{"type":"object","required":["hrisIntegrationId","id","name"],"properties":{"id":{"type":"string","description":"The ID of the time off type configured in integration."},"name":{"type":"string","description":"The name of the time off type configured in integration."},"hrisIntegrationId":{"type":"string","description":"The ID of the integration."},"secondaryId":{"type":"string","description":"Secondary ID of the time off type, if configured in integration."}}},"TimeOffPlan":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"type":"array","description":"The set of activity code IDs associated with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"timeOffLimits":{"type":"array","description":"The set of time off limit IDs associated with this time off plan.","uniqueItems":true,"items":{"$ref":"#/definitions/TimeOffLimitReference"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/HrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan is currently being used by agents."},"metadata":{"description":"Version metadata for the time off plan.","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffPlan"}}}},"CreateTimeOffPlanRequest":{"type":"object","required":["active","autoApprovalRule","name"],"properties":{"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"type":"array","description":"The set of activity code IDs to associate with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"timeOffLimitIds":{"type":"array","description":"The set of time off limit IDs to associate with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for the time off plan.","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/HrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan should be used by agents."}}},"UpdateTimeOffPlanRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"description":"The set of activity code IDs to associate with this time off plan.","$ref":"#/definitions/SetWrapperString"},"timeOffLimitIds":{"description":"The set of time off limit IDs to associate with this time off plan.","$ref":"#/definitions/SetWrapperString"},"autoApprovalRule":{"type":"string","description":"Auto approval rule for the time off plan.","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/ValueWrapperHrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan should be used by agents."},"metadata":{"description":"Version metadata for the time off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperHrisTimeOffType":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/HrisTimeOffType"}}},"TimeOffRequestReference":{"type":"object","properties":{"id":{"type":"string","description":"The id of the time off request"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserTimeOffIntegrationStatusResponse":{"type":"object","required":["integrationStatus","timeOffRequest","user"],"properties":{"timeOffRequest":{"description":"The time off request associated with this integration status","$ref":"#/definitions/TimeOffRequestReference"},"integrationStatus":{"type":"string","description":"The value of integration status for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]},"user":{"description":"The user to whom the time off request belongs","$ref":"#/definitions/UserReference"}}},"UserTimeOffIntegrationStatusResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponse"}}}},"QueryTimeOffIntegrationStatusRequest":{"type":"object","required":["timeOffRequestLookups"],"properties":{"timeOffRequestLookups":{"type":"array","description":"A list of time off request lookups","items":{"$ref":"#/definitions/TimeOffRequestLookup"}}}},"TimeOffRequestLookup":{"type":"object","required":["timeOffRequestId","userId"],"properties":{"timeOffRequestId":{"type":"string","description":"The ID of the time off request"},"userId":{"type":"string","description":"The ID of the user to whom the time off request belongs"}}},"SetTimeOffIntegrationStatusRequest":{"type":"object","required":["integrationStatus"],"properties":{"integrationStatus":{"type":"string","description":"The integration status value for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]}}},"TimeOffRequestList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeOffRequests":{"type":"array","items":{"$ref":"#/definitions/TimeOffRequestResponse"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"substatus":{"type":"string","description":"The substatus of this time off request","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who last modified this TimeOffRequestResponse","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"syncVersion":{"type":"integer","format":"int32","description":"The sync version of this time off request for which the scheduled activity is associated"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateAdminTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes","status","users"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED"]},"users":{"type":"array","description":"A set of IDs for users to associate with this time off request","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"paid":{"type":"boolean","description":"Whether this is a paid time off request"}}},"AdminTimeOffRequestPatch":{"type":"object","required":["metadata"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED"]},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffRequest":{"type":"object","required":["id","user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The user that the time off request belongs to","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"substatus":{"type":"string","description":"The substatus of this time off request","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"syncVersion":{"type":"integer","format":"int32","description":"The sync version of this time off request for which the scheduled activity is associated"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of time off requests","items":{"$ref":"#/definitions/TimeOffRequest"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"DateRange":{"type":"object","properties":{"startDate":{"type":"string","description":"The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."},"endDate":{"type":"string","description":"The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."}}},"TimeOffRequestQueryBody":{"type":"object","properties":{"ids":{"type":"array","description":"The set of ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"userIds":{"type":"array","description":"The set of user ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"statuses":{"type":"array","description":"The set of statuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["PENDING"]}},"substatuses":{"type":"array","description":"The set of substatuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]}},"dateRange":{"description":"The inclusive range of dates to filter time off requests","$ref":"#/definitions/DateRange"}}},"WaitlistPosition":{"type":"object","properties":{"timeOffRequest":{"description":"The time off request for this wait list position","$ref":"#/definitions/TimeOffRequestReference"},"timeOffLimit":{"description":"The time off limit for which time off request is waitlisted","$ref":"#/definitions/TimeOffLimitReference"},"date":{"type":"string","format":"date","description":"The date to which this wait list position applies, as defined by the time zone of the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"waitlistPosition":{"type":"integer","format":"int32","description":"The time off request's position in the waitlist on the date. 1 means time off is the first in the waitlist"}}},"WaitlistPositionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WaitlistPosition"}}}},"QueryWaitlistPositionsRequest":{"type":"object","required":["timeOffRequests"],"properties":{"timeOffRequests":{"type":"array","description":"The list of the time off request ids for which to fetch the daily waitlist positions","items":{"$ref":"#/definitions/UserTimeOffRequestReference"}}}},"UserTimeOffRequestReference":{"type":"object","required":["user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The ID of the user to whom the time off request applies","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StaffingGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserStaffingGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserStaffingGroupResponse"}}}},"UserStaffingGroupResponse":{"type":"object","properties":{"user":{"description":"The user associated with the staffing group","$ref":"#/definitions/UserReference"},"staffingGroup":{"description":"The staffing group","$ref":"#/definitions/StaffingGroupReference"}}},"QueryUserStaffingGroupListRequest":{"type":"object","required":["userIds"],"properties":{"userIds":{"type":"array","description":"The set of user IDs to fetch associated staffing groups","uniqueItems":true,"items":{"type":"string"}}}},"SearchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"A trade which matches search criteria","$ref":"#/definitions/ShiftTradeResponse"},"matchingReceivingShiftIds":{"type":"array","description":"IDs of shifts which match the search criteria","items":{"type":"string"}},"preview":{"description":"A preview of what the shift trade would look like if matched","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"SearchShiftTradesResponse":{"type":"object","properties":{"trades":{"type":"array","description":"The shift trades that match the search criteria","items":{"$ref":"#/definitions/SearchShiftTradeResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"ShiftTradeActivityPreviewResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity counts as paid time"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for this activity"}}},"ShiftTradePreviewResponse":{"type":"object","properties":{"activities":{"type":"array","description":"List of activities that will make up the new shift if this shift trade is approved","items":{"$ref":"#/definitions/ShiftTradeActivityPreviewResponse"}}}},"SearchShiftTradesRequest":{"type":"object","required":["receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule for which to search for available shift trades"},"receivingShiftIds":{"type":"array","description":"The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)","uniqueItems":true,"items":{"type":"string"}}}},"ShiftTradeMatchReviewResponse":{"type":"object","properties":{"initiatingUser":{"description":"Details for the initiatingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"receivingUser":{"description":"Details for the receivingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"violations":{"type":"array","description":"Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations associated with this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchReviewUserResponse":{"type":"object","properties":{"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"The minimum weekly paid minutes for this user per the work plan tied to the agent schedule"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"The maximum weekly paid minutes for this user per the work plan tied to the agent schedule"},"preTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user prior to the shift trade"},"postTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user if the shift trade is approved"},"postTradeNewShift":{"description":"Preview of what the shift will look like for the opposite side of this trade after the match is approved","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"ShiftTradeMatchViolation":{"type":"object","properties":{"type":{"type":"string","description":"The type of constraint violation","enum":["AgentCapabilityMismatch","CannotTradeWithYourself","DirectTradeForOtherUser","InitiatingAgentScheduleDoesNotExist","InitiatingShiftDisallowedActivityCategory","InitiatingShiftDoesNotExist","InitiatingShiftHasExternalActivities","InitiatingShiftOverlapsExisting","InitiatingShiftStartTooClose","InitiatingShiftTimesChanged","InitiatingWeeklyMaxPaidTime","InitiatingWeeklyMinPaidTime","InvalidState","OneSidedTradeCreation","ReceivingAgentScheduleDoesNotExist","ReceivingShiftDisallowedActivityCategory","ReceivingShiftDoesNotExist","ReceivingShiftForOneSidedTrade","ReceivingShiftHasExternalActivities","ReceivingShiftMissingForTwoSidedTrade","ReceivingShiftOutsideAcceptableIntervals","ReceivingShiftOverlapsExisting","ReceivingShiftStartTooClose","ReceivingShiftTimesChanged","ReceivingWeeklyMaxPaidTime","ReceivingWeeklyMinPaidTime","ShiftTradingNotEnabled","UnequalPaidTime","WeekScheduleDifferent","WeekScheduleDoesNotExist","WeekScheduleUnpublished"]},"params":{"type":"object","description":"Clarifying user params for constructing helpful error messages","additionalProperties":{"type":"string"}}}},"WeekShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"WeekShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The shift trade details","$ref":"#/definitions/ShiftTradeResponse"},"matchReview":{"description":"A preview of what the schedule would look like if the shift trade is approved plus any violations","$ref":"#/definitions/ShiftTradeMatchReviewResponse"}}},"AddShiftTradeRequest":{"type":"object","required":["initiatingShiftId","scheduleId"],"properties":{"scheduleId":{"type":"string","description":"The ID of the schedule to which the initiating and receiving shifts belong"},"initiatingShiftId":{"type":"string","description":"The ID of the shift that the initiating user wants to give up"},"receivingUserId":{"type":"string","description":"The ID of the user to whom to send the request (for use in direct trade requests)"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"acceptableIntervals":{"type":"array","description":"The acceptable intervals the initiating user is willing to accept in trade. Empty indicates the user is giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"BulkUpdateShiftTradeStateResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BulkUpdateShiftTradeStateResult"}}},"BulkUpdateShiftTradeStateResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResultItem"}}}},"BulkUpdateShiftTradeStateResultItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the shift trade after the update request is processed","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"reviewedBy":{"description":"The user who reviewed the request, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["InitiatingAgentScheduleNotFound","InitiatingAgentShiftHasExternalActivities","InitiatingAgentShiftNotFound","ReceivingAgentNotFound","ReceivingAgentScheduleNotFound","ReceivingAgentShiftHasExternalActivities","ReceivingAgentShiftNotFound","ScheduleNotPublished","TransitionNotAllowed"]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BulkShiftTradeStateUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The shift trades to update","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateRequestItem"}}}},"BulkUpdateShiftTradeStateRequestItem":{"type":"object","required":["metadata","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"state":{"type":"string","description":"The new state to set on the shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ListWrapperInterval":{"type":"object","properties":{"values":{"type":"array","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"PatchShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"receivingUserId":{"description":"Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user.","$ref":"#/definitions/ValueWrapperString"},"expiration":{"description":"Update the expiration time for this shift trade.","$ref":"#/definitions/ValueWrapperDate"},"acceptableIntervals":{"description":"Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request","$ref":"#/definitions/ListWrapperInterval"},"metadata":{"description":"Version metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperDate":{"type":"object","properties":{"value":{"type":"string","format":"date-time","description":"The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MatchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The associated shift trade","$ref":"#/definitions/ShiftTradeResponse"},"violations":{"type":"array","description":"Constraint violations which disallow this shift trade","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations for this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"MatchShiftTradeRequest":{"type":"object","required":["metadata","receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule with which the shift trade is associated"},"receivingShiftId":{"type":"string","description":"The ID of the shift the receiving user is giving up in trade, if applicable"},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AgentManagementUnitReference":{"type":"object","properties":{"user":{"description":"The user (agent) for whom the management unit was requested","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management to which the user (agent) belongs","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the user (agent) belongs. Populate with expand=businessUnit","$ref":"#/definitions/BusinessUnitReference"}}},"MoveAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with the move","$ref":"#/definitions/UserReference"},"result":{"type":"string","description":"The result of the move","enum":["AlreadyMoved","DestinationBusinessUnitAgentLimitExceeded","DestinationManagementUnitAgentLimitExceeded","DestinationManagementUnitDoesNotExist","MoveSuccessful","MovingToDifferentManagementUnit","NothingToDo","SourceManagementUnitNotAuthorized"]}}},"MoveAgentsResponse":{"type":"object","properties":{"requestingUser":{"description":"The user that made the request","$ref":"#/definitions/UserReference"},"destinationManagementUnit":{"description":"The management unit specified on the request","$ref":"#/definitions/ManagementUnitReference"},"results":{"type":"array","description":"The list containing the agent and result of the move operation","items":{"$ref":"#/definitions/MoveAgentResponse"}}}},"MoveAgentsRequest":{"type":"object","required":["userIds"],"properties":{"userIds":{"type":"array","description":"The list of user ids to move","uniqueItems":true,"items":{"type":"string"}},"destinationManagementUnitId":{"type":"string","description":"The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null."}}},"ConstraintConflictMessage":{"type":"object","properties":{"message":{"description":"Message for how to resolve a set of conflicted work plan constraints","$ref":"#/definitions/WorkPlanConstraintConflictMessage"},"conflictedConstraintMessages":{"type":"array","description":"Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set","items":{"$ref":"#/definitions/WorkPlanConstraintMessage"}}}},"ValidateWorkPlanMessages":{"type":"object","properties":{"violationMessages":{"type":"array","description":"Messages for work plan violating some rules such as no shifts in a work plan","items":{"$ref":"#/definitions/WorkPlanConfigurationViolationMessage"}},"constraintConflictMessage":{"description":"This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated","$ref":"#/definitions/ConstraintConflictMessage"}}},"ValidateWorkPlanResponse":{"type":"object","properties":{"workPlan":{"description":"The work plan reference associated with this response","$ref":"#/definitions/WorkPlanReference"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not"},"messages":{"description":"Validation messages for this work plan","$ref":"#/definitions/ValidateWorkPlanMessages"}}},"WorkPlanConfigurationViolationMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of configuration violation message for this work plan","enum":["ActivitiesOverlap","ActivityEndGreaterThanShiftStop","ActivityPaidTimeGreaterThanShiftPaidTime","ActivityStartBeforeShiftStart","ActivityStartGreaterThanEqualToShiftStop","ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes","DailyExactPaidMinutes","DailyMaxTotalLessThanWeeklyMin","DailyMaxTotalLessThanWeeklyMinWithOptional","DailyMaxTotalLessThanWeeklyMinWithoutOptional","DailyMinTotalGreaterThanWeeklyMax","DailyMinTotalGreaterThanWeeklyMaxWithOptional","DailyMinTotalGreaterThanWeeklyMaxWithoutOptional","DailyRequiredDaysGreaterThanWeeklyMaxDays","DailyShiftHasNoDaysSelected","DailyShiftMaxPossibilitiesViolated","EarliestShiftStopIsTooLate","ExactPaidTimeNotDivisibleByGranularity","MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek","MaxDaysOffPerPlanningPeriodNotCorrect","MaxPaidTimeIsMoreThanShiftLength","MaxPaidTimeNotDivisibleByGranularity","MaxPaidTimePerPlanningPeriod","MaxShifts","MinPaidTimeNotDivisibleByGranularity","MinPaidTimePerPlanningPeriod","NoShifts","PaidTimeGreaterThanMaxWorkTime","PaidTimeLessThanMinWorkTime","PaidTimeNotMetByShiftStartStop","ShiftDaysSelectMoreThanMinWorkingDays","ShiftStopEarlierThanStart","ShiftVarianceCannotBeMet","WeeklyExactPaidMinutes"]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}},"severity":{"type":"string","description":"Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid.","enum":["Information","Warning","Error"]}}},"WorkPlanConstraintConflictMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of constraint conflict that can be resolved by clients in order to generate agent schedules","enum":["UnknownFix","WithPotentialFixes"]},"arguments":{"type":"array","description":"The arguments to the type of the message that can help clients resolve validation issues","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanConstraintMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of the work plan constraint in this message","enum":["ActivityEarliestStartTimeMinutesFromMidnight","ActivityEarliestStartTimeMinutesFromShiftStart","ActivityLatestStartTimeMinutesFromMidnight","ActivityLatestStartTimeMinutesFromShiftStart","ActivityMinimumLengthFromShiftEndMinutes","ActivityMinimumLengthFromShiftStartMinutes","ActivityStartTimeIncrementInMinutes","PlanningPeriodMaximumDaysOff","PlanningPeriodMaximumPaidTimeMinutes","PlanningPeriodMinimumDaysOff","PlanningPeriodMinimumPaidTimeMinutes","ShiftDayOffRule","ShiftEarliestStartTimeMinutesFromMidnight","ShiftEarliestStopTimeMinutesFromMidnight","ShiftLatestStartTimeMinutesFromMidnight","ShiftLatestStopTimeMinutesFromMidnight","ShiftMaximumContiguousTimeMinutes","ShiftMaximumPaidTimeMinutes","ShiftMinimumContiguousTimeMinutes","ShiftMinimumPaidTimeMinutes","ShiftStartTimeIncrementInMinutes","ShiftStartVarianceMaximumVarianceMinutes","ShiftStartVariancePaidDuration","WorkPlanMaximumConsecutiveWorkingDays","WorkPlanMaximumConsecutiveWorkingWeekends","WorkPlanMaximumWeeklyPaidTimeMinutes","WorkPlanMaximumWorkingDaysPerWeek","WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes","WorkPlanMinimumInterShiftTimeMinutes","WorkPlanMinimumShiftStartDistanceMinutes","WorkPlanMinimumWeeklyPaidTimeMinutes","WorkPlanMinimumWorkingDaysPerWeek","WorkPlanOptionalDays","WorkPlanPaidTimeGranularityMinutes"]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanValidationMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of the argument associated with violation messages","enum":["ActivityId","ActivityId2","ActivityPaidTimeMinutes","ActivityStartTimeMinutes","ActivityValidationId","ActivityValidationId2","ApplicableDays","Count","DailyPaidTimeMinutes","MaximumDays","MaxShiftCount","Minutes","PaidTimeGranularityMinutes","RequiredDays","ShiftId","ShiftPaidTimeMinutes","ShiftStartTimeMinutes","ShiftStopTimeMinutes","ShiftValidationId","WeeklyPaidTimeMinutes","Weeks","WorkTimeMinutes"]},"value":{"type":"string","description":"The value of the argument"}}},"DeletableUserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"delete":{"type":"boolean","description":"If marked true, the user will be removed an associated entity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ListWrapperShiftStartVariance":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/ShiftStartVariance"}}}},"SetWrapperDayOfWeek":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"ShiftStartVariance":{"type":"object","required":["applicableDays","maxShiftStartVarianceMinutes"],"properties":{"applicableDays":{"type":"array","description":"Days for which shift start variance is configured","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"maxShiftStartVarianceMinutes":{"type":"integer","format":"int32","description":"Maximum variance in minutes across shift starts"}}},"WorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"},"id":{"type":"string","description":"ID of the activity. This is required only for the case of updating an existing activity"},"delete":{"type":"boolean","description":"If marked true for updating an existing activity, the activity will be permanently deleted"},"validationId":{"type":"string","description":"ID of the activity in the context of work plan validation"}}},"WorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"constrainDayOff":{"type":"boolean","description":"Whether day off rule is enabled"},"dayOffRule":{"type":"string","description":"The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true","enum":["NextDayOff","PreviousDayOff"]},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/WorkPlanActivity"}},"id":{"type":"string","description":"ID of the shift. This is required only for the case of updating an existing shift"},"delete":{"type":"boolean","description":"If marked true for updating an existing shift, the shift will be permanently deleted"},"validationId":{"type":"string","description":"ID of shift in the context of work plan validation"}}},"WorkPlanValidationRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlan":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanListItemResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan. Populate with expand=details","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan. Populate with expand=details","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan. Populate with expand=agentCount"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanListItemResponse"}}}},"CreateWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of this work plan"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity should be constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/CreateWorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/UserReference"}}}},"CreateWorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"}}},"CreateWorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"constrainDayOff":{"type":"boolean","description":"Whether day off rule is enabled"},"dayOffRule":{"type":"string","description":"The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true","enum":["NextDayOff","PreviousDayOff"]},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/CreateWorkPlanActivity"}}}},"CopyWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the copied work plan"}}},"DateRangeWithOptionalEnd":{"type":"object","required":["startBusinessUnitDate"],"properties":{"startBusinessUnitDate":{"type":"string","format":"date","description":"The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endBusinessUnitDate":{"type":"string","format":"date","description":"The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"WorkPlanPatternResponse":{"type":"object","properties":{"workPlans":{"type":"array","description":"List of work plans in order of rotation on a weekly basis","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"WorkPlanRotationAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with this work plan rotation","$ref":"#/definitions/UserReference"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"WorkPlanRotationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"pattern":{"description":"Pattern with ordered list of work plans that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternResponse"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan rotation"},"agents":{"type":"array","description":"Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanRotationAgentResponse"}},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddWorkPlanRotationAgentRequest":{"type":"object","required":["dateRange","position","userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"AddWorkPlanRotationRequest":{"type":"object","required":["dateRange","name","pattern"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/AddWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"}}},"WorkPlanPatternRequest":{"type":"object","required":["workPlanIds"],"properties":{"workPlanIds":{"type":"array","description":"List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty","items":{"type":"string"}}}},"CopyWorkPlanRotationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name to apply to the new copy of the work plan rotation"}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"UpdateWorkPlanRotationAgentRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"},"delete":{"type":"boolean","description":"If marked true for this agent when updating, then this agent will be removed from this work plan rotation"}}},"UpdateWorkPlanRotationRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/UpdateWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ActivityCodeReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code.","items":{"$ref":"#/definitions/SecondaryPresence"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the adherence explanation job","enum":["AddExplanation","UpdateExplanation","QueryAgentExplanations","QueryBuExplanations"]},"status":{"type":"string","description":"The status of the adherence explanation job","enum":["Processing","Complete","Error"]},"adherenceExplanation":{"description":"The adherence explanation added or modified by the job once complete; may be null if status == 'Error'. Used if type is in [ 'AddExplanation', 'UpdateExplanation' ]","$ref":"#/definitions/AdherenceExplanationResponse"},"downloadUrl":{"type":"string","description":"A URL to fetch results of the job. Only set if status == 'Complete' and type is in [ 'QueryAgentExplanations', 'QueryBuExplanations' ]"},"error":{"description":"Error details if status == 'Error'","$ref":"#/definitions/ErrorBody"},"agentQueryResponseTemplate":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryAgentExplanations'","$ref":"#/definitions/AdherenceExplanationListingAgentQueryResponse"},"buQueryResponseTemplate":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryBuExplanations'","$ref":"#/definitions/AdherenceExplanationListingBuQueryResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationListingAgentQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"AdherenceExplanationListingBuQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"AdherenceExplanationResponse":{"type":"object","required":["agent","businessUnit","lengthMinutes","managementUnit","startDate","status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"agent":{"description":"The agent to whom this adherence explanation applies","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/BusinessUnitReference"},"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"},"reviewedBy":{"description":"The user who reviewed the adherence explanation, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp for when the adherence explanation was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationAsyncResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/AdherenceExplanationJobReference"}}},"AdherenceExplanationJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the adherence explanation job","enum":["AddExplanation","UpdateExplanation","QueryAgentExplanations","QueryBuExplanations"]},"status":{"type":"string","description":"The status of the adherence explanation job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateAdherenceExplanationStatusRequest":{"type":"object","properties":{"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]}}},"AddAdherenceExplanationAdminRequest":{"type":"object","required":["lengthMinutes","startDate","type"],"properties":{"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]}}},"AgentQueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListingAgentQueryResponse"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"AgentQueryAdherenceExplanationsRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuQueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListingBuQueryResponse"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"BuQueryAdherenceExplanationsRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnitIds":{"type":"array","description":"A filter for which management units to query. Leave empty or omit entirely for all management units in the business unit","items":{"type":"string"}},"agentIds":{"type":"array","description":"A filter for which agents within the business unit to query. Leave empty or omit entirely for all agents in the business unit (or management units if specified)","items":{"type":"string"}}}},"AdherenceExplanationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"QueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListing"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"AddAdherenceExplanationAgentRequest":{"type":"object","required":["lengthMinutes","startDate","type"],"properties":{"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"}}},"HistoricalAdherenceActuals":{"type":"object","properties":{"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"actualSecondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID"},"startOffsetSeconds":{"type":"integer","format":"int32","description":"Actual start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Actual end offset in seconds relative to query start time"}}},"HistoricalAdherenceExceptionInfo":{"type":"object","properties":{"startOffsetSeconds":{"type":"integer","format":"int32","description":"Exception start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Exception end offset in seconds relative to query start time"},"scheduledActivityCodeId":{"type":"string","description":"The ID of the scheduled activity code for this user"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"scheduledSecondaryPresenceLookupIds":{"type":"array","description":"The lookup IDs used to retrieve the scheduled secondary statuses from map of lookup ID to corresponding secondary presence ID","uniqueItems":true,"items":{"type":"string"}},"actualActivityCodeId":{"type":"string","description":"The ID of the actual activity code for this user"},"actualActivityCategory":{"type":"string","description":"Activity for which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"secondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID"}}},"WfmHistoricalAdherenceBulkJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the historical adherence bulk job to listen for via notification or query using the jobs route"},"status":{"type":"string","description":"The status of the historical adherence bulk job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmHistoricalAdherenceBulkResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/WfmHistoricalAdherenceBulkJobReference"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. This field is populated only if query state is Complete","items":{"type":"string"}},"downloadResult":{"description":"Results will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceBulkResult"}}},"WfmHistoricalAdherenceBulkResult":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range for this result in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range for this result in ISO-8601 format"},"managementUnitId":{"type":"string","description":"The ID of the management unit for this result"},"userResults":{"type":"array","description":"The individual results for each user","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkUserResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceBulkUserDayMetrics":{"type":"object","properties":{"dayStartOffsetSeconds":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSeconds":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSeconds":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSeconds":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"WfmHistoricalAdherenceBulkUserResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"actuals":{"type":"array","description":"List of adherence actuals for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkUserDayMetrics"}}}},"WfmHistoricalAdherenceBulkItem":{"type":"object","required":["endDate","managementUnitId","startDate"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format"},"userIds":{"type":"array","description":"The IDs of the users to query. If not included, will query every user in the management unit","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results. Defaults to false if not specified."},"includeActuals":{"type":"boolean","description":"Whether user actual activities should be returned as part of the results. Defaults to false if not specified."}}},"WfmHistoricalAdherenceBulkQuery":{"type":"object","required":["items","timeZone"],"properties":{"items":{"type":"array","description":"The historical adherence items to query","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkItem"}},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."}}},"HistoricalAdherenceDayMetrics":{"type":"object","properties":{"dayStartOffsetSecs":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSecs":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSecs":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSecs":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSecs":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"HistoricalAdherenceQueryResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"managementUnitId":{"type":"string","description":"The ID of the management unit of the user for whom the adherence is queried"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/HistoricalAdherenceDayMetrics"}},"actualsEndDate":{"type":"string","format":"date-time","description":"The end date of the actual activities in ISO-8601 format."},"actuals":{"type":"array","description":"List of actual activity with offset for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}}}},"WfmHistoricalAdherenceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The query ID to listen for"},"downloadUrl":{"type":"string","description":"Deprecated. Use downloadUrls instead."},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceResultWrapper"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. For notification purposes only","items":{"type":"string"}},"queryState":{"type":"string","description":"The state of the adherence query","enum":["Processing","Complete","Error"]}}},"WfmHistoricalAdherenceResultWrapper":{"type":"object","properties":{"entityId":{"type":"string","description":"The operation ID of the historical adherence query"},"data":{"type":"array","description":"The list of historical adherence query results","items":{"$ref":"#/definitions/HistoricalAdherenceQueryResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForUsers":{"type":"object","required":["startDate","timeZone","userIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"WfmHistoricalAdherenceQuery":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForTeams":{"type":"object","required":["startDate","timeZone"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"RealTimeAdherenceExplanation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TeamReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserScheduleAdherence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user for whom this status applies","readOnly":true,"$ref":"#/definitions/UserReference"},"businessUnit":{"description":"The business unit to which this user belongs","readOnly":true,"$ref":"#/definitions/BusinessUnitReference"},"managementUnit":{"description":"The management unit to which this user belongs","readOnly":true,"$ref":"#/definitions/ManagementUnitReference"},"team":{"description":"The team to which this user belongs","readOnly":true,"$ref":"#/definitions/TeamReference"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"scheduledActivityCode":{"description":"Activity code for which the user is currently scheduled","readOnly":true,"$ref":"#/definitions/ActivityCodeReference"},"systemPresence":{"type":"string","description":"Actual underlying system presence value","readOnly":true,"enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"organizationSecondaryPresenceId":{"type":"string","description":"Organization Secondary Presence Id.","readOnly":true},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","readOnly":true,"enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"isOutOfOffice":{"type":"boolean","description":"Whether the user is marked OutOfOffice","readOnly":true},"adherenceState":{"type":"string","description":"The user's current adherence state","readOnly":true,"enum":["InAdherence","OutOfAdherence","Unscheduled","Unknown","Ignored","Explained"]},"impact":{"type":"string","description":"The impact of the user's current adherenceState","readOnly":true,"enum":["Positive","Negative","Neutral","Unknown"]},"adherenceExplanation":{"description":"Currently applicable explanation for the adherence state","readOnly":true,"$ref":"#/definitions/RealTimeAdherenceExplanation"},"timeOfAdherenceChange":{"type":"string","format":"date-time","description":"Time when the user entered the current adherenceState in ISO-8601 format","readOnly":true},"presenceUpdateTime":{"type":"string","format":"date-time","description":"Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"activeQueues":{"type":"array","description":"The list of queues to which this user is joined","readOnly":true,"items":{"$ref":"#/definitions/QueueReference"}},"activeQueuesModifiedTime":{"type":"string","format":"date-time","description":"Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"removedFromManagementUnit":{"type":"boolean","description":"For notification purposes. Used to indicate that a user was removed from the management unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserScheduleAdherenceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}},"downloadUrl":{"type":"string","description":"The downloadUrl if the response is too large to send directly via http response","readOnly":true}}},"AgentPossibleWorkShiftsResponse":{"type":"object","properties":{"weekStartDate":{"type":"string","format":"date","description":"Start date of requested effective work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"pattern":{"type":"array","description":"Each element is the ID of an effective work plan for a specific week","items":{"type":"integer","format":"int32"}},"weeklyPossibleWorkShifts":{"type":"array","description":"Each element is a weekly effective work plan that can be used for multiple weeks","items":{"$ref":"#/definitions/PossibleWorkShiftsForWeek"}},"schedulerIntervalLengthMinutes":{"type":"integer","format":"int32","description":"Number of minutes in each interval in the intervalScheduleProbabilities"},"timeZone":{"type":"string","description":"The time zone of the business unit"}}},"DailyPossibleShift":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"Day of the shift","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"earliestShiftStartMinutesFromMidnight":{"type":"integer","format":"int32","description":"Minutes of the earliest shift start from midnight. Note that midnight is 12:00 am in the time zone specified in the timeZone field (in the top level of the response)"},"required":{"type":"boolean","description":"Whether this is a required shift"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes of this daily shift"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes of this daily shift"},"intervalScheduleProbabilities":{"type":"array","description":"The percentage of being scheduled in each interval between the earliest shift start and latest shift end. Range of the values: [0, 100].","items":{"type":"integer","format":"int32"}}}},"PossibleWorkShiftsForWeek":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of this possible weekly shift"},"dailyPossibleShifts":{"type":"array","description":"Daily shifts in this possible weekly shift","items":{"$ref":"#/definitions/DailyPossibleShift"}}}},"AgentPossibleWorkShiftsRequest":{"type":"object","required":["weekCount","weekStartDate"],"properties":{"weekStartDate":{"type":"string","format":"date","description":"Start date of requested effective work plan, day of week will be in line with business unit start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"Number of weeks for which to return possible work shifts"}}},"BuAgentScheduleActivity":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for this activity"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"timeOffRequestSyncVersion":{"type":"integer","format":"int32","description":"The sync version of the partial day time off request for which the scheduled activity is associated, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"CalendarUrlResponse":{"type":"object","properties":{"calendarUrl":{"type":"string","description":"The calendar url for the user to subscribe with supported clients"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTimeOffRange":{"type":"object","properties":{"timeOffLimit":{"description":"The time off limit","$ref":"#/definitions/TimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"Granularity choice for time off limit","enum":["Daily"]},"availableMinutesPerInterval":{"type":"array","description":"The list of available time off values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"waitlistEnabled":{"type":"boolean","description":"Whether the time off request can be waitlisted"}}},"AvailableTimeOffResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/AvailableTimeOffRange"}}}},"AvailableTimeOffRequest":{"type":"object","required":["activityCodeId"],"properties":{"activityCodeId":{"type":"string","description":"The ID for activity code to query available time off minutes"},"dateRanges":{"type":"array","description":"A list of date ranges of available time off minutes. A maximum number of date ranges is 30. The maximum total number of days in all ranges is 366. If no ranges are specified, then only the presence of the associated time off limit object will be checked. In such case, if the association exists, then the response will contain a list with of a single element filled with timeOffLimitId only.","items":{"$ref":"#/definitions/LocalDateRange"}}}},"CreateAgentTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes"],"properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}}}},"AgentTimeOffRequestPatch":{"type":"object","properties":{"markedAsRead":{"type":"boolean","description":"Whether this request has been read by the agent"},"status":{"type":"string","description":"The status of this time off request. Can only be canceled if the requested date has not already passed","enum":["CANCELED"]},"notes":{"type":"string","description":"Notes about the time off request. Can only be edited while the request is still pending"}}},"BuAgentSchedulePublishedScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks encompassed by the schedule"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuAgentScheduleSearchResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"BuAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shift"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"}}},"BuAgentScheduleUpdate":{"type":"object","properties":{"type":{"type":"string","description":"The type of update","enum":["Added","Edited","Deleted"]},"shiftStartDates":{"type":"array","description":"The start date for the affected shifts","items":{"type":"string","format":"date-time"}}}},"BuCurrentAgentScheduleSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}},"startDate":{"type":"string","format":"date-time","description":"The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"updates":{"type":"array","description":"The list of updates for the schedule. Only used in notifications","items":{"$ref":"#/definitions/BuAgentScheduleUpdate"}}}},"BuFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for the time off marker"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"},"timeOffRequestSyncVersion":{"type":"integer","format":"int32","description":"The sync version of the full day time off request for which the scheduled activity is associated"}}},"BuGetCurrentAgentScheduleRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UserSchedule":{"type":"object","required":["metadata"],"properties":{"shifts":{"type":"array","description":"The shifts that belong to this schedule","items":{"$ref":"#/definitions/UserScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Markers to indicate a full day time off request, relative to the management unit time zone","items":{"$ref":"#/definitions/UserScheduleFullDayTimeOffMarker"}},"delete":{"type":"boolean","description":"If marked true for updating an existing user schedule, it will be deleted"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"workPlanId":{"type":"string","description":"ID of the work plan associated with the user during schedule creation","readOnly":true}}},"UserScheduleActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this activity, in ISO-8601 format"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length in minutes for this activity"},"description":{"type":"string","description":"Description for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity is paid"},"isDstFallback":{"type":"boolean","description":"Whether this activity spans a DST fallback"},"timeOffRequestId":{"type":"string","description":"Time off request id of this activity"}}},"UserScheduleContainer":{"type":"object","properties":{"managementUnitTimeZone":{"type":"string","description":"The reference time zone used for the management unit"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/WeekScheduleReference"}},"userSchedules":{"type":"object","description":"Map of user id to user schedule","additionalProperties":{"$ref":"#/definitions/UserSchedule"}}}},"UserScheduleFullDayTimeOffMarker":{"type":"object","properties":{"managementUnitDate":{"type":"string","description":"The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format."},"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"isPaid":{"type":"boolean","description":"Whether this is paid time off"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this time off marker"},"description":{"type":"string","description":"The description associated with the time off request that this marker corresponds to"},"delete":{"type":"boolean","description":"If marked true for updating an existing full day time off marker, it will be deleted"}}},"UserScheduleShift":{"type":"object","properties":{"weekSchedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/WeekScheduleReference"},"id":{"type":"string","description":"ID of the schedule shift. This is only for the case of updating and deleting an existing shift"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"List of activities in this shift","items":{"$ref":"#/definitions/UserScheduleActivity"}},"delete":{"type":"boolean","description":"If marked true for updating this schedule shift, it will be deleted"},"manuallyEdited":{"type":"boolean","description":"Whether the shift was set as manually edited"}}},"WeekScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"}}},"CurrentUserScheduleRequestBody":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false"}}},"TimeOffIntegrationStatusResponse":{"type":"object","required":["integrationStatus","timeOffRequest"],"properties":{"timeOffRequest":{"description":"The time off request associated with this integration status","$ref":"#/definitions/TimeOffRequestReference"},"integrationStatus":{"type":"string","description":"The value of integration status for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]}}},"TimeOffIntegrationStatusResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffIntegrationStatusResponse"}}}},"CurrentUserTimeOffIntegrationStatusRequest":{"type":"object","required":["timeOffRequestIds"],"properties":{"timeOffRequestIds":{"type":"array","description":"A list of time off request IDs","items":{"type":"string"}}}},"AdherenceExplanationNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"agent":{"description":"The agent for whom the adherence explanation applies","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/BusinessUnitReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the adherence explanation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"notes":{"type":"string","description":"Notes about the adherence explanation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftNotification":{"type":"object","required":["granularity","initiatingShiftDate","initiatingUser","weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start date of the schedule with which this trade is associated. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"The granularity of alternative shifts to be traded","enum":["Daily"]},"newState":{"type":"string","description":"The new state of the alternative shift trade, null if there was no change","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"initiatingUser":{"description":"The user who initiated the alternative shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving this alternative shift trade","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving alternative shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"ShiftTradeNotification":{"type":"object","properties":{"weekDate":{"type":"string","description":"The start date of the schedule with which this trade is associated"},"tradeId":{"type":"string","description":"The ID of the shift trade"},"oneSided":{"type":"boolean","description":"Whether this is a one sided shift trade"},"newState":{"type":"string","description":"The new state of the shift trade, null if there was no change","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"initiatingUser":{"description":"The user who initiated the shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving side of this shift trade (null if not matched)","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TimeOffRequestNotification":{"type":"object","properties":{"timeOffRequestId":{"type":"string","description":"The ID of this time off request"},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}}}},"WfmUserNotification":{"type":"object","required":["id","markedAsRead","mutableGroupId"],"properties":{"id":{"type":"string","description":"The immutable globally unique identifier for the object."},"mutableGroupId":{"type":"string","description":"The group ID of the notification (mutable, may change on update)"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"type":"string","description":"The type of this notification","readOnly":true,"enum":["AdherenceExplanation","ShiftTrade","TimeOffRequest","AlternativeShift"]},"shiftTrade":{"description":"A shift trade notification. Only set if type == ShiftTrade","readOnly":true,"$ref":"#/definitions/ShiftTradeNotification"},"timeOffRequest":{"description":"A time off request notification. Only set if type == TimeOffRequest","readOnly":true,"$ref":"#/definitions/TimeOffRequestNotification"},"adherenceExplanation":{"description":"An adherence explanation notification. Only set if type == AdherenceExplanation","readOnly":true,"$ref":"#/definitions/AdherenceExplanationNotification"},"alternativeShift":{"description":"An alternative shift trade notification. Only set if type == AlternativeShift","readOnly":true,"$ref":"#/definitions/AlternativeShiftNotification"},"markedAsRead":{"type":"boolean","description":"Whether this notification has been marked \"read\""},"agentNotification":{"type":"boolean","description":"Whether this notification is for an agent","readOnly":true},"otherNotificationIdsInGroup":{"type":"array","description":"Other notification IDs in group. This field is only populated in real-time notifications","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"UpdateNotificationResponse":{"type":"object","properties":{"mutableGroupId":{"type":"string","description":"The mutableGroupId of the notification"},"id":{"type":"string","description":"The id of the notification for mapping the potentially new mutableGroupId"}}},"UpdateNotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateNotificationResponse"}}}},"UpdateNotificationsRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The notifications to update","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"HistoricalImportDeleteJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string","description":"Property denoting the status of the delete.","readOnly":true,"enum":["InProgress","Success","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HistoricalImportStatus":{"type":"object","properties":{"requestId":{"type":"string","description":"Request id of the historical import in the organization","readOnly":true},"dateImportEnded":{"type":"string","format":"date-time","description":"The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateImportStarted":{"type":"string","format":"date-time","description":"The first day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Status of the historical import in the organization.","readOnly":true,"enum":["Initiated","InProgress","Pending","Success","Failed","Cancelled","Purged","PurgePending"]},"error":{"type":"string","description":"Error occured if the status of the import is failed","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Date in which the historical import is initiated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date in which the historical import is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"active":{"type":"boolean","description":"Whether this historical import is active or not","readOnly":true},"type":{"type":"string","description":"Whether this historical import is of type csv or json","readOnly":true,"enum":["Csv","Json"]}}},"HistoricalImportStatusListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HistoricalImportStatus"}}}},"ValidationServiceRequest":{"type":"object","required":["dateImportEnded","uploadKey"],"properties":{"dateImportEnded":{"type":"string","format":"date-time","description":"The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadKey":{"type":"string","description":"S3 key for the uploaded file"}}},"AgentIntegrationAssociationResponse":{"type":"object","required":["agentExternalId","integration","locked"],"properties":{"agentExternalId":{"type":"string","description":"ID of the agent in external system"},"integration":{"description":"The integration associated with the agent","$ref":"#/definitions/WfmIntegrationReference"},"locked":{"type":"boolean","description":"Whether agentExternalId should be protected from update by automatic processes"}}},"AgentIntegrationsResponse":{"type":"object","required":["agent","associatedIntegrations"],"properties":{"agent":{"description":"The user associated with the integrations","$ref":"#/definitions/UserReference"},"selectedIntegration":{"description":"The integration selected for the agent. If not set, no integration will be used for the agent","$ref":"#/definitions/WfmIntegrationReference"},"userSelected":{"type":"boolean","description":"Whether the integration association has been manually selected"},"associatedIntegrations":{"type":"array","description":"The list of integrations associated with the agent","items":{"$ref":"#/definitions/AgentIntegrationAssociationResponse"}}}},"AgentsIntegrationsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentIntegrationsResponse"}}}},"WfmIntegrationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryAgentsIntegrationsRequest":{"type":"object","required":["agentIds"],"properties":{"agentIds":{"type":"array","description":"The IDs of the agents to query associated integrations","uniqueItems":true,"items":{"type":"string"}}},"description":"Query integrations for agents request"},"AgentIntegrationAssociationRequest":{"type":"object","required":["agentExternalId","integrationId","locked"],"properties":{"agentExternalId":{"type":"string","description":"The ID of the agent in external system"},"integrationId":{"type":"string","description":"The ID of the integration associated with the agent"},"locked":{"type":"boolean","description":"Whether agentExternalId should be protected from update by automatic processes"}}},"AgentIntegrationsRequest":{"type":"object","required":["associatedIntegrations"],"properties":{"selectedIntegrationId":{"type":"string","description":"The ID of the integration selected for the agent. If not set, no integration will be used for the agent"},"associatedIntegrations":{"type":"array","description":"The list of integrations associated with the agent","items":{"$ref":"#/definitions/AgentIntegrationAssociationRequest"}}}},"HrisTimeOffTypeResponse":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"ID of the time off type configured in integration"},"name":{"type":"string","description":"Name of the time off type configured in integration"},"secondaryId":{"type":"string","description":"Secondary ID of the time off type, if configured in integration"}}},"HrisTimeOffTypesJobResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HrisTimeOffTypeResponse"}},"status":{"type":"string","description":"The status of the time off types job","enum":["Processing","Complete","Error"]}}},"WfmIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmIntegrationResponse"}}}},"WfmIntegrationResponse":{"type":"object","required":["active"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether integration state is active"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HrisTimeOffTypesJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HrisTimeOffTypesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/HrisTimeOffTypesJobReference"},"entities":{"type":"array","description":"List of time off types. It is available only via notification","items":{"$ref":"#/definitions/HrisTimeOffTypeResponse"}}}},"ModelingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.'","readOnly":true,"enum":["ModelInputMissing","ModelInputInvalid","ModelFailed"]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"ModelingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the modeling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the modeling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/ModelingProcessingError"}},"modelingResultUri":{"type":"string","description":"The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'.","readOnly":true}}},"PerformancePredictionOutputs":{"type":"object","required":["calculationIntervalLengthMinutes","calculationStartDate","planningGroupResults"],"properties":{"calculationStartDate":{"type":"string","format":"date-time","description":"Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results"},"calculationIntervalLengthMinutes":{"type":"integer","format":"int32","description":"Interval length of the response metrics"},"planningGroupResults":{"type":"array","description":"List of planning group level performance prediction results","items":{"$ref":"#/definitions/PlanningGroupOutputs"}}}},"PerformancePredictionResponse":{"type":"object","required":["scheduleId","state","weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"scheduleId":{"type":"string","description":"The ID of the schedule this performance prediction is associated with"},"downloadUrl":{"type":"string","description":"The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete'"},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/PerformancePredictionOutputs"},"state":{"type":"string","description":"The state of the performance prediction","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PlanningGroupOutputs":{"type":"object","required":["abandonRatePerInterval","averageSpeedOfAnswerSecondsPerInterval","occupancyPerInterval","planningGroupId","serviceLevelPerInterval"],"properties":{"planningGroupId":{"type":"string","description":"The ID for for the associated planning group result"},"serviceLevelPerInterval":{"type":"array","description":"List of Service Level percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}},"occupancyPerInterval":{"type":"array","description":"List of Occupancy percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}},"averageSpeedOfAnswerSecondsPerInterval":{"type":"array","description":"List of Average Speed of Answer (in seconds) results per interval","items":{"type":"number","format":"double"}},"abandonRatePerInterval":{"type":"array","description":"List of Abandon rate percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}}}},"AgentQueueTimeRequest":{"type":"object","required":["agentId","onQueueLengthMinutesPerInterval","startOffsetMinutes"],"properties":{"agentId":{"type":"string","description":"ID of the agent"},"startOffsetMinutes":{"type":"array","description":"List of offsets in minutes from calculationStartDate","items":{"type":"integer","format":"int32"}},"onQueueLengthMinutesPerInterval":{"type":"array","description":"List of on queue time lengths in minutes per interval of elements in startOffsetMinutes","items":{"type":"integer","format":"int32"}}}},"MuAgentQueueTimeRequest":{"type":"object","required":["agentOnQueueTimes","managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"ID of the management unit"},"agentOnQueueTimes":{"type":"array","description":"List of Agent queue times within the management unit","items":{"$ref":"#/definitions/AgentQueueTimeRequest"}}}},"PerformancePredictionRecalculationUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/PerformancePredictionUploadSchema"}}},"PerformancePredictionUploadSchema":{"type":"object","required":["calculationStartDate","onQueueTimes"],"properties":{"calculationStartDate":{"type":"string","format":"date-time","description":"Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results"},"onQueueTimes":{"type":"array","description":"List of agent on queue times by management unit","items":{"$ref":"#/definitions/MuAgentQueueTimeRequest"}}}},"PerformancePredictionRecalculationResponse":{"type":"object","required":["operationId","state"],"properties":{"operationId":{"type":"string","description":"The operationId for which to listen"},"downloadUrl":{"type":"string","description":"The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete'"},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/PerformancePredictionOutputs"},"state":{"type":"string","description":"The state of the performance prediction","enum":["Processing","Complete","Error"]}}},"BuScheduleRun":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"schedulerRunId":{"type":"string","description":"The scheduler run ID. Reference this value for support"},"intradayRescheduling":{"type":"boolean","description":"Whether this is an intraday rescheduling run"},"state":{"type":"string","description":"The state of the generation run","enum":["None","Queued","Scheduling","Canceled","Failed","Complete"]},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by the schedule"},"percentComplete":{"type":"number","format":"double","description":"Percent completion of the schedule run"},"targetWeek":{"type":"string","format":"date","description":"The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"The generated schedule. Null unless the schedule run is complete","$ref":"#/definitions/BuScheduleReference"},"scheduleDescription":{"type":"string","description":"The description of the generated schedule"},"schedulingStartTime":{"type":"string","format":"date-time","description":"When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schedulingStartedBy":{"description":"The user who started the scheduling run","$ref":"#/definitions/UserReference"},"schedulingCanceledBy":{"description":"The user who canceled the scheduling run, if applicable","$ref":"#/definitions/UserReference"},"schedulingCompletedTime":{"type":"string","format":"date-time","description":"When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messageSeverityCounts":{"type":"array","description":"The list of schedule generation message counts by severity for this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageSeverityCount"}},"reschedulingOptions":{"description":"Rescheduling options for this run. Null unless intradayRescheduling is true","$ref":"#/definitions/ReschedulingOptionsRunResponse"},"reschedulingResultExpiration":{"type":"string","format":"date-time","description":"When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleRunListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleRun"}}}},"ReschedulingManagementUnitResponse":{"type":"object","properties":{"managementUnit":{"description":"The management unit","$ref":"#/definitions/ManagementUnitReference"},"applied":{"type":"boolean","description":"Whether the rescheduling run is applied for the given management unit"}}},"ReschedulingOptionsRunResponse":{"type":"object","properties":{"existingSchedule":{"description":"The existing schedule to which this reschedule run applies","$ref":"#/definitions/BuScheduleReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnits":{"type":"array","description":"Per-management unit rescheduling options","items":{"$ref":"#/definitions/ReschedulingManagementUnitResponse"}},"agentCount":{"type":"integer","format":"int32","description":"The number of agents to be considered in the reschedule"},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes being considered for reschedule","uniqueItems":true,"items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Whether weekly paid time is allowed to be changed"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Whether daily paid time is allowed to be changed"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Whether shift start times are allowed to be changed"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Whether manually edited shifts are allowed to be changed"}}},"SchedulerMessageSeverityCount":{"type":"object","properties":{"severity":{"type":"string","description":"The schedule message severity","enum":["Ignore","Information","Warning","Error"]},"count":{"type":"integer","format":"int32","description":"The number of schedule messages with the given severity"}}},"BuAgentScheduleRescheduleResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"BuHeadcountForecast":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuPlanningGroupHeadcountForecast"}},"referenceStartDate":{"type":"string","format":"date-time","description":"Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuPlanningGroupHeadcountForecast":{"type":"object","properties":{"planningGroup":{"description":"The planning group to which this portion of the headcount forecast applies","$ref":"#/definitions/PlanningGroupReference"},"requiredPerInterval":{"type":"array","description":"Required headcount per interval, referenced against the reference start date","items":{"type":"number","format":"double"}},"requiredWithoutShrinkagePerInterval":{"type":"array","description":"Required headcount per interval without accounting for shrinkage, referenced against the reference start date","items":{"type":"number","format":"double"}}}},"BuRescheduleAgentScheduleResult":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this part of the result applies","$ref":"#/definitions/ManagementUnitReference"},"downloadResult":{"description":"The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/MuRescheduleResultWrapper"},"downloadUrl":{"type":"string","description":"The download URL from which to fetch the result"}}},"BuRescheduleResult":{"type":"object","properties":{"generationResults":{"description":"The generation results. Note the result will always be delivered via the generationResultsDownloadUrl; however the schema is included for documentation","$ref":"#/definitions/ScheduleGenerationResult"},"generationResultsDownloadUrl":{"type":"string","description":"The download URL from which to fetch the generation results for the rescheduling run"},"headcountForecast":{"description":"The headcount forecast. Note the result will always be delivered via the headcountForecastDownloadUrl; however the schema is included for documentation","$ref":"#/definitions/BuHeadcountForecast"},"headcountForecastDownloadUrl":{"type":"string","description":"The download URL from which to fetch the headcount forecast for the rescheduling run"},"agentSchedules":{"type":"array","description":"List of download links for agent schedules produced by the rescheduling run","items":{"$ref":"#/definitions/BuRescheduleAgentScheduleResult"}}}},"MuRescheduleResultWrapper":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The list of agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleRescheduleResponse"}}}},"PlanningGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleGenerationMessage":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory","UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory","UnableToScheduleMaxWeeklyPaidTimeFromTimeOff","UnableToScheduleMaxWorkDayPaidTimeFromTimeOff","UnableToScheduleMinIntershiftTimeFromAgentHistory","UnableToScheduleMinIntershiftTimeFromDst","UnableToScheduleMinShiftStartDistanceFromAgentHistory","UnableToScheduleMinShiftStartDistanceFromDst","UnableToScheduleMinWeeklyPaidTimeFromTimeOff","UnableToScheduleMinWeeklyWorkDaysFromTimeOff","UnableToScheduleMinWorkDayPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff","UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff","UnableToScheduleWorkDayFromTimeOff","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"]},"arguments":{"type":"array","description":"The arguments describing the message","items":{"$ref":"#/definitions/SchedulerMessageArgument"}}}},"ScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The ID of the schedule generation run. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messages":{"type":"array","description":"User facing messages related to the schedule generation run","items":{"$ref":"#/definitions/ScheduleGenerationMessage"}},"messageSeverities":{"type":"array","description":"The list of messages by severity in this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}}}},"SchedulerMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of this message parameter","enum":["AgentId","Date"]},"value":{"type":"string","description":"The value of this message parameter"}}},"PatchBuReschedulingOptionsManagementUnitRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The management unit portion of the rescheduling run to update"},"applied":{"type":"boolean","description":"Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied"}}},"PatchBuReschedulingOptionsRequest":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Per-management unit rescheduling options to update","items":{"$ref":"#/definitions/PatchBuReschedulingOptionsManagementUnitRequest"}}}},"PatchBuScheduleRunRequest":{"type":"object","properties":{"reschedulingOptions":{"description":"The rescheduling options to update","$ref":"#/definitions/PatchBuReschedulingOptionsRequest"}}},"BuAgentSchedulesSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}}}},"BuAsyncAgentSchedulesSearchResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesSearchResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuSearchAgentSchedulesRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userIds":{"type":"array","description":"IDs of the users for whose schedules to search","items":{"type":"string"}}}},"BuAsyncScheduleResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuManagementUnitScheduleSummary":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this summary applies","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents from this management unit that are in the schedule"},"startDate":{"type":"string","format":"date-time","description":"The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agents":{"type":"array","description":"The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}}}},"BuScheduleMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"managementUnits":{"type":"array","description":"High level per-management unit schedule metadata","items":{"$ref":"#/definitions/BuManagementUnitScheduleSummary"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleGenerationResultSummary":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The ID of the schedule generation run. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messageSeverityCounts":{"type":"array","description":"The list of schedule generation message counts by severity for this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageSeverityCount"}}}},"BuAsyncScheduleRunResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleRun"}}},"BuRescheduleRequest":{"type":"object","required":["doNotChangeDailyPaidTime","doNotChangeManuallyEditedShifts","doNotChangeShiftStartTimes","doNotChangeWeeklyPaidTime","managementUnitIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentIds":{"type":"array","description":"The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored","items":{"type":"string"}},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes","items":{"type":"string"}},"managementUnitIds":{"type":"array","description":"The IDs of the management units to reschedule","items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change weekly paid time"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change daily paid time"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change shift start times"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change manually edited shifts"}}},"SchedulingTestingOptionsRequest":{"type":"object","properties":{"fastScheduling":{"type":"boolean","description":"Whether to enable fast scheduling"},"delayScheduling":{"type":"boolean","description":"Whether to force delayed scheduling"},"failScheduling":{"type":"boolean","description":"Whether to force scheduling to fail"},"populateWarnings":{"type":"boolean","description":"Whether to populate warnings in the generated schedule"},"populateDeprecatedWarnings":{"type":"boolean","description":"Whether to populate deprecated warnings in the generated schedule"}}},"BuScheduleListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleListItem"}}}},"BuCreateBlankScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"BuImportAgentScheduleUploadSchema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of the user to whom this agent schedule applies"},"workPlanId":{"description":"The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek","$ref":"#/definitions/ValueWrapperString"},"workPlanIdsPerWeek":{"description":"The IDs of the work plans per week for this user. Mutually exclusive with workPlanId","$ref":"#/definitions/ListWrapperString"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Any full day time off markers that apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"ImportScheduleUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/ImportScheduleUploadSchema"}}},"ImportScheduleUploadSchema":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the imported schedule"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks the imported schedule will cover"},"published":{"type":"boolean","description":"Whether the imported schedule should be immediately published"},"shortTermForecast":{"description":"The short term forecast to associate with the imported schedule","$ref":"#/definitions/BuShortTermForecastReference"},"headcountForecast":{"description":"The headcount forecast to associate with the imported schedule","$ref":"#/definitions/BuHeadcountForecast"},"agentSchedules":{"type":"array","description":"Individual agent schedules","items":{"$ref":"#/definitions/BuImportAgentScheduleUploadSchema"}}}},"ListWrapperString":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"ScheduleUploadProcessingResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuGenerateScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"},"options":{"description":"Additional scheduling options","$ref":"#/definitions/SchedulingOptionsRequest"}}},"SchedulingNoForecastOptionsRequest":{"type":"object","properties":{"shiftLength":{"type":"string","description":"The shift length option to apply if no forecast is supplied","enum":["Shortest","Median","Longest","Random"]},"shiftStart":{"type":"string","description":"The shift start option to apply if no forecast is supplied","enum":["Earliest","Median","Latest","Random"]}}},"SchedulingOptionsRequest":{"type":"object","properties":{"noForecastOptions":{"description":"Schedule generation options to apply if no forecast is supplied","$ref":"#/definitions/SchedulingNoForecastOptionsRequest"}}},"BuCopyScheduleRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the new schedule"},"weekDate":{"type":"string","format":"date","description":"The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuHeadcountForecastResponse":{"type":"object","properties":{"result":{"description":"The headcount forecast, null when downloadUrl is provided","$ref":"#/definitions/BuHeadcountForecast"},"downloadUrl":{"type":"string","description":"Download URL. Null unless the response is too large to pass directly through the api"}}},"BuAgentScheduleQueryResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}},"metadata":{"description":"Versioned entity metadata for this agent schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAgentSchedulesQueryResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleQueryResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which these schedules apply"}}},"BuAsyncAgentSchedulesQueryResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesQueryResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuQueryAgentSchedulesRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"userIds":{"type":"array","description":"The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}},"teamIds":{"type":"array","description":"The teamIds to request. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit","uniqueItems":true,"items":{"type":"string"}}}},"BuAgentScheduleHistoryChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shifts":{"type":"array","description":"The list of changed shifts","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"The list of changed full day time off markers","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryChangeMetadata":{"type":"object","properties":{"dateModified":{"type":"string","format":"date-time","description":"The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user that made the schedule change","$ref":"#/definitions/UserReference"}}},"BuAgentScheduleHistoryDeletedChange":{"type":"object","properties":{"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"agentSchedule":{"type":"boolean","description":"Whether the entire agent schedule was deleted"}}},"BuAgentScheduleHistoryDroppedChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryResponse":{"type":"object","properties":{"priorPublishedSchedules":{"type":"array","description":"The list of previously published schedules","items":{"$ref":"#/definitions/BuScheduleReference"}},"basePublishedSchedule":{"description":"The originally published agent schedules","$ref":"#/definitions/BuAgentScheduleHistoryChange"},"droppedChanges":{"type":"array","description":"The changes dropped from the schedule history. This will happen if the schedule history is too large","items":{"$ref":"#/definitions/BuAgentScheduleHistoryDroppedChange"}},"changes":{"type":"array","description":"The list of changes for the schedule history","items":{"$ref":"#/definitions/BuAgentScheduleHistoryChange"}}}},"BuUpdateAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shift"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"},"delete":{"type":"boolean","description":"Set to true to delete the shift from the agent's schedule"}}},"BuUpdateAgentScheduleUploadSchema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of the user to whom this agent schedule applies"},"workPlanId":{"description":"The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek","$ref":"#/definitions/ValueWrapperString"},"workPlanIdsPerWeek":{"description":"The IDs of the work plans per week for this user. Mutually exclusive with workPlanId","$ref":"#/definitions/ListWrapperString"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuUpdateAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Any full day time off markers that apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"metadata":{"description":"Version metadata for this agent schedule. Required if updating or deleting an existing agent schedule, otherwise should be omitted","$ref":"#/definitions/WfmVersionedEntityMetadata"},"delete":{"type":"boolean","description":"Whether to delete this agent's schedule. Defaults to false if not set"}}},"UpdateScheduleUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/UpdateScheduleUploadSchema"}}},"UpdateScheduleUploadSchema":{"type":"object","required":["metadata"],"properties":{"description":{"type":"string","description":"The description to set for the schedule"},"published":{"type":"boolean","description":"Whether to publish the schedule. Note: a schedule cannot be un-published unless another schedule is published over it"},"shortTermForecast":{"description":"The short term forecast to associate with the schedule","$ref":"#/definitions/BuShortTermForecastReference"},"headcountForecast":{"description":"The headcount forecast to associate with the schedule","$ref":"#/definitions/BuHeadcountForecast"},"agentSchedules":{"type":"array","description":"Individual agent schedules","items":{"$ref":"#/definitions/BuUpdateAgentScheduleUploadSchema"}},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ProcessScheduleUpdateUploadRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"The uploadKey provided by the request to get an upload URL"},"teamIds":{"type":"array","description":"The list of teams to which the users being modified belong. Only required if the requesting user has conditional permission to wfm:schedule:edit","uniqueItems":true,"items":{"type":"string"}},"managementUnitIdsForAddedTeamUsers":{"type":"array","description":"The set of muIds to which agents belong if agents are being newly added to the schedule, if the requesting user has conditional permission to wfm:schedule:edit","uniqueItems":true,"items":{"type":"string"}}}},"UserListScheduleRequestBody":{"type":"object","required":["endDate","startDate","userIds"],"properties":{"userIds":{"type":"array","description":"The user ids for which to fetch schedules","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false"}}},"ScheduleGenerationWarning":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user in the warning"},"userNotLicensed":{"type":"boolean","description":"Whether the user does not have the appropriate license to be scheduled"},"unableToMeetMaxDays":{"type":"boolean","description":"Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan"},"unableToScheduleRequiredDays":{"type":"array","description":"Days indicated as required to work in agent work plan where no viable shift was found to schedule","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"unableToMeetMinPaidForTheWeek":{"type":"boolean","description":"Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan"},"unableToMeetMaxPaidForTheWeek":{"type":"boolean","description":"Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan"},"noNeedDays":{"type":"array","description":"Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"shiftsTooCloseTogether":{"type":"boolean","description":"Whether the schedule did not meet the minimum time between shifts defined in the agent work plan"}}},"ShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"The weekDate of the short term forecast in yyyy-MM-dd format"},"description":{"type":"string","description":"The description of the short term forecast"}}},"WeekScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation failed"},"runId":{"type":"string","description":"ID of the schedule run"},"agentWarnings":{"type":"array","description":"Warning messages from the schedule run. This will be available only when requesting information for a single week schedule","items":{"$ref":"#/definitions/ScheduleGenerationWarning"}},"agentWarningCount":{"type":"integer","format":"int32","description":"Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules"}}},"WeekScheduleListItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WeekScheduleListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekScheduleListItemResponse"}}}},"HeadcountForecast":{"type":"object","required":["required","requiredWithoutShrinkage"],"properties":{"required":{"type":"array","description":"Headcount information with shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}},"requiredWithoutShrinkage":{"type":"array","description":"Headcount information without shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}}}},"HeadcountInterval":{"type":"object","required":["interval","value"],"properties":{"interval":{"type":"string","format":"date-time","description":"The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule"},"value":{"type":"number","format":"double","description":"Headcount value for this interval"}}},"WeekSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"userSchedules":{"type":"object","description":"User schedules in the week","additionalProperties":{"$ref":"#/definitions/UserSchedule"}},"headcountForecast":{"description":"Headcount information for the week schedule","$ref":"#/definitions/HeadcountForecast"},"agentSchedulesVersion":{"type":"integer","format":"int32","description":"Version of agent schedules in the week schedule"}}},"WeekScheduleResponse":{"type":"object","properties":{"result":{"description":"The result of the request. The value will be null if response is large","$ref":"#/definitions/WeekSchedule"},"downloadUrl":{"type":"string","description":"The url to fetch the result for large responses. The value is null if result contains the data"}}},"SchedulingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.'","readOnly":true,"enum":["BadJson","NotFound","Fail"]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"SchedulingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the scheduling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the scheduling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/SchedulingProcessingError"}},"schedulingResultUri":{"type":"string","description":"The uri of the scheduling result. It has a value if the status is 'Success'.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"The percentage of the job that is complete.","readOnly":true}}},"HistoricalShrinkageActivityCategoryResponse":{"type":"object","properties":{"activityCategory":{"type":"string","description":"Activity category for which shrinkage data is provided","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"shrinkageForActivityCategory":{"description":"Aggregated shrinkage data for the activity category","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"},"shrinkageForActivityCodes":{"type":"array","description":"Shrinkage for the activity codes under this activity category","items":{"$ref":"#/definitions/HistoricalShrinkageActivityCodeResponse"}}}},"HistoricalShrinkageActivityCodeResponse":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code for which shrinkage data is provided"},"shrinkageForActivityCode":{"description":"Aggregated shrinkage data for the activity code","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"}}},"HistoricalShrinkageAggregateResponse":{"type":"object","properties":{"scheduledShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for scheduled activities"},"scheduledShrinkagePercent":{"type":"number","format":"double","description":"Aggregated shrinkage value in percent from 0.0 to 100.0 for scheduled activities"},"actualShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated actual value in seconds for scheduled activities"},"actualShrinkagePercent":{"type":"number","format":"double","description":"Aggregated actual value in percent from 0.0 to 100.0 for scheduled activities"},"paidShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for paid activities"},"unpaidShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for unpaid activities"},"plannedShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for planned activities"},"unplannedShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for unplanned activities"}}},"HistoricalShrinkageResult":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"totalScheduledDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for which agents in the management unit are scheduled"},"totalLoggedInDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for which agents in the management unit are actually logged-in"},"aggregatedShrinkage":{"description":"Aggregated shrinkage data for all the activity categories","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"},"shrinkageForActivityCategories":{"type":"array","description":"Shrinkage for activity categories","items":{"$ref":"#/definitions/HistoricalShrinkageActivityCategoryResponse"}},"businessUnitIds":{"type":"array","description":"List of all business units of all the agents in response","items":{"type":"string"}}}},"HistoricalShrinkageResultListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HistoricalShrinkageResult"}}}},"WfmHistoricalShrinkageResponse":{"type":"object","properties":{"operationId":{"type":"string","description":"The operationId for which to listen"},"downloadUrls":{"type":"array","description":"The url list to GET the results of the Historical Shrinkage query. This field is populated only if query state is Complete","items":{"type":"string"}},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/HistoricalShrinkageResultListing"},"state":{"type":"string","description":"The state of the shrinkage query","enum":["Processing","Complete","Error"]}}},"WfmHistoricalShrinkageRequest":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. If it is not set, the business unit time zone will be used. The results will be returned as UTC timestamps regardless of the time zone input."},"granularity":{"type":"string","description":"Shrinkage aggregation interval granularity.","enum":["Daily","Weekly"]}}},"WfmHistoricalShrinkageTeamsRequest":{"type":"object","required":["startDate","timeZone"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. The results will be returned as UTC timestamps regardless of the time zone input."},"granularity":{"type":"string","description":"Shrinkage aggregation interval granularity","enum":["Daily","Weekly"]}}},"TimeOffBalanceJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffBalanceResponse":{"type":"object","required":["activityCodeId","hrisTimeOffTypeId"],"properties":{"activityCodeId":{"type":"string","description":"The ID for activity code associated with time off balance"},"hrisTimeOffTypeId":{"type":"string","description":"The ID of the time off type configured in HRIS integration"},"hrisTimeOffTypeSecondaryId":{"type":"string","description":"The secondary ID of the time off type configured in HRIS integration"},"startDate":{"type":"string","format":"date","description":"The Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"balanceMinutesPerDay":{"type":"array","description":"The list of available time off balance values in minutes for each day","items":{"type":"integer","format":"int32"}}}},"TimeOffBalancesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/TimeOffBalanceJobReference"},"entities":{"type":"array","description":"The list of time off balances. May come via notification","items":{"$ref":"#/definitions/TimeOffBalanceResponse"}}}},"TimeOffBalanceRequest":{"type":"object","required":["activityCodeIds"],"properties":{"activityCodeIds":{"type":"array","description":"The set of activity code IDs for which to query available time off balances","uniqueItems":true,"items":{"type":"string"}},"dateRanges":{"type":"array","description":"The list of date ranges for which to query time off balance","items":{"$ref":"#/definitions/LocalDateRange"}}}},"TimeOffBalanceJobResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffBalanceResponse"}},"status":{"type":"string","description":"The status of the time off balance job","enum":["Processing","Complete","Error"]}}},"BuTimeOffLimitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitResponse"}}}},"BuTimeOffLimitResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"staffingGroup":{"description":"The staffing group to which this time-off limit is associated. If managementUnit is set, then the staffing group belongs to that management unit.Otherwise, if managementUnit is not set, it is a business unit level staffing group.At least one of managementUnit and staffingGroup must be set","$ref":"#/definitions/StaffingGroupReference"},"managementUnit":{"description":"The management unit to which this time-off limit is associated. If staffingGroup is set, then the limit is associated with that staffing group, which belongs to this management unit.At least one of managementUnit and staffingGroup must be set","$ref":"#/definitions/ManagementUnitReference"},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuCreateTimeOffLimitRequest":{"type":"object","properties":{"staffingGroupId":{"type":"string","description":"The ID of the staffing group to which this time-off limit is associated. It can be either management unit or business unit level staffing group. One of managementUnitId or staffingGroupId must be set. This must not be set if managementUnitId has value"},"managementUnitId":{"type":"string","description":"The ID of the management unit to which this time-off limit is associated. One of managementUnitId or staffingGroupId must be set. This must not be set if staffingGroupId has value"}}},"BuSetTimeOffLimitValuesRequest":{"type":"object","required":["metadata"],"properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitRange"}},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuTimeOffLimitRange":{"type":"object","required":["limitMinutesPerDay","startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the range. The end date is determined by the size of 'limitMinutesPerDay'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"limitMinutesPerDay":{"type":"array","description":"The list of time-off limit values in minutes per day. If 'null' is specified, then the day-specific value is cleared. Such a day will have a value of 0","items":{"type":"integer","format":"int32"}}}},"BuTimeOffLimitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuTimeOffLimitValueRange":{"type":"object","required":["allocatedMinutesPerInterval","granularity","limitMinutesPerInterval","metadata","startDate","timeOffLimit","waitlistedMinutesPerInterval","waitlistedRequestsPerInterval"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"timeOffLimit":{"description":"The ID of the time-off limit","$ref":"#/definitions/BuTimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists"},"granularity":{"type":"string","description":"Granularity choice for time-off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"A list of time-off limit values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"allocatedMinutesPerInterval":{"type":"array","description":"A list of allocated time-off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedMinutesPerInterval":{"type":"array","description":"A list of waitlisted time-off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time-off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuTimeOffLimitValuesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitValueRange"}}}},"BuTimeOffPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"BuTimeOffPlanResponse":{"type":"object","required":["activityCodeIds","autoApprovalRule","countAgainstTimeOffLimits","daysBeforeStartToExpireFromWaitlist","enabled","metadata","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"type":"array","description":"The IDs of activity codes associated with this time-off plan","uniqueItems":true,"items":{"type":"string"}},"timeOffLimits":{"type":"array","description":"The IDs of time-off limits associated with this time-off plan","uniqueItems":true,"items":{"$ref":"#/definitions/BuTimeOffLimitReference"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/HrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan is currently being used by agents"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan counts against time-off limits"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/TimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management Unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/TimeOffPlanManagementUnitAssociation"},"metadata":{"description":"Version metadata for the time-off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Management units to which this time-off plan applies. This must not be set if staffingGroups is populated","uniqueItems":true,"items":{"$ref":"#/definitions/ManagementUnitReference"}},"staffingGroups":{"type":"array","description":"Staffing groups to which this time-off plan applies. This must not be set if managementUnits is populated","uniqueItems":true,"items":{"$ref":"#/definitions/StaffingGroupReference"}}}},"TimeOffPlanManagementUnitAssociation":{"type":"object","required":["managementUnit"],"properties":{"managementUnit":{"description":"Management unit to which this time-off plan belongs","$ref":"#/definitions/ManagementUnitReference"},"staffingGroups":{"type":"array","description":"Staffing groups to which this time-off plan applies. If not defined, the plan applies to the management unit","uniqueItems":true,"items":{"$ref":"#/definitions/StaffingGroupReference"}}}},"BuCreateTimeOffPlanRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"type":"array","description":"The IDs of activity codes to associate with this time-off plan","uniqueItems":true,"items":{"type":"string"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan. Default is Never","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist. Default is 0"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/HrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan should be used by agents. Default is true"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan should count against time-off limits. Default is false"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/CreateTimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/CreateTimeOffPlanManagementUnitAssociation"}}},"CreateTimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnitIds":{"type":"array","description":"The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated","uniqueItems":true,"items":{"type":"string"}},"staffingGroupIds":{"type":"array","description":"The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated","uniqueItems":true,"items":{"type":"string"}}}},"CreateTimeOffPlanManagementUnitAssociation":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to which this time-off plan belongs"},"staffingGroupIds":{"type":"array","description":"A IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit","uniqueItems":true,"items":{"type":"string"}}}},"BuUpdateTimeOffPlanRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"description":"The IDs of activity codes to associate with this time-off plan","$ref":"#/definitions/SetWrapperString"},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/ValueWrapperHrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan should be used by agents"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan should count against time-off limits"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/UpdateTimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/UpdateTimeOffPlanManagementUnitAssociation"},"metadata":{"description":"Version metadata for this time-off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdateTimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnitIds":{"description":"The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated","$ref":"#/definitions/SetWrapperString"},"staffingGroupIds":{"description":"The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated","$ref":"#/definitions/SetWrapperString"}}},"UpdateTimeOffPlanManagementUnitAssociation":{"type":"object","properties":{"staffingGroupIds":{"description":"The IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit","$ref":"#/definitions/SetWrapperString"}}},"Workbin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Workbin name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"Workbin description"},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The id of the User who modified the Workbin.","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkbinQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workbin"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32","description":"Count of items returned by the query. Refer to the \"select\" request parameter for more information."}}},"WorkbinQueryRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorkbinQuerySort"}}},"WorkbinQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateModified","name"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"Attribute name."},"type":{"type":"string","description":"Attribute type.","enum":["String","Int"]},"operator":{"type":"string","description":"Filter operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH"]},"values":{"type":"array","description":"List of values to be used in the filter.","items":{"type":"string"}}}},"WorkbinUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Workbin name. Valid length between 3 and 256 characters."},"description":{"type":"string","description":"Workbin description. Maximum length of 4096 characters."}}},"WorkbinCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Workbin name. Valid length between 3 and 256 characters."},"description":{"type":"string","description":"Workbin description. Maximum length of 4096 characters."},"divisionId":{"type":"string","description":"The ID of the division the Workbin belongs to. Defaults to home division ID."}}},"AutoStatusTransitionDetail":{"type":"object","properties":{"nextStatus":{"description":"Next status of auto status transition.","$ref":"#/definitions/WorkitemStatusReference"},"dateOfTransition":{"type":"string","format":"date-time","description":"Date at which auto status transition occurs. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"errorDetails":{"description":"This property will be set if auto status transition is failed.","$ref":"#/definitions/TaskManagementErrorDetails"}}},"ExternalContactReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TaskManagementErrorDetails":{"type":"object","properties":{"code":{"type":"string","description":"System defined error code for the error."},"message":{"type":"string","description":"Error message."}}},"WorkbinReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Workitem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Workitem."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"type":{"description":"The Worktype of the Workitem.","$ref":"#/definitions/WorktypeReference"},"description":{"type":"string","description":"The description of the Workitem."},"language":{"description":"The language of the Workitem.","$ref":"#/definitions/LanguageReference"},"utilizationLabel":{"description":"The utilization label of the Workitem.","$ref":"#/definitions/WorkitemUtilizationLabelReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the workitem."},"ttl":{"type":"integer","format":"int32","description":"The time to live of the Workitem in seconds."},"status":{"description":"The current Status of the Workitem.","$ref":"#/definitions/WorkitemStatusReference"},"statusCategory":{"type":"string","description":"The Category of the current Status of the Workitem.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"dateStatusChanged":{"type":"string","format":"date-time","description":"The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateClosed":{"type":"string","format":"date-time","description":"The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workbin":{"description":"The Workbin that contains the Workitem.","$ref":"#/definitions/WorkbinReference"},"reporter":{"description":"The reporter of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"assignee":{"description":"The assignee of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"externalContact":{"description":"The external contact of the Workitem.","$ref":"#/definitions/ExternalContactReference"},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"modifiedBy":{"description":"The User who modified the Workitem.","$ref":"#/definitions/UserReference"},"queue":{"description":"The Workitems queue.","$ref":"#/definitions/WorkitemQueueReference"},"assignmentState":{"type":"string","description":"The assignment state of the workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"dateAssignmentStateChanged":{"type":"string","format":"date-time","description":"The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The duration in seconds before an alert will timeout."},"skills":{"type":"array","description":"The skills of the Workitem.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"preferredAgents":{"type":"array","description":"The preferred agents of the Workitem.","items":{"$ref":"#/definitions/UserReference"}},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"schema":{"description":"The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time.","$ref":"#/definitions/WorkitemSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the Workitem.","additionalProperties":{"type":"object"}},"autoStatusTransitionDetail":{"description":"Auto status transition details of Workitem.","$ref":"#/definitions/AutoStatusTransitionDetail"},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem.","items":{"$ref":"#/definitions/WorkitemScoredAgent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemQueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemSchema":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The version of the Workitem custom attribute schema."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/UserReference"},"score":{"type":"integer","format":"int32","description":"Agent's score for the workitem, from 0 - 100, higher being better"}}},"WorkitemStatusReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemUtilizationLabelReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorktypeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemCreate":{"type":"object","required":["name","typeId"],"properties":{"name":{"type":"string","description":"The name of the Workitem. Valid length between 3 and 256 characters."},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the Workitem. Maximum of 365 days."},"ttl":{"type":"integer","format":"int32","description":"The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."},"statusId":{"type":"string","description":"The ID of the Status of the Workitem."},"workbinId":{"type":"string","description":"The ID of Workbin that contains the Workitem."},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"description":{"type":"string","description":"The description of the Workitem. Maximum length of 4096 characters."},"typeId":{"type":"string","description":"The ID of the Worktype of the Workitem."},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the worktype of the workitem.","additionalProperties":{"type":"object"}},"queueId":{"type":"string","description":"The ID of the Workitems queue. Must be a valid UUID."},"assigneeId":{"type":"string","description":"The ID of the assignee of the Workitem. Must be a valid UUID."},"wrapupCode":{"type":"string","description":"The ID of the wrapup. Must be a valid UUID."},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents.","items":{"$ref":"#/definitions/WorkitemScoredAgentRequest"}},"languageId":{"type":"string","description":"The ID of language of the Workitem. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of utilization label of the Workitem. Must be a valid UUID."},"externalContactId":{"type":"string","description":"The ID of the external contact of the Workitem. Must be a valid UUID."},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"skillIds":{"type":"array","description":"The skill IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"The preferred agent IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}}}},"WorkitemScoredAgentRequest":{"type":"object","properties":{"id":{"type":"string","description":"An agents ID. Must be a valid UUID."},"score":{"type":"integer","format":"int32","description":"Agent's score for the workitem, from 0 - 100, higher being better"}}},"WorkitemQueryJobError":{"type":"object","properties":{"code":{"type":"string","description":"System defined error code for the error."},"message":{"type":"string","description":"Error message for the failed job."}}},"WorkitemQueryJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the query job","enum":["Queued","Running","Succeeded","Failed"]},"dateStarted":{"type":"string","format":"date-time","description":"The date the job was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateFinished":{"type":"string","format":"date-time","description":"The date the job finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"error":{"description":"The error associated with the query job, if the state is Failed","$ref":"#/definitions/WorkitemQueryJobError"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemQueryJobCreate":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"The total page size requested. Default 25","minimum":1,"maximum":200},"pageNumber":{"type":"integer","format":"int32","description":"The page number requested","minimum":1},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemQueryJobFilter"}},"expands":{"type":"array","description":"List of entity attributes to be expanded in the result.","items":{"type":"string","enum":["type","workbin","status","assignee","reporter","queue"]}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"sort":{"description":"Sort","$ref":"#/definitions/WorkitemQueryJobSort"}}},"WorkitemQueryJobFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Attribute name."},"operator":{"type":"string","description":"Filter operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH"]},"values":{"type":"array","description":"List of values to be used in the filter.","items":{"type":"string"}}}},"WorkitemQueryJobSort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting.","enum":["dateDue","priority"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemPagedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workitem"}},"pageSize":{"type":"integer","format":"int32","description":"The total page size requested"},"pageNumber":{"type":"integer","format":"int32","description":"The page number requested"}}},"WorkitemTerminate":{"type":"object","properties":{"statusId":{"type":"string","description":"The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status."}}},"WorkitemUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Workitem. Valid length between 3 and 256 characters."},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the Workitem. Maximum of 365 days."},"ttl":{"type":"integer","format":"int32","description":"The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."},"statusId":{"type":"string","description":"The ID of the Status of the Workitem."},"workbinId":{"type":"string","description":"The ID of Workbin that contains the Workitem."},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"description":{"type":"string","description":"The description of the Workitem. Maximum length of 4096 characters."},"dateClosed":{"type":"string","format":"date-time","description":"The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignmentState":{"type":"string","description":"The assignment state of the Workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"assignmentOperation":{"type":"string","description":"Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent.","enum":["AgentAssignmentAlerting","QueueAssignmentAlerting"]},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed.","additionalProperties":{"type":"object"}},"queueId":{"type":"string","description":"The ID of the Workitems queue. Must be a valid UUID."},"assigneeId":{"type":"string","description":"The ID of the assignee of the Workitem. If supplied it must be a valid UUID."},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents.","items":{"$ref":"#/definitions/WorkitemScoredAgentRequest"}},"externalContactId":{"type":"string","description":"The ID of the external contact of the Workitem. Must be a valid UUID."},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"skillIds":{"type":"array","description":"The skill IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of language of the Workitem. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of the utilization label of the Workitem. Must be a valid UUID."},"preferredAgentIds":{"type":"array","description":"The preferred agent IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}}}},"WorkitemManualAssign":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"WorkitemReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemWrapup":{"type":"object","properties":{"workitem":{"description":"Workitem that the wrapup code has been added to.","$ref":"#/definitions/WorkitemReference"},"wrapupCode":{"description":"The wrapup code used in the workitem.","$ref":"#/definitions/WrapupIdReference"},"modifiedBy":{"description":"The user who added the wrapup code to the workitem.","$ref":"#/definitions/UserReference"},"user":{"description":"The user for whom wrapup code was added. This may be the same as modifiedBy.","$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem when the wrapup code was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"WrapupIdReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemWrapupUpdate":{"type":"object","required":["action","wrapupCode"],"properties":{"action":{"type":"string","description":"Action to be performed for the wrapup code.","enum":["Add","Remove"]},"wrapupCode":{"type":"string","description":"The wrapup code which will be added/removed."}}},"WorkitemWrapupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemWrapup"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"WorkitemStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"category":{"type":"string","description":"The Category of the Status.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"destinationStatuses":{"type":"array","description":"The Statuses the Status can transition to.","items":{"$ref":"#/definitions/WorkitemStatusReference"}},"description":{"type":"string","description":"The description of the Status."},"defaultDestinationStatus":{"description":"Default destination status to which this Status will transition to if auto status transition enabled.","$ref":"#/definitions/WorkitemStatusReference"},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition"},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"},"worktype":{"description":"The Worktype containing the Status.","$ref":"#/definitions/WorktypeReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemStatusUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Status. Valid length between 3 and 256 characters."},"destinationStatusIds":{"type":"array","description":"A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations.","items":{"type":"string"}},"description":{"type":"string","description":"The description of the Status. Maximum length of 4096 characters."},"defaultDestinationStatusId":{"type":"string","description":"Default destination status to which this Status will transition to if auto status transition enabled."},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"}}},"Worktype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Worktype."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The description of the Worktype."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultWorkbin":{"description":"The default Workbin for Workitems created from the Worktype.","$ref":"#/definitions/WorkbinReference"},"defaultStatus":{"description":"The default status for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemStatusReference"},"statuses":{"type":"array","description":"The list of possible statuses for Workitems created from the Worktype.","items":{"$ref":"#/definitions/WorkitemStatus"}},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultLanguage":{"description":"The default language for Workitems created from the Worktype.","$ref":"#/definitions/LanguageReference"},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype."},"modifiedBy":{"description":"The id of the User who modified the Worktype.","$ref":"#/definitions/UserReference"},"defaultQueue":{"description":"The default queue for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemQueueReference"},"defaultSkills":{"type":"array","description":"The default skills for Workitems created from the Worktype.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schema":{"description":"The schema defining the custom attributes for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemSchema"},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemStatusCreate":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the Status. Valid length between 3 and 256 characters."},"category":{"type":"string","description":"The Category of the Status.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"destinationStatusIds":{"type":"array","description":"A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations.","items":{"type":"string"}},"description":{"type":"string","description":"The description of the Status. Maximum length of 4096 characters."},"defaultDestinationStatusId":{"type":"string","description":"Default destination status to which this Status will transition to if auto status transition enabled."},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"}}},"WorkitemStatusListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemStatus"}},"selfUri":{"type":"string","format":"uri"}}},"WorktypeQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Worktype"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32","description":"Count of items returned by the query. Refer to the \"select\" request parameter for more information."}}},"WorktypeQueryRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorktypeQuerySort"}}},"WorktypeQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateModified","name"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorktypeUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Worktype. Valid length between 3 and 256 characters."},"defaultWorkbinId":{"type":"string","description":"The ID of the default Workbin for Workitems created from the Worktype."},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schemaId":{"type":"string","description":"The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100.","minimum":1,"maximum":100},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 4096 characters."},"defaultStatusId":{"type":"string","description":"The ID of the default status for Workitems created from the Worktype."},"schemaVersion":{"type":"integer","format":"int32","description":"The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."},"defaultLanguageId":{"type":"string","description":"The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."},"defaultSkillIds":{"type":"array","description":"The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs","items":{"type":"string"}},"defaultQueueId":{"type":"string","description":"The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."}}},"WorktypeCreate":{"type":"object","required":["defaultWorkbinId","name"],"properties":{"name":{"type":"string","description":"The name of the Worktype. Length between 3 and 256 characters."},"defaultWorkbinId":{"type":"string","description":"The ID of the default Workbin for Workitems created from the Worktype."},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schemaId":{"type":"string","description":"The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100.","minimum":1,"maximum":100},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 4096 characters."},"divisionId":{"type":"string","description":"The ID of the division the Worktype belongs to. Defaults to the default Workbin division ID. The Worktype must be in the same division as its default Workbin."},"disableDefaultStatusCreation":{"type":"boolean","description":"Set to true to disable default status creation. Default statuses are created with the Worktype by default"},"schemaVersion":{"type":"integer","format":"int32","description":"The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."},"defaultQueueId":{"type":"string","description":"The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."},"defaultLanguageId":{"type":"string","description":"The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."},"defaultSkillIds":{"type":"array","description":"The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs","items":{"type":"string"}}}},"ActionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ActionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tTotalExecution"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ActionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ActionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ActionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"BotAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/BotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/BotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"BotAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BotAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"ConversationAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ConversationAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"EvaluationAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"EvaluationAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"FlowExecutionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["divisionId","flowId","flowObjectId","flowVersion"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowExecutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlowExecutions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowExecutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"FlowExecutionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"FlowAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"FlowAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"JourneyAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"JourneyAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"KnowledgeAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/KnowledgeAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/KnowledgeAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"KnowledgeAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/KnowledgeAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"ResolutionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionAggregateQueryPredicate"}}}},"ResolutionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionAggregateQueryPredicate"}}}},"ResolutionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["queueId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ResolutionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nNextContactAvoided"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"ResolutionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["queueId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ResolutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nNextContactAvoided"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ResolutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ResolutionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ResolutionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ResolutionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"SurveyAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"SurveyAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"TaskManagementAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TaskManagementAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TaskManagementAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"TaskManagementAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TaskManagementAggregateDataContainer"}}}},"TaskManagementAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TaskManagementAggregateQueryPredicate"}}}},"TaskManagementAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TaskManagementAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TaskManagementAggregateQueryPredicate"}}}},"TaskManagementAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TaskManagementAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TaskManagementAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TaskManagementAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"TaskManagementAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"TaskManagementAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TaskManagementAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TaskManagementAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"TranscriptAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"TranscriptAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"UserAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"UserAsyncAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"OneOnOne":{"type":"object","properties":{"pinnedMessages":{"type":"array","description":"Room's pinned messages","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"ConversationUtilizationLabelUpdate":{"type":"object","properties":{"utilizationLabelId":{"type":"string","description":"The utilization label associated with the conversation."}}},"MeetingIdRecord":{"type":"object","required":["ephemeral"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"ephemeral":{"type":"boolean","description":"Boolean flag for ephemeral status of the created record"},"conferenceId":{"type":"string","description":"The conferenceId used to generate a meetingId"},"dateExpired":{"type":"string","format":"date-time","description":"Instant at which the meetingId record will no longer be considered active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GenerateMeetingIdRequest":{"type":"object","required":["ephemeral"],"properties":{"conferenceId":{"type":"string","description":"The conferenceId for which to generate a meetingId"},"ephemeral":{"type":"boolean","description":"Boolean flag for ephemeral status of the created record"},"expireTimeDays":{"type":"integer","format":"int32","description":"Number of days the meetingId record will remain active"}}},"ParticipantInfo":{"type":"object","properties":{"activeParticipantCount":{"type":"integer","format":"int32","description":"The number of active participants in the video conference."},"version":{"type":"integer","format":"int32","description":"The version of the participant count."}}},"VideoConferenceDetails":{"type":"object","properties":{"conferenceId":{"type":"string","description":"The conferenceId."},"conversationId":{"type":"string","description":"The conversationId of the video conference."},"participantInfo":{"description":"Information about the participants of the video conference.","$ref":"#/definitions/ParticipantInfo"}}},"ExecutionDataFlowSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"whether or not the setting is enabled."},"modifiedBy":{"description":"User that last changed the setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this setting was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExecutionDataSettingsRequest":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"whether or not the setting is enabled."}}},"FlowCharacteristics":{"type":"object","properties":{"executionItems":{"type":"boolean","description":"Whether to report execution data about individual actions, menus, states, tasks, etc. etc. that ran during execution of the flow."},"executionInputOutputs":{"type":"boolean","description":"Whether to report input setting input setting values and output data values for individual execution items above. For example, if you have FlowExecutionInputOutputs and a Call Data Action ran in a flow, if FlowExecutionItems was enabled you'd see the fact a Call Data Action ran and the output path it took but nothing about which Data Action it ran, the input data sent to it at flow runtime and the data returned from it. If you enable this characteristic, execution data will contain this additional detail."},"communications":{"type":"boolean","description":"Communications are either audio or digital communications sent to or received from a participant. An example here would be the initial greeting in an inbound call flow where it plays a greeting message to the participant."},"eventError":{"type":"boolean","description":"Whether to report flow error events."},"eventWarning":{"type":"boolean","description":"Whether to report flow warning events."},"eventOther":{"type":"boolean","description":"Whether to report events other than errors or warnings such as a language change, loop event."},"variables":{"type":"boolean","description":"Whether to report assignment of values to variables in flow execution data. It's important to remember there is a difference between variable value assignments and output data from an action. If you have a Call Digital Bot flow action in an Inbound Message flow and there is no variable bound to the Exit Reason output but FlowExecutionInputOutputs is enabled, you will still be able to see the exit reason from the digital bot flow in execution data even though it is not bound to a variable."},"names":{"type":"boolean","description":"This characteristic specifies whether or not name information should be emitted in execution data such as action, task, state or even the flow name itself. Names are very handy from a readability standpoint but they do take up additional space in flow execution data instances."}},"description":"This is a set of enabled characteristics for the loglevel"},"FlowLogLevel":{"type":"object","properties":{"level":{"type":"string","description":"The logLevel for this characteristics set","enum":["Unknown","Disabled","Base","Notes","VerboseNotes","All"]},"characteristics":{"description":"Shows what characteristics are enabled for this log level","$ref":"#/definitions/FlowCharacteristics"}},"description":"This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)"},"FlowSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The Flow Type","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"modifiedBy":{"description":"User that last changed the log level setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the log level setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this log level was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logLevelCharacteristics":{"description":"The log level set for this flow","$ref":"#/definitions/FlowLogLevel"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)"},"FlowLogLevelRequest":{"type":"object","required":["logLevelCharacteristics"],"properties":{"logLevelCharacteristics":{"description":"The log level characteristics currently set for this flow","$ref":"#/definitions/FlowLogLevel"}},"description":"Used to set the log level of a particular flow"},"FlowLogLevelCharacteristicsDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"minimumLevel":{"type":"string","description":"The minimum level required for this characteristic to be enabled.","readOnly":true,"enum":["Unknown","Disabled","Base","Notes","VerboseNotes","All"]},"dependsOn":{"description":"If set, this is the id of the characteristic that this one depends on and it must be enabled for this to be enabled.","readOnly":true,"$ref":"#/definitions/FlowCharacteristics"}},"description":"Defines a characteristic that can be captured by data providers"},"FlowLogLevelCharacteristicsDefinitions":{"type":"object","properties":{"logLevels":{"type":"array","description":"A list of flow log levels available to the organization.","readOnly":true,"items":{"$ref":"#/definitions/FlowLogLevel"}},"characteristics":{"type":"array","description":"A list of characteristics that the loglevels will have that are available to the organization..","readOnly":true,"items":{"$ref":"#/definitions/FlowLogLevelCharacteristicsDefinition"}}},"description":"A set of available characteristic definitions"},"FlowSettingsResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowSettingsResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Function":{"type":"object","required":["description","handler","runtime"],"properties":{"id":{"type":"string","description":"Function identifier.","readOnly":true},"name":{"type":"string","description":"Function name. This is automatically created based on the Action Id.","readOnly":true},"description":{"type":"string","description":"Description of the function. Limit 255 characters."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time function was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"zipId":{"type":"string","description":"Zip file identifier.","readOnly":true},"handler":{"type":"string","description":"Handler entry point into zip file to execute function. Should be path within upload function package to the invocation module without language extension, followed by a period and then exported invocation method name. e.g. 'src/index.handler'"},"runtime":{"type":"string","description":"Runtime required for execution. Valid runtimes change over time as versions are deprecated. Use /api/v2/integrations/actions/functions/runtimes for current list."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 60. Default value 15 seconds."}},"description":"Action function settings."},"FunctionConfig":{"type":"object","properties":{"id":{"type":"string","description":"Action identifier.","readOnly":true},"function":{"description":"Function configuration.","readOnly":true,"$ref":"#/definitions/Function"},"zip":{"description":"Zip file configuration and state.","readOnly":true,"$ref":"#/definitions/FunctionZipConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Current action function configuration and zip upload configuration."},"FunctionZipConfig":{"type":"object","properties":{"status":{"type":"string","description":"Status of zip upload.","enum":["Pending","Transferring","Available","Unknown"]},"id":{"type":"string","description":"Zip file Identifier"},"name":{"type":"string","description":"Zip file name"},"dateCreated":{"type":"string","format":"date-time","description":"Date and time zip record was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Action function current zip file upload settings and state."},"FunctionUploadResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"Upload time to live in seconds."}},"description":"Action function create upload URL response."},"FunctionUploadRequest":{"type":"object","required":["fileName"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 900 seconds"}},"description":"Action function URL upload input."},"FunctionRuntime":{"type":"object","properties":{"name":{"type":"string","description":"Name of the function runtime.","readOnly":true},"description":{"type":"string","description":"Description of function runtime.","readOnly":true},"status":{"type":"string","description":"Availability status of runtime","readOnly":true,"enum":["Available","Deprecated","Unavailable"]},"dateEndOfLife":{"type":"string","format":"date","description":"Optional end of life date. Present if the status is Deprecated. Date represents when support for runtime can no longer be guaranteed. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true}},"description":"Action function runtime."},"ChatUserSettings":{"type":"object","required":["mobile"],"properties":{"mobile":{"description":"Settings for mobile devices","$ref":"#/definitions/MobileSettings"}},"description":"Settings for a chat user"},"MobileNotificationSettings":{"type":"object","required":["when"],"properties":{"when":{"type":"string","description":"When the user should receive notifications","enum":["Always","OnlyWhenInactive"]}},"description":"Settings for a user's mobile notifications"},"MobileSettings":{"type":"object","required":["notifications"],"properties":{"notifications":{"description":"Settings for a user's mobile notifications","$ref":"#/definitions/MobileNotificationSettings"}},"description":"Settings for mobile devices"},"ActionEventActionMap":{"type":"object","required":["displayName","id","version"],"properties":{"id":{"type":"string","description":"The ID of the action map."},"selfUri":{"type":"string","format":"uri"},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"displayName":{"type":"string","description":"Display name of the action map."}}},"AppEvent":{"type":"object","required":["app","attributes","device","eventName","screenName","traits"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered)."},"screenName":{"type":"string","description":"The name of the screen in the app that the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"ipAddress":{"type":"string","description":"Customer's IP address. May be null if the business configures the tracker to not collect IP addresses."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events. Examples are email, name, phone.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}}}},"Event":{"type":"object","required":["correlationId","createdDate","eventType","id","session"],"properties":{"id":{"type":"string","description":"System-generated UUID for the event."},"correlationId":{"type":"string","description":"UUID corresponding to triggering action that caused this event (e.g. HTTP POST, SIP invite, another event)."},"customerId":{"type":"string","description":"Primary identifier of the customer in the source of the events."},"customerIdType":{"type":"string","description":"Type of primary identifier (e.g. cookie, email, phone)."},"session":{"description":"The session that the event belongs to.","$ref":"#/definitions/EventSession"},"eventType":{"type":"string","description":"The name representing the type of event."},"outcomeAchievedEvent":{"description":"Event where a customer has achieved a specific outcome or goal.","$ref":"#/definitions/OutcomeAchievedEvent"},"segmentAssignmentEvent":{"description":"Event that represents a segment being assigned.","$ref":"#/definitions/SegmentAssignmentEvent"},"webActionEvent":{"description":"Event triggered by web actions.","$ref":"#/definitions/WebActionEvent"},"webEvent":{"description":"Event that tracks user interactions with content in a browser such as pageviews, downloads, mobile ad clicks, etc.","$ref":"#/definitions/WebEvent"},"appEvent":{"description":"Event that tracks user interactions with content in an application such as screen views, searches, etc.","$ref":"#/definitions/AppEvent"},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EventAction":{"type":"object","required":["createdDate","id","mediaType","prompt","state"],"properties":{"id":{"type":"string","description":"ID of the action."},"state":{"type":"string","description":"Current state of the action (e.g. qualified, succeeded, errored).","enum":["accepted","rejected","timedout","errored","ignored","qualified","offered","started","engaged","qualifiedOutsideSchedule","offeredOutsideSchedule","abandoned","completed","frequencyCapReached"]},"mediaType":{"type":"string","description":"The media type used to deliver the action (e.g. email, webhook).","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"prompt":{"type":"string","description":"Prompt of the action to be displayed/sent to the visitor."},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EventListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Event"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"EventSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The ID of the session."},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","description":"Session types indicate the type or category of sessions (e.g. web, app)."}}},"OutcomeAchievedEvent":{"type":"object","required":["outcome"],"properties":{"outcome":{"description":"The outcome achieved.","$ref":"#/definitions/OutcomeAchievedEventOutcome"},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Visitor's IP address."},"ipOrganization":{"type":"string","description":"Visitor's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"visitReferrer":{"description":"Visit's referrer.","$ref":"#/definitions/Referrer"},"visitCreatedDate":{"type":"string","format":"date-time","description":"When visit was created (e.g. timestamp of the first event in visit). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAchievedEventOutcome":{"type":"object","required":["displayName","id","version"],"properties":{"id":{"type":"string","description":"ID of the outcome."},"selfUri":{"type":"string","format":"uri"},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."}}},"SegmentAssignmentEvent":{"type":"object","required":["segment"],"properties":{"segment":{"description":"The segment which was assigned.","$ref":"#/definitions/AddressableEntityRef"}}},"WebActionEvent":{"type":"object","required":["action","actionMap","actionTarget","browser","device","userAgentString"],"properties":{"action":{"description":"The action that triggered the event.","$ref":"#/definitions/EventAction"},"actionMap":{"description":"The action map that triggered the action.","$ref":"#/definitions/ActionEventActionMap"},"actionTarget":{"description":"The target for engagement actions.","$ref":"#/definitions/AddressableEntityRef"},"timeToDisposition":{"type":"integer","format":"int64","description":"Milliseconds elapsed until the action is disposed."},"errorCode":{"type":"string","description":"Code of the error returned when the action fails."},"errorMessage":{"type":"string","description":"Message of the error returned when the action fails."},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Visitor's IP address."},"ipOrganization":{"type":"string","description":"Visitor's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"visitReferrer":{"description":"Visit's referrer.","$ref":"#/definitions/Referrer"}}},"WebEvent":{"type":"object","required":["attributes","authenticated","browser","device","eventName","page","totalEventCount","totalPageviewCount","traits","userAgentString"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered)."},"totalEventCount":{"type":"integer","format":"int32","description":"The total count of events performed by the customer across all sessions."},"totalPageviewCount":{"type":"integer","format":"int32","description":"The total count of pageviews performed by the customer across all sessions."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/JourneyPage"},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Customer's IP address. May be null if the business configures the tracker to not collect IP addresses."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"referrer":{"description":"Identifies the page URL that originally generated the request for the current page being viewed.","$ref":"#/definitions/Referrer"},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"User-defined traits associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"authenticated":{"type":"boolean","description":"Indicates whether the event was produced during an authenticated session."}}},"OutcomeAttributionAsyncResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeAttributionListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomeAttributionRequest"}},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."}}},"OutcomeAttributionRequest":{"type":"object","required":["associatedValue","createdDate","outcomeId","touchpoints"],"properties":{"outcomeId":{"type":"string","description":"ID of Outcome."},"externalContactId":{"type":"string","description":"The external contact ID of the customer who achieved the outcome."},"associatedValue":{"type":"number","description":"The total value associated with the customer's outcome."},"touchpoints":{"type":"array","description":"List of interactions that led to this outcome being achieved.","items":{"$ref":"#/definitions/Touchpoint"}},"createdDate":{"type":"string","format":"date-time","description":"Date outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Touchpoint":{"type":"object","required":["agentId","associatedValue"],"properties":{"conversationId":{"type":"string","description":"ID of conversation."},"agentId":{"type":"string","description":"ID of agent."},"associatedValue":{"type":"number","description":"The value attributed to this touchpoint."},"mediaType":{"type":"string","description":"Media Type of the touchpoint; allowed values are Email, Message and Voice.","enum":["Email","Message","Voice"]},"createdDate":{"type":"string","format":"date-time","description":"Date conversation happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAttributionJobStateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"State of job.","enum":["Running","Completed","CompletedWithErrors","Failed"]},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved. Populated when job has reached a terminal state, i.e. no longer Running."},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAttributionResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomeAttributionResultsResponse"}}}},"OutcomeAttributionResultsResponse":{"type":"object","required":["message","state"],"properties":{"outcomeId":{"type":"string","description":"ID of Outcome."},"index":{"type":"integer","format":"int32","description":"The index/position of the OutcomeAttribution in the original POST request."},"externalContactId":{"type":"string","description":"The external contact ID of the customer who achieved the outcome."},"associatedValue":{"type":"number","description":"The total value associated with the customer's outcome."},"state":{"type":"string","description":"State of the Outcome Attribution entity.","enum":["Completed","Valid","Invalid","Failed"]},"message":{"type":"string","description":"Additional information on the state of the Outcome Attribution entity."},"touchpoints":{"type":"array","description":"List of interactions that led to this outcome being achieved.","items":{"$ref":"#/definitions/TouchpointResponse"}},"createdDate":{"type":"string","format":"date-time","description":"Date outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TouchpointResponse":{"type":"object","required":["agentId","associatedValue","state"],"properties":{"conversationId":{"type":"string","description":"ID of conversation."},"agentId":{"type":"string","description":"ID of agent."},"associatedValue":{"type":"number","description":"The value attributed to this touchpoint."},"mediaType":{"type":"string","description":"Media Type of the touchpoint; allowed values are Email, Message and Voice.","enum":["Email","Message","Voice"]},"state":{"type":"string","description":"Outcome Attribution Touchpoint status.","enum":["Completed","Valid","Invalid","Failed"]},"message":{"type":"string","description":"Additional information on the state of the touchpoint entity, populated when the touchpoint has an error."},"createdDate":{"type":"string","format":"date-time","description":"Date conversation happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"JourneyView":{"type":"object","required":["elements"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the journey view"},"version":{"type":"integer","format":"int32","description":"The version of the journey view","readOnly":true},"createdBy":{"description":"User that has created the view.","readOnly":true,"$ref":"#/definitions/JourneyViewUser"},"modifiedBy":{"description":"User that has modified the view.","readOnly":true,"$ref":"#/definitions/JourneyViewUser"},"interval":{"type":"string","description":"An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"duration":{"type":"string","description":"A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"elements":{"type":"array","description":"The elements within the journey view","items":{"$ref":"#/definitions/JourneyViewElement"}},"dateCreated":{"type":"string","format":"date-time","description":"The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A journey view"},"JourneyViewChart":{"type":"object","required":["metrics"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The version of the journey view chart","readOnly":true},"groupByTime":{"type":"string","description":"A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified.","enum":["Day","Week","Month","Year"]},"groupByAttributes":{"type":"array","description":"A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified.","items":{"$ref":"#/definitions/JourneyViewChartGroupByAttribute"}},"metrics":{"type":"array","description":"A list of metrics to calculate within the chart by (aka the y axis)","items":{"$ref":"#/definitions/JourneyViewChartMetric"}},"displayAttributes":{"description":"Optional display attributes for rendering the chart","$ref":"#/definitions/JourneyViewChartDisplayAttributes"},"groupByMax":{"type":"integer","format":"int32","description":"A maximum on the number of values being grouped by"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A chart within the context of the elements of the the journey view"},"JourneyViewChartDisplayAttributes":{"type":"object","properties":{"type":{"type":"string","description":"The type of chart to display","enum":["Column","Bar","Line"]},"groupByTitle":{"type":"string","description":"A title for the grouped by attributes (aka the x axis)"},"metricsTitle":{"type":"string","description":"A title for the metrics (aka the y axis)"},"showLegend":{"type":"boolean","description":"Whether to show a legend"}},"description":"Display attributes for the chart, such as type, labels and legends"},"JourneyViewChartGroupByAttribute":{"type":"object","required":["attribute","elementId"],"properties":{"elementId":{"type":"string","description":"The element in the list of elements which is being grouped by"},"attribute":{"type":"string","description":"The attribute of the element being grouped by"}},"description":"A journey element attribute to group by within the chart"},"JourneyViewChartMetric":{"type":"object","required":["elementId","id"],"properties":{"id":{"type":"string","description":"The unique identifier of the metric within the chart"},"elementId":{"type":"string","description":"The element in the list of elements which the metric is measuring"},"aggregate":{"type":"string","description":"How to aggregate the given element, defaults to EventCount","enum":["EventCount","CustomerCount"]},"displayLabel":{"type":"string","description":"A display label for the metric"}},"description":"A metric to measure within the chart"},"JourneyViewElement":{"type":"object","required":["attributes","id","name"],"properties":{"id":{"type":"string","description":"The unique identifier of the element within the elements list"},"name":{"type":"string","description":"The unique name of the element within the view"},"attributes":{"description":"Required attributes of the element","$ref":"#/definitions/JourneyViewElementAttributes"},"filter":{"description":"Any filters applied to this element","$ref":"#/definitions/JourneyViewElementFilter"},"followedBy":{"type":"array","description":"A list of JourneyViewLink objects, listing the elements downstream of this element","items":{"$ref":"#/definitions/JourneyViewLink"}}},"description":"An element within a journey view"},"JourneyViewElementAttributes":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the element (e.g. Event)","enum":["Event"]},"id":{"type":"string","description":"The identifier for the element based on its type"},"source":{"type":"string","description":"The source for the element (e.g. IVR, Voice, Chat). Used for informational purposes only"}},"description":"Attributes on an element in a journey view"},"JourneyViewElementFilter":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses. Valid values: And","enum":["And"]},"predicates":{"type":"array","description":"predicates","items":{"$ref":"#/definitions/JourneyViewElementFilterPredicate"}}},"description":"A set of filters on an element within a journey view"},"JourneyViewElementFilterPredicate":{"type":"object","required":["dimension","values"],"properties":{"dimension":{"type":"string","description":"the element's attribute being filtered on"},"values":{"type":"array","description":"the values of the attribute to filter on","items":{"type":"string"}},"operator":{"type":"string","description":"Optional operator, default is Matches. Valid values: Matches","enum":["Matches","NotMatches"]},"noValue":{"type":"boolean","description":"set this to true if no specific value to be considered"}},"description":"A filter on an element within a journey view"},"JourneyViewLink":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the element downstream"},"constraintWithin":{"description":"A time constraint on this link, which requires a customer to complete the downstream element within this amount of time to be counted.","$ref":"#/definitions/JourneyViewLinkTimeConstraint"},"constraintAfter":{"description":"A time constraint on this link, which requires a customer must complete the downstream element after this amount of time to be counted.","$ref":"#/definitions/JourneyViewLinkTimeConstraint"},"eventCountType":{"type":"string","description":"The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential.","enum":["All","Concurrent","Sequential"]},"joinAttributes":{"type":"array","description":"Other (secondary) attributes on which this link should join the customers being counted","items":{"type":"string"}}},"description":"A link between elements in a journey view"},"JourneyViewLinkTimeConstraint":{"type":"object","properties":{"unit":{"type":"string","description":"The unit for the link's time constraint","enum":["Seconds","Minutes","Hours","Days","Weeks","Months"]},"value":{"type":"integer","format":"int32","description":"The value for the link's time constraint"}}},"JourneyViewUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"emailAddress":{"type":"string","description":"Email address of the user","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddressableEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AddressableEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Label":{"type":"object","required":["encoded","name","value"],"properties":{"name":{"type":"string","description":"Name of the label"},"value":{"type":"string","description":"Value of the label"},"encoded":{"type":"boolean","description":"Whether the label is encoded or not","readOnly":true}}},"JourneyEventDefinition":{"type":"object","required":["description","jsonSchema","name","source"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the event definition","readOnly":true},"source":{"type":"string","description":"The source of the event definition","readOnly":true,"enum":["Native","Custom"]},"description":{"type":"string","description":"The description of this event definition","readOnly":true},"jsonSchema":{"description":"The JSON schema of this event definition","readOnly":true,"$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An event definition used when creating journey views"},"JourneyEventDefinitionListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyEventDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"JourneyViewJob":{"type":"object","required":["dateCompleted","dateCreated","journeyView","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Accepted","Executing","Complete","Failed"]},"journeyView":{"description":"The journey view for which the job is executed","$ref":"#/definitions/JourneyView"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupByAttribute":{"type":"object","properties":{"attribute":{"type":"string","description":"Group by attribute","readOnly":true},"value":{"type":"string","description":"Value of this group by attribute","readOnly":true}}},"JourneyViewChartMetricResult":{"type":"object","properties":{"id":{"type":"string","description":"Id of the metric","readOnly":true},"values":{"type":"array","description":"Metric result values","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewChartMetricResultValue"}}}},"JourneyViewChartMetricResultValue":{"type":"object","properties":{"value":{"type":"integer","format":"int32","description":"Value for this metric","readOnly":true},"groupByAttributes":{"type":"array","description":"Group by attributes for this metric","readOnly":true,"items":{"$ref":"#/definitions/GroupByAttribute"}}}},"JourneyViewChartResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"Version of the chart","readOnly":true},"metrics":{"type":"array","description":"Metric results for this chart","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewChartMetricResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyViewResult":{"type":"object","properties":{"elements":{"type":"array","description":"The elements within the journey view result","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewResultElement"}}},"description":"A journey view result"},"JourneyViewResultElement":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"metrics":{"description":"the metrics of the current element","readOnly":true,"$ref":"#/definitions/JourneyViewResultMetrics"},"followedBy":{"type":"array","description":"the list of links following the current element in the journey","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewResultLink"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An element within a journey view result"},"JourneyViewResultLink":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"connectionCount":{"type":"integer","format":"int32","description":"the number of connections for the journey view link","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents a link between 2 elements in a journey view result"},"JourneyViewResultMetrics":{"type":"object","properties":{"participantCount":{"type":"integer","format":"int32","description":"number of external contacts who participated at the element","readOnly":true},"activeCount":{"type":"integer","format":"int32","description":"number of external contacts who could still complete the journey","readOnly":true},"completedCount":{"type":"integer","format":"int32","description":"number of external contacts who completed the journey forward","readOnly":true},"dropoutCount":{"type":"integer","format":"int32","description":"number of external contacts who did not make it to the next element","readOnly":true},"flowCount":{"type":"integer","format":"int32","description":"number of external contacts who moved from one element to next element but did not complete the journey","readOnly":true}},"description":"The metrics of an element or a link in journey "},"KnowledgeDocumentContentUpload":{"type":"object","required":["contentType","fileName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"contentType":{"type":"string","description":"Type of Article Content.","enum":["Body","Attachment"]},"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"status":{"type":"string","description":"Status of the upload operation","readOnly":true,"enum":["ValidationFailed","InProgress","Completed"]},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"document":{"description":"ID of the document for which article content is to be uploaded","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"errorMessage":{"type":"string","description":"Error message when upload fails","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetUploadSourceUrlJobStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the upload from URL job."},"status":{"type":"string","description":"Status of the upload job","enum":["Created","InProgress","Completed","Failed"]},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name"},"errorInformation":{"description":"Any error information, or null of the processing is not in failed state.","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateUploadSourceUrlJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the upload from URL job."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateUploadSourceUrlJobRequest":{"type":"object","required":["uploadUrl"],"properties":{"uploadUrl":{"type":"string","description":"The URL of the content to upload."}}},"KnowledgeDocumentBulkRemoveRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be deleted","items":{"$ref":"#/definitions/WritableEntity"},"maxItems":100,"minItems":1}}},"KnowledgeDocumentBulkUpdateEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"categoryId":{"type":"string","description":"The category associated with the document."},"labelIds":{"type":"array","description":"The ids of labels associated with the document.","items":{"type":"string"}}}},"KnowledgeDocumentBulkUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be updated","items":{"$ref":"#/definitions/KnowledgeDocumentBulkUpdateEntity"},"maxItems":100,"minItems":1}}},"KnowledgeDocumentBulkVersionAddEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"restoreFromVersionId":{"type":"string","description":"The globally unique identifier for the document version. If the value is provided, the document is restored to the given version."},"restorePrevious":{"type":"boolean","description":"Indicates if the document's previous version will be restored"}}},"KnowledgeDocumentBulkVersionAddRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be versioned","items":{"$ref":"#/definitions/KnowledgeDocumentBulkVersionAddEntity"},"maxItems":100,"minItems":1}}},"OperationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OperationResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"OperationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"Status of the operation."},"type":{"type":"string","description":"Type of the operation.","enum":["Import","Export","Parse","Sync"]},"createdBy":{"description":"The user who created the operation.","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Operation creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Operation last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OperationCreatorUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"Type of the operation creator entity: User or OAuthClient","enum":["User","OAuthClient"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeParseJobRequestImport":{"type":"object","properties":{"edits":{"type":"array","description":"Override of the result of the parse.","items":{"$ref":"#/definitions/KnowledgeParseRecord"}},"excludes":{"type":"array","description":"Excluded results.","items":{"type":"string"}}}},"KnowledgeParseRecord":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the parsed data."},"title":{"type":"string","description":"Parsed article title."},"body":{"description":"Parsed article content.","$ref":"#/definitions/DocumentBody"}}},"KnowledgeParseImportResult":{"type":"object","required":["failure","success"],"properties":{"success":{"type":"integer","format":"int32","description":"Number of imported articles."},"failure":{"type":"integer","format":"int32","description":"Number of articles failed to import."},"errors":{"type":"array","description":"Error information about the failures.","items":{"$ref":"#/definitions/ErrorBody"}}}},"KnowledgeParseJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the parse job","readOnly":true},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the original html file."},"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}},"status":{"type":"string","description":"Status of the parse job","readOnly":true,"enum":["ReadyToParse","ParseInProgress","ParseCompleted","ReadyToImport","ImportInProgress","ImportCompleted","ImportPartialCompleted","ImportFailed"]},"parseResults":{"type":"array","description":"Results of the parse","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeParseRecord"}},"importResult":{"description":"Result of the import phase","readOnly":true,"$ref":"#/definitions/KnowledgeParseImportResult"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeParseJobRequestPatch":{"type":"object","properties":{"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}}}},"KnowledgeParseJobRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}}}},"NluOrganization":{"type":"object","properties":{"limits":{"type":"object","description":"The NLU limits defined for this Organization","additionalProperties":{"type":"integer","format":"int32"}},"supportedLanguagesInfo":{"type":"array","description":"The list of Supported features for each languages for this Organization","items":{"$ref":"#/definitions/SupportedLanguagesInfoDefinition"}}}},"SupportedEntityTypeStatus":{"type":"object","properties":{"listSlotType":{"type":"string","description":"The configuration status of restricted lists","enum":["All","Restricted","Unrestricted"]}}},"SupportedLanguagesInfoDefinition":{"type":"object","properties":{"language":{"type":"string","description":"The given supported Language"},"intentClassification":{"type":"boolean","description":"The boolean status of if intent classification is supported in this language"},"status":{"type":"string","description":"The language release status","enum":["EARLY_PREVIEW","PREVIEW","GA"]},"supportedEntityTypes":{"type":"array","description":"The supported entity types for this language","items":{"type":"string"}},"supportedEntityTypeConfiguration":{"description":"The configuration for the supported entity types","$ref":"#/definitions/SupportedEntityTypeStatus"}}},"DocumentationV2SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["TERM","COUNT"]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"DocumentationV2SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationV2SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["SIMPLE","EXACT"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"DocumentationV2SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/DocumentationV2SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/DocumentationV2SearchAggregation"}}}},"UpdateUtilizationLabelRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization label name."}}},"UtilizationLabelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UtilizationLabel"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateUtilizationLabelRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization label name."},"utilization":{"description":"Org level utilization settings for the new label. If not specified, default utilization settings will be applied.","$ref":"#/definitions/LabelUtilizationRequest"}}},"UtilizationTag":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UtilizationTagEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UtilizationTag"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateUtilizationTagRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization tag name."}}},"SmsAlphanumericProvision":{"type":"object","required":["phoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. Genesys123"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DynamicGroupQueryPreview":{"type":"object","properties":{"userCount":{"type":"integer","format":"int32","description":"Number of Users that match the DynamicGroupQuery"}}},"DynamicGroupLanguageSkillCondition":{"type":"object","required":["comparator","languageSkill","proficiency"],"properties":{"languageSkill":{"type":"string","example":"English-Written","description":"The language skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the language skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupQuery":{"type":"object","required":["skillConditions"],"properties":{"skillConditions":{"type":"array","description":"The skill conditions that need to be used for this dynamic group","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupRoutingSkillCondition":{"type":"object","required":["comparator","proficiency","routingSkill"],"properties":{"routingSkill":{"type":"string","description":"The routing skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the routing skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupSkillCondition":{"type":"object","required":["languageSkillConditions","operation","routingSkillConditions"],"properties":{"routingSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/DynamicGroupRoutingSkillCondition"}},"languageSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/DynamicGroupLanguageSkillCondition"}},"operation":{"type":"string","description":"Operator that will be applied to the conditions","enum":["And","Not","Or"]}}},"DynamicGroupDefinition":{"type":"object","required":["dateModified","group","query"],"properties":{"group":{"description":"The group the dynamic group definition belongs to","$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the dynamic group definition. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"query":{"description":"Properties used for building a dynamic groups query","$ref":"#/definitions/DynamicGroupQuery"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExecutionDataGlobalSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"whether or not the setting is enabled."},"modifiedBy":{"description":"User that last changed the setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this setting was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaEndpointStatistics":{"type":"object","properties":{"trunk":{"description":"Trunk information utilized when creating the media endpoint","$ref":"#/definitions/MediaStatisticsTrunkInfo"},"station":{"description":"Station information associated with media endpoint","$ref":"#/definitions/NamedEntity"},"user":{"description":"User information associated media endpoint","$ref":"#/definitions/NamedEntity"},"ice":{"description":"The ICE protocol statistics and details. Reference: https://www.rfc-editor.org/rfc/rfc5245","$ref":"#/definitions/MediaIceStatistics"},"rtp":{"description":"Statistics of sent and received RTP. Reference: https://www.rfc-editor.org/rfc/rfc3550","$ref":"#/definitions/MediaRtpStatistics"},"reconnectAttemptCount":{"type":"integer","format":"int32","description":"Media reconnect attempt count"}}},"MediaIceSelectedCandidate":{"type":"object","properties":{"address":{"type":"string","description":"IP address and port of the candidate"},"type":{"type":"string","description":"Type of the selected candidate","enum":["host","srflx","prflx","relay"]}}},"MediaIceSelectedPair":{"type":"object","properties":{"client":{"description":"The remote candidate that was chosen","$ref":"#/definitions/MediaIceSelectedCandidate"},"server":{"description":"The local candidate that was chosen","$ref":"#/definitions/MediaIceSelectedCandidate"},"candidatePairSelectedMilliseconds":{"type":"integer","format":"int64","description":"Relative milliseconds since creation of endpoint when this ICE candidate pair has been selected"}}},"MediaIceStatistics":{"type":"object","properties":{"selectedPairs":{"type":"array","description":"The candidate pairs selected for the media stream","items":{"$ref":"#/definitions/MediaIceSelectedPair"}}}},"MediaRtpStatistics":{"type":"object","properties":{"packetsReceived":{"type":"integer","format":"int32","description":"Number of packets received, including all invalid, duplicate, and discarded packets"},"packetsSent":{"type":"integer","format":"int32","description":"Number of packets sent"},"rtpEventsReceived":{"type":"integer","format":"int32","description":"Number of RFC#2833 packets received"},"rtpEventsSent":{"type":"integer","format":"int32","description":"Number of RFC#2833 packets sent"},"estimatedAverageMos":{"type":"number","format":"double","description":"The estimated average MOS score"}}},"MediaStatistics":{"type":"object","properties":{"communicationId":{"type":"string"},"dateStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationMilliseconds":{"type":"integer","format":"int64","description":"Relative milliseconds to create media session"},"preferredRegion":{"type":"string","description":"Preferred media region"},"effectiveRegion":{"type":"string","description":"Actual media region"},"mediaStatistics":{"type":"array","description":"Media statistics for each media endpoint","items":{"$ref":"#/definitions/MediaEndpointStatistics"}}}},"MediaStatisticsTrunkInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["external","external.pcv","external.pcv.aws","external.pcv.byoc.carrier","external.pcv.byoc.pbx","tie","tie.direct","tie.indirect","tie.cloud.proxy","station","station.cdm","station.cdm.webrtc"]}}},"MediaStatisticsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MediaStatistics"}}}},"GrammarLanguageFileMetadata":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file as defined by the user"},"fileSizeBytes":{"type":"integer","format":"int32","description":"The size of the file in bytes"},"dateUploaded":{"type":"string","format":"date-time","description":"The date the file was uploaded. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fileType":{"type":"string","description":"The extension of the file","enum":["Gram","Grxml"]}}},"GrammarFileUploadRequest":{"type":"object","properties":{"fileType":{"type":"string","enum":["gram","grxml"]}}},"GrammarLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"grammarId":{"type":"string","description":"The ID of the grammar associated with this grammar language"},"language":{"type":"string"},"voiceFileUrl":{"type":"string","description":"The URL to the voice mode file associated with this grammar language","readOnly":true},"dtmfFileUrl":{"type":"string","description":"The URL to the DTMF mode file associated with this grammar language","readOnly":true},"voiceFileMetadata":{"description":"Additional information about the associated voice file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"dtmfFileMetadata":{"description":"Additional information about the associated dtmf file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GrammarLanguageUpdate":{"type":"object","properties":{"voiceFileMetadata":{"description":"Additional information about the associated voice file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"dtmfFileMetadata":{"description":"Additional information about the associated dtmf file","$ref":"#/definitions/GrammarLanguageFileMetadata"}}},"Grammar":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"languages":{"type":"array","description":"List of languages configured for this grammar","readOnly":true,"items":{"$ref":"#/definitions/GrammarLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GrammarListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Grammar"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkbinVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Workbin name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"Workbin description"},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The id of the User who modified the Workbin.","$ref":"#/definitions/UserReference"},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkbinVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkbinVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkbinChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorkbinDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkbinDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"}}},"WorkitemsAttributeChangeInstant":{"type":"object","properties":{"newValue":{"type":"string","format":"date-time","description":"New property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oldValue":{"type":"string","format":"date-time","description":"Old property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"WorkitemsAttributeChangeString":{"type":"object","properties":{"newValue":{"type":"string","description":"New property value"},"oldValue":{"type":"string","description":"Old property value"}}},"WorkitemsChangeWorkbinDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorkbinDelta"}}},"WorkitemPostQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workitem"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"WorkitemQueryPostRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorkitemQuerySort"},"expands":{"type":"array","description":"List of entity attributes to be expanded in the result.","items":{"type":"string","enum":["type","workbin","status","assignee","reporter","queue"]}}}},"WorkitemQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateDue","priority"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Workitem."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"type":{"description":"The Worktype of the Workitem.","$ref":"#/definitions/WorktypeReference"},"description":{"type":"string","description":"The description of the Workitem."},"language":{"description":"The language of the Workitem.","$ref":"#/definitions/LanguageReference"},"utilizationLabel":{"description":"The utilization label of the Workitem.","$ref":"#/definitions/WorkitemUtilizationLabelReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the workitem."},"ttl":{"type":"integer","format":"int32","description":"The time to live of the Workitem in seconds."},"status":{"description":"The current Status of the Workitem.","$ref":"#/definitions/WorkitemStatusReference"},"statusCategory":{"type":"string","description":"The Category of the current Status of the Workitem.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"dateStatusChanged":{"type":"string","format":"date-time","description":"The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateClosed":{"type":"string","format":"date-time","description":"The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workbin":{"description":"The Workbin that contains the Workitem.","$ref":"#/definitions/WorkbinReference"},"reporter":{"description":"The reporter of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"assignee":{"description":"The assignee of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"externalContact":{"description":"The external contact of the Workitem.","$ref":"#/definitions/ExternalContactReference"},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"modifiedBy":{"description":"The User who modified the Workitem.","$ref":"#/definitions/UserReference"},"queue":{"description":"The Workitems queue.","$ref":"#/definitions/WorkitemQueueReference"},"assignmentState":{"type":"string","description":"The assignment state of the workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"dateAssignmentStateChanged":{"type":"string","format":"date-time","description":"The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The duration in seconds before an alert will timeout."},"skills":{"type":"array","description":"The skills of the Workitem.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"preferredAgents":{"type":"array","description":"The preferred agents of the Workitem.","items":{"$ref":"#/definitions/UserReference"}},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"schema":{"description":"The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time.","$ref":"#/definitions/WorkitemSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the Workitem.","additionalProperties":{"type":"object"}},"autoStatusTransitionDetail":{"description":"Auto status transition details of Workitem.","$ref":"#/definitions/AutoStatusTransitionDetail"},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem.","items":{"$ref":"#/definitions/WorkitemScoredAgent"}},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorkitemDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"languageId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"utilizationLabelId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"priority":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"skillIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"preferredAgentIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"dateDue":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"dateExpires":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"durationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"statusId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"reporterId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"externalContactId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"assigneeId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"workbinId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"queueId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"externalTag":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"wrapupId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"ttl":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"dateClosed":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"assignmentState":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"autoStatusTransition":{"$ref":"#/definitions/WorkitemsAttributeChangeBoolean"},"customFields":{"$ref":"#/definitions/WorkitemsAttributeChangeMap"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"statusCategory":{"$ref":"#/definitions/WorkitemsAttributeChangeWorkitemStatusCategory"}}},"WorkitemsAttributeChangeBoolean":{"type":"object","properties":{"newValue":{"type":"boolean","description":"New property value"},"oldValue":{"type":"boolean","description":"Old property value"}}},"WorkitemsAttributeChangeInteger":{"type":"object","properties":{"newValue":{"type":"integer","format":"int32","description":"New property value"},"oldValue":{"type":"integer","format":"int32","description":"Old property value"}}},"WorkitemsAttributeChangeList":{"type":"object","properties":{"newValue":{"type":"array","description":"New property value","items":{"type":"object"}},"oldValue":{"type":"array","description":"Old property value","items":{"type":"object"}}}},"WorkitemsAttributeChangeMap":{"type":"object","properties":{"newValue":{"type":"object","description":"New property value","additionalProperties":{"type":"object"}},"oldValue":{"type":"object","description":"Old property value","additionalProperties":{"type":"object"}}}},"WorkitemsAttributeChangeWorkitemStatusCategory":{"type":"object","properties":{"newValue":{"type":"string","description":"New property value","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"oldValue":{"type":"string","description":"Old property value","enum":["Open","InProgress","Waiting","Closed","Unknown"]}}},"WorkitemsChangeWorkitemDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorkitemDelta"}}},"WorktypeVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Worktype."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The description of the Worktype."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultWorkbin":{"description":"The default Workbin for Workitems created from the Worktype.","$ref":"#/definitions/WorkbinReference"},"defaultStatus":{"description":"The default status for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemStatusReference"},"statuses":{"type":"array","description":"The list of possible statuses for Workitems created from the Worktype.","items":{"$ref":"#/definitions/WorkitemStatus"}},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultLanguage":{"description":"The default language for Workitems created from the Worktype.","$ref":"#/definitions/LanguageReference"},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype."},"modifiedBy":{"description":"The id of the User who modified the Worktype.","$ref":"#/definitions/UserReference"},"defaultQueue":{"description":"The default queue for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemQueueReference"},"defaultSkills":{"type":"array","description":"The default skills for Workitems created from the Worktype.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schema":{"description":"The schema defining the custom attributes for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemSchema"},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100."},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorktypeVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorktypeVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemsChangeWorktypeDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorktypeDelta"}}},"WorktypeChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorktypeDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorktypeDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"statuses":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"defaultWorkbinId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultDurationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultExpirationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultDueDurationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultPriority":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultSkillIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"defaultStatusId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultLanguageId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultTtlSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"assignmentEnabled":{"$ref":"#/definitions/WorkitemsAttributeChangeBoolean"},"defaultQueueId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"schemaId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"schemaVersion":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.genesys.cloud"}} \ No newline at end of file +{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://help.mypurecloud.com/articles/terms-and-conditions/","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.genesys.cloud","email":"DeveloperEvangelists@genesys.com"},"license":{"name":"UNLICENSED","url":"https://help.mypurecloud.com/articles/terms-and-conditions/"}},"host":"api.mypurecloud.com","tags":[{"name":"Events","description":"Events","externalDocs":{"description":"Events Documentation","url":"https://developer.genesys.cloud/api/rest/v2/events/"}},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"OAuth","description":"OAuth clients, providers","externalDocs":{"description":"OAuth Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/oauth/"}},{"name":"Objects","description":"Access-controlled objects in the platform","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"name":"Alerting","description":"Rules and alerts","externalDocs":{"description":"Alerting Documentation","url":"https://developer.genesys.cloud/notificationsalerts/alerting/alerting-apis"}},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"Analytics Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis"}},{"name":"Architect","description":"Flows, Prompts, IVR schedules, Dependency Tracking","externalDocs":{"description":"Architect Documentation","url":"https://developer.genesys.cloud/routing/architect/"}},{"name":"Audit","description":"","externalDocs":{"description":"Audit Documentation","url":"https://developer.genesys.cloud/platform/audit/"}},{"name":"Billing","description":"","externalDocs":{"description":"billing Documentation","url":"https://developer.genesys.cloud/billing/"}},{"name":"Callbacks","description":""},{"name":"Calls","description":""},{"name":"Carrier Services","description":""},{"name":"Chat","description":""},{"name":"Coaching","description":"Schedule and manage coaching appointments","externalDocs":{"description":"Coaching","url":"https://developer.genesys.cloud/routing/conversations/coaching-apis"}},{"name":"Compliance","description":""},{"name":"Configuration","description":"","externalDocs":{"description":"Configuration Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Content Management","description":"","externalDocs":{"description":"Content Management Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/contentmanagement/contentmanagement-apis"}},{"name":"Conversations","description":"","externalDocs":{"description":"Conversations Documentation","url":"https://developer.genesys.cloud/routing/conversations/conversations-apis"}},{"name":"Data Extensions","description":"Data extensions","externalDocs":{"description":"Data Extensions","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Downloads","description":"Download file","externalDocs":{"description":"Downloads Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Emails","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships","externalDocs":{"description":"External Contacts","url":"https://developer.genesys.cloud/commdigital/externalcontacts/externalcontacts-apis"}},{"name":"Fax","description":"","externalDocs":{"description":"Fax Documentation","url":"https://developer.genesys.cloud/commdigital/fax/"}},{"name":"Flows","description":"IVR Flows","externalDocs":{"description":"Flow Aggregates Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/analytics/aggregate/flow-query"}},{"name":"Gamification","description":"Gamification, Scorecard, and leaderboard","externalDocs":{"description":"Gamification Documentation","url":"https://developer.genesys.cloud/useragentman/gamification/"}},{"name":"General Data Protection Regulation","description":"Working with General Data Protection Regulation (GDPR) requests","externalDocs":{"description":"GDPR Documentation","url":"https://developer.genesys.cloud/gdprprivacy/"}},{"name":"Geolocation","description":"","externalDocs":{"description":"Geolocation Documentation","url":"https://developer.genesys.cloud/platform/geolocation-apis"}},{"name":"Greetings","description":"","externalDocs":{"description":"Greetings Documentation","url":"https://developer.genesys.cloud/commdigital/greetings/"}},{"name":"Groups","description":"Groups, members","externalDocs":{"description":"Groups Documentation","url":"https://developer.genesys.cloud/useragentman/groups/"}},{"name":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/identityprovider/"}},{"name":"Infrastructure as Code","description":"Accelerated infrastructure configuration via reusable modules","externalDocs":{"description":"Infrastructure as Code Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Integrations","description":"","externalDocs":{"description":"Integrations Documentation","url":"https://developer.genesys.cloud/platform/integrations/"}},{"name":"Journey","description":"Predictive Engagement, Customer Journey","externalDocs":{"description":"Journey documentation","url":"https://developer.genesys.cloud/commdigital/digital/webmessaging/journey/journey-apis"}},{"name":"Languages","description":"Available languages","externalDocs":{"description":"Languages Documentation","url":"https://developer.genesys.cloud/organization/languages-apis"}},{"name":"Knowledge","description":"Knowledge administration and search"},{"name":"Language Understanding","description":"Language Understanding","externalDocs":{"description":"Language Understanding documentation","url":"https://developer.genesys.cloud/organization/languageunderstanding/languageunderstanding-apis"}},{"name":"Learning","description":"Manage learning modules"},{"name":"Licensing","description":""},{"name":"License","description":"Per-user platform license assignments","externalDocs":{"description":"License Documentation","url":"https://developer.genesys.cloud/organization/license-apis"}},{"name":"Locations","description":"Physical locations","externalDocs":{"description":"Locations Documentation","url":"https://developer.genesys.cloud/telephony/locations-apis"}},{"name":"Log Capture","description":"Browser Log Capture"},{"name":"Messaging","description":"Messaging","externalDocs":{"description":"Messaging Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Mobile Devices","description":"Devices","externalDocs":{"description":"Devices Documentation","url":"https://developer.genesys.cloud/organization/mobiledevices-apis"}},{"name":"Notifications","description":"Channels, subscriptions, topics, mobile push registration","externalDocs":{"description":"Notifications Documentation","url":"https://developer.genesys.cloud/notificationsalerts/notifications/notifications-apis"}},{"name":"Operational Events","description":"Operational events"},{"name":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.genesys.cloud/organization/organization/"}},{"name":"Organization Authorization","description":"Organization Authorization","externalDocs":{"description":"Organization Authorization Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/organizationauthorization-apis"}},{"name":"Outbound","description":"","externalDocs":{"description":"Outbound Documentation","url":"https://developer.genesys.cloud/routing/outbound/"}},{"name":"Presence","description":"User and organization presences","externalDocs":{"description":"Presence Documentation","url":"https://developer.genesys.cloud/useragentman/presence/"}},{"name":"Process Automation","description":"Work items, flows, triggers"},{"name":"Quality","description":"Evaluations, calibrations","externalDocs":{"description":"Quality Management Documentation","url":"https://developer.genesys.cloud/useragentman/quality/"}},{"name":"Recording","description":"Recordings, policies, annotations, orphans","externalDocs":{"description":"Recording Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/recording/"}},{"name":"Response Management","description":"Responses, library, Response Assets, query","externalDocs":{"description":"Response Management Documentation","url":"https://developer.genesys.cloud/organization/responsemanagement-apis"}},{"name":"Routing","description":"Queues, wrapup codes, skills, email & sms config, predictive routing","externalDocs":{"description":"Routing Documentation","url":"https://developer.genesys.cloud/routing/routing/"}},{"name":"SCIM","description":"System for Cross-domain Identity Management","externalDocs":{"description":"System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements","url":"https://developer.genesys.cloud/useragentman/scim/scim-apis"}},{"name":"Screen Recording","description":"Screen recording with background assistant"},{"name":"Scripts","description":"Agent-facing scripts for interactions","externalDocs":{"description":"Scripts Documentation","url":"https://developer.genesys.cloud/routing/scripts/"}},{"name":"Search","description":"Search aggregate, users, groups","externalDocs":{"description":"Search Documentation","url":"https://developer.genesys.cloud/organization/search/"}},{"name":"Settings","description":"Persist settings"},{"name":"Socialize","description":"Gets, sets and updates entity data for the Socialize service"},{"name":"Speech & Text Analytics","description":""},{"name":"Stations","description":"Stations","externalDocs":{"description":"Stations Documentation","url":"https://developer.genesys.cloud/telephony/stations-apis"}},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Teams","description":"Teams, members","externalDocs":{"description":"Teams Documentation","url":"https://developer.genesys.cloud/devapps/api-explorer"}},{"name":"Telephony","description":"Telephony providers and configuration","externalDocs":{"description":"Telephony Documentation","url":"https://developer.genesys.cloud/telephony/telephony-apis"}},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.genesys.cloud/telephony/telephony-apis"}},{"name":"Textbots","description":"Chatbot Interactions"},{"name":"Uploads","description":"Presigned url generator for uploading files","externalDocs":{"description":"Upload Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/uploads/uploads-apis"}},{"name":"User Recordings","description":"Summary, media","externalDocs":{"description":"User Recordings Documentation","url":"https://developer.genesys.cloud/analyticsdatamanagement/recording/userrecordings-apis"}},{"name":"Users","description":"Me, routing, roles","externalDocs":{"description":"Users Documentation","url":"https://developer.genesys.cloud/useragentman/users/"}},{"name":"Utilities","description":"","externalDocs":{"description":"Utilities Documentation","url":"https://developer.genesys.cloud/organization/utilities-apis"}},{"name":"Videos","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy","externalDocs":{"description":"Voicemail Documentation","url":"https://developer.genesys.cloud/commdigital/voicemail/"}},{"name":"WebChat","description":"WebChat deployments","externalDocs":{"description":"WebChat Deployment Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/webchat-apis"}},{"name":"WebMessaging","description":"Web messaging","externalDocs":{"description":"Web Messaging Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webmessaging/webmessaging-apis"}},{"name":"Widgets","description":"Widget deployments","externalDocs":{"description":"Widget Deployment Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/widgets-apis"}},{"name":"Usage","description":"View organizational level usage data","externalDocs":{"description":"Usage Documentation","url":"https://developer.genesys.cloud/platform/usage-apis"}},{"name":"Workforce Management","description":"Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration","externalDocs":{"description":"Workforce Management Documentation","url":"https://developer.genesys.cloud/useragentman/workforcemanagement/"}},{"name":"Web Deployments","description":"Web Deployments","externalDocs":{"description":"Web Deployments Documentation","url":"https://developer.genesys.cloud/commdigital/digital/webchat/webdeployments-apis"}},{"name":"Task Management","description":"Task Management"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v2/events/conversations":{"post":{"tags":["Events"],"summary":"Publish Conversation Batch Events","description":"","operationId":"postEventsConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchConversationEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conversation:inject"]},"x-purecloud-method-name":"postEventsConversations"}},"/api/v2/events/users/routingstatus":{"post":{"tags":["Events"],"summary":"Publish Agent Routing Status Batch Events","description":"","operationId":"postEventsUsersRoutingstatus","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserRoutingStatusEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:routingstatus:inject"]},"x-purecloud-method-name":"postEventsUsersRoutingstatus"}},"/api/v2/events/users/presence":{"post":{"tags":["Events"],"summary":"Publish User Presence Status Batch Events","description":"","operationId":"postEventsUsersPresence","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"batchRequest","required":true,"schema":{"$ref":"#/definitions/BatchUserPresenceEventRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","zero.events.submitted":"A minimum of 1 event must be submitted","max.batch.size.surpassed":"Max allowed event count per request has been surpassed. Max batch size is 100","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:inject"]},"x-purecloud-method-name":"postEventsUsersPresence"}},"/api/v2/authorization/divisions/{divisionId}":{"get":{"tags":["Authorization","Objects"],"summary":"Returns an authorization division.","description":"","operationId":"getAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectCount","in":"query","description":"Get count of objects in this division, grouped by type","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivision"},"put":{"tags":["Authorization","Objects"],"summary":"Update a division.","description":"","operationId":"putAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated division data","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:edit"]},"x-purecloud-method-name":"putAuthorizationDivision"},"delete":{"tags":["Authorization","Objects"],"summary":"Delete a division.","description":"","operationId":"deleteAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Force delete this division as well as the grants and objects associated with it","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"precondition.failure":"One or more preconditions was not met.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:delete"]},"x-purecloud-method-name":"deleteAuthorizationDivision"}},"/api/v2/authorization/divisions/{divisionId}/restore":{"post":{"tags":["Authorization","Objects"],"summary":"Recreate a previously deleted division.","description":"","operationId":"postAuthorizationDivisionRestore","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recreated division data","required":false,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"Scope with that ID already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:add"]},"x-purecloud-method-name":"postAuthorizationDivisionRestore"}},"/api/v2/authorization/divisions":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve a list of all divisions defined for the organization","description":"Request specific divisions by id using a query param \"id\", e.g. \n?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","operationId":"getAuthorizationDivisions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"objectCount","in":"query","description":"Include the count of objects contained in the division","required":false,"type":"boolean","default":false},{"name":"id","in":"query","description":"Optionally request specific divisions by their IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisions"},"post":{"tags":["Authorization","Objects"],"summary":"Create a division.","description":"","operationId":"postAuthorizationDivisions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Division","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.name.invalid":"The requested division name is invalid.","max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"A resource with that name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:division:add","authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationDivisions"}},"/api/v2/tokens/me":{"get":{"tags":["Tokens"],"summary":"Fetch information about the current token","description":"","operationId":"getTokensMe","produces":["application/json"],"parameters":[{"name":"preserveIdleTTL","in":"query","description":"preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getTokensMe"},"head":{"tags":["Tokens"],"summary":"Verify user token","description":"","operationId":"headTokensMe","produces":["application/json"],"parameters":[],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"headTokensMe"},"delete":{"tags":["Tokens"],"summary":"Delete auth token used to make the request.","description":"","operationId":"deleteTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"deleteTokensMe"}},"/api/v2/tokens/{userId}":{"delete":{"tags":["Tokens"],"summary":"Delete all auth tokens for the specified user.","description":"","operationId":"deleteToken","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Missing required division permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:token:delete"]},"x-purecloud-method-name":"deleteToken"}},"/api/v2/alerting/alerts/active":{"get":{"tags":["Alerting"],"summary":"Gets active alert count for a user","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to 'Count' and alertStatus to 'Active' in the request body.","operationId":"getAlertingAlertsActive","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActiveAlertCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingAlertsActive"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.","operationId":"getAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlert"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.","operationId":"putAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"InteractionStatsAlert","required":true,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.","operationId":"deleteAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsAlert"}},"/api/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query.","operationId":"getAlertingInteractionstatsAlerts","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlerts"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule","description":"Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.","operationId":"getAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRule"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.","operationId":"putAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsRule"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule","description":"Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.","operationId":"deleteAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsRule"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list","description":"Apps should migrate to use POST /api/v2/alerting/rules/query.","operationId":"getAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule","description":"Apps should migrate to use POST /api/v2/alerting/rules.","operationId":"postAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingInteractionstatsRules"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts","description":"Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to 'Count' and viewStatus to 'Unread' in the request body.","operationId":"getAlertingInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAlertingInteractionstatsAlertsUnread"}},"/api/v2/analytics/actions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for action aggregates","description":"","operationId":"postAnalyticsActionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ActionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"postAnalyticsActionsAggregatesQuery"}},"/api/v2/analytics/bots/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for bot aggregates","description":"","operationId":"postAnalyticsBotsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/BotAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"postAnalyticsBotsAggregatesQuery"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation aggregates","description":"","operationId":"postAnalyticsConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/activity/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation activity observations","description":"","operationId":"postAnalyticsConversationsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsConversationsActivityQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details","description":"","operationId":"postAnalyticsConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"payload.too.large":"The response payload was too large.","request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsQuery"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Get a conversation by id","description":"","operationId":"getAnalyticsConversationDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationDetails"}},"/api/v2/analytics/conversations/details":{"get":{"tags":["Analytics","Conversations"],"summary":"Gets multiple conversations by id","description":"","operationId":"getAnalyticsConversationsDetails","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma-separated conversation ids","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Analytics","Conversations"],"summary":"Index conversation properties","description":"","operationId":"postAnalyticsConversationDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"202":{"description":"Accepted - Indexing properties","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationProperties:index"]},"x-purecloud-method-name":"postAnalyticsConversationDetailsProperties"}},"/api/v2/analytics/conversations/details/jobs":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation details asynchronously","description":"","operationId":"postAnalyticsConversationsDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncConversationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsJobs"}},"/api/v2/analytics/conversations/details/jobs/{jobId}":{"get":{"tags":["Analytics","Conversations"],"summary":"Get status for async query for conversation details","description":"","operationId":"getAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJob"},"delete":{"tags":["Analytics","Conversations"],"summary":"Delete/cancel an async details job","description":"","operationId":"deleteAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsConversationsDetailsJob"}},"/api/v2/analytics/conversations/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Conversations"],"summary":"Fetch a page of results for an async details job","description":"","operationId":"getAnalyticsConversationsDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","analytics:agentConversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobResults"}},"/api/v2/analytics/conversations/details/jobs/availability":{"get":{"tags":["Analytics","Conversations"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsConversationsDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobsAvailability"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for evaluation aggregates","description":"","operationId":"postAnalyticsEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesQuery"}},"/api/v2/analytics/flowexecutions/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for flow execution aggregates","description":"","operationId":"postAnalyticsFlowexecutionsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowExecutionAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowexecutionsAggregatesQuery"}},"/api/v2/analytics/flows/aggregates/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow aggregates","description":"","operationId":"postAnalyticsFlowsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to query for flow aggregates.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesQuery"}},"/api/v2/analytics/flows/observations/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow observations","description":"","operationId":"postAnalyticsFlowsObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsObservationsQuery"}},"/api/v2/analytics/flows/activity/query":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow activity observations","description":"","operationId":"postAnalyticsFlowsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsActivityQuery"}},"/api/v2/analytics/journeys/aggregates/query":{"post":{"tags":["Analytics","Journey"],"summary":"Query for journey aggregates","description":"","operationId":"postAnalyticsJourneysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesQuery"}},"/api/v2/analytics/knowledge/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for knowledge aggregates","description":"","operationId":"postAnalyticsKnowledgeAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/KnowledgeAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"postAnalyticsKnowledgeAggregatesQuery"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for queue observations","description":"","operationId":"postAnalyticsQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QueueObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"This user is not permitted to query for queue.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsQueuesObservationsQuery"}},"/api/v2/analytics/ratelimits/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for limits rate limit aggregates. Data populated when limits are exceeded or are close to being exceeded. Not a source of truth for limits hit but a best effort estimate.","description":"The 'max' property can be used to determine estimated rate limit value hit.","operationId":"postAnalyticsRatelimitsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RateLimitAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RateLimitAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:rateLimitAggregate:view"]},"x-purecloud-method-name":"postAnalyticsRatelimitsAggregatesQuery"}},"/api/v2/analytics/routing/activity/query":{"post":{"tags":["Analytics","Routing"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsRoutingActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RoutingActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsRoutingActivityQuery"}},"/api/v2/analytics/surveys/aggregates/query":{"post":{"tags":["Analytics","Quality"],"summary":"Query for survey aggregates","description":"","operationId":"postAnalyticsSurveysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesQuery"}},"/api/v2/analytics/teams/activity/query":{"post":{"tags":["Analytics","Teams"],"summary":"Query for team activity observations","description":"","operationId":"postAnalyticsTeamsActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TeamActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:teamObservation:view"]},"x-purecloud-method-name":"postAnalyticsTeamsActivityQuery"}},"/api/v2/analytics/transcripts/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates","description":"","operationId":"postAnalyticsTranscriptsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesQuery"}},"/api/v2/analytics/users/details/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details","description":"","operationId":"postAnalyticsUsersDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserDetailsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user observations","description":"","operationId":"postAnalyticsUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersObservationsQuery"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user aggregates","description":"","operationId":"postAnalyticsUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesQuery"}},"/api/v2/analytics/users/activity/query":{"post":{"tags":["Analytics","Users"],"summary":"Query for user activity observations","description":"","operationId":"postAnalyticsUsersActivityQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserActivityQuery"}},{"name":"pageSize","in":"query","description":"The desired page size","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The desired page number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserActivityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersActivityQuery"}},"/api/v2/analytics/users/details/jobs":{"post":{"tags":["Analytics","Users"],"summary":"Query for user details asynchronously","description":"","operationId":"postAnalyticsUsersDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncUserDetailsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsJobs"}},"/api/v2/analytics/users/details/jobs/{jobId}":{"get":{"tags":["Analytics","Users"],"summary":"Get status for async query for user details","description":"","operationId":"getAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJob"},"delete":{"tags":["Analytics","Users"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsUsersDetailsJob"}},"/api/v2/analytics/users/details/jobs/{jobId}/results":{"get":{"tags":["Analytics","Users"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsUsersDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobResults"}},"/api/v2/analytics/users/details/jobs/availability":{"get":{"tags":["Analytics","Users"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsUsersDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobsAvailability"}},"/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns (division aware).","description":"Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowDivisionsReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowDivisionAwareReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowDivisionsReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/reportingturns":{"get":{"tags":["Analytics"],"summary":"Get Reporting Turns.","description":"Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowReportingturns","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"actionId","in":"query","description":"Optional action ID to get the reporting turns associated to a particular flow action","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.","required":false,"type":"string"},{"name":"language","in":"query","description":"Optional language code to get the reporting turns for a particular language","required":false,"type":"string","x-example":"en-us"},{"name":"askActionResults","in":"query","description":"Optional case-insensitive comma separated list of ask action results to filter the reporting turns.","required":false,"type":"string","enum":["AgentRequestedByUser","ConfirmationRequired","DisambiguationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","SuccessCollection","SuccessConfirmationNo","SuccessConfirmationYes","SuccessDisambiguation","SuccessDisambiguationNone"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingTurnsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowReportingTurn:view"]},"x-purecloud-method-name":"getAnalyticsBotflowReportingturns"}},"/api/v2/analytics/botflows/{botFlowId}/sessions":{"get":{"tags":["Analytics"],"summary":"Get Bot Flow Sessions.","description":"Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","operationId":"getAnalyticsBotflowSessions","produces":["application/json"],"parameters":[{"name":"botFlowId","in":"path","description":"ID of the bot flow.","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the ID of the last item in the list of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Max number of entities to return. Maximum of 250","required":false,"type":"string","default":"50"},{"name":"interval","in":"query","description":"Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval","x-example":"2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z"},{"name":"botResultCategories","in":"query","description":"Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.","required":false,"type":"string","enum":["Unknown","UserExit","BotExit","Error","RecognitionFailure","UserDisconnect","BotDisconnect","SessionExpired","Transfer"]},{"name":"endLanguage","in":"query","description":"Optional case-insensitive language code to filter sessions by the language the sessions ended in.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botFlowSession:view"]},"x-purecloud-method-name":"getAnalyticsBotflowSessions"}},"/api/v2/analytics/dataretention/settings":{"get":{"tags":["Analytics"],"summary":"Get analytics data retention setting","description":"","operationId":"getAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:view"]},"x-purecloud-method-name":"getAnalyticsDataretentionSettings"},"put":{"tags":["Analytics"],"summary":"Update analytics data retention setting","description":"","operationId":"putAnalyticsDataretentionSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"retentionDays","required":true,"schema":{"$ref":"#/definitions/UpdateAnalyticsDataRetentionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsDataRetentionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"analytics.data.retention.update.conflict":"The provided analytics data retention setting conflicts with existing policies/recordings in the org. Ensure that no recording policies retain recordings for longer than the provided retentionDays, and no recordings have delete dates further away from their creation dates than the provided retentionDays."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dataRetention:edit"]},"x-purecloud-method-name":"putAnalyticsDataretentionSettings"}},"/api/v2/analytics/reporting/settings":{"get":{"tags":["Analytics"],"summary":"Get AnalyticsReportingSettings for an organization","description":"","operationId":"getAnalyticsReportingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSettings"},"patch":{"tags":["Analytics"],"summary":"Patch AnalyticsReportingSettings values for an organization","description":"","operationId":"patchAnalyticsReportingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AnalyticsReportingSettingsRequest","required":true,"schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsReportingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update AnalyticsReportingSettings due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"AnalyticsReportingSettings for organization not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:reportingSettings:edit"]},"x-purecloud-method-name":"patchAnalyticsReportingSettings"}},"/api/v2/analytics/reporting/settings/dashboards/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk remove dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationBulkRequest"}}],"responses":{"204":{"description":"Dashboard Configurations were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:edit"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsBulkRemove"}},"/api/v2/analytics/reporting/settings/dashboards/query":{"get":{"tags":["Analytics"],"summary":"Get list of dashboard configurations","description":"","operationId":"getAnalyticsReportingSettingsDashboardsQuery","produces":["application/json"],"parameters":[{"name":"dashboardType","in":"query","description":"List dashboard of given type","required":true,"type":"string","enum":["All","Public","Private","Shared","Favorites"]},{"name":"dashboardAccessFilter","in":"query","description":"Filter dashboard based on the owner of dashboard","required":true,"type":"string","enum":["OwnedByMe","OwnedByAnyone","NotOwnedByMe"]},{"name":"sortBy","in":"query","required":false,"type":"string","default":"desc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":9,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingSettingsDashboardsQuery"},"post":{"tags":["Analytics"],"summary":"Query dashboard configurations","description":"","operationId":"postAnalyticsReportingSettingsDashboardsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DashboardConfigurationQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"postAnalyticsReportingSettingsDashboardsQuery"}},"/api/v2/analytics/reporting/dashboards/users/{userId}":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for a user","description":"","operationId":"getAnalyticsReportingDashboardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUser"}},"/api/v2/analytics/reporting/dashboards/users":{"get":{"tags":["Analytics"],"summary":"Get dashboards summary for users in a org","description":"","operationId":"getAnalyticsReportingDashboardsUsers","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","enum":["active","inactive"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardUserListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:view"]},"x-purecloud-method-name":"getAnalyticsReportingDashboardsUsers"}},"/api/v2/analytics/reporting/dashboards/users/bulk/remove":{"post":{"tags":["Analytics"],"summary":"Bulk delete dashboards owned by other user(s)","description":"","operationId":"postAnalyticsReportingDashboardsUsersBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of userIds","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Dashboards were deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:dashboardConfigurations:deleteActive","analytics:dashboardConfigurations:deleteInactive"]},"x-purecloud-method-name":"postAnalyticsReportingDashboardsUsersBulkRemove"}},"/api/v2/analytics/reporting/settings/users/{userId}/dashboards":{"get":{"tags":["Analytics"],"summary":"Get list of dashboards for an user","description":"","operationId":"getAnalyticsReportingSettingsUserDashboards","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"sortBy","in":"query","required":false,"type":"string","default":"asc"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":50,"format":"int32"},{"name":"publicOnly","in":"query","description":"If true, retrieve only public dashboards","required":false,"type":"boolean"},{"name":"favoriteOnly","in":"query","description":"If true, retrieve only favorite dashboards","required":false,"type":"boolean"},{"name":"name","in":"query","description":"retrieve dashboards that match with given name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DashboardConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dashboardConfigurations:viewPrivate"]},"x-purecloud-method-name":"getAnalyticsReportingSettingsUserDashboards"}},"/api/v2/analytics/reporting/exports/metadata":{"get":{"tags":["Analytics"],"summary":"Get all export metadata","description":"","operationId":"getAnalyticsReportingExportsMetadata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportMetadataJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExportsMetadata"}},"/api/v2/analytics/reporting/exports":{"get":{"tags":["Analytics"],"summary":"Get all view export requests for a user","description":"","operationId":"getAnalyticsReportingExports","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExports"},"post":{"tags":["Analytics"],"summary":"Generate a view export request","description":"This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead","operationId":"postAnalyticsReportingExports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportingExportJobRequest","required":true,"schema":{"$ref":"#/definitions/ReportingExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to generate a view export request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:add"]},"x-purecloud-method-name":"postAnalyticsReportingExports"}},"/api/v2/audits/query/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in audits.","description":"","operationId":"getAuditsQueryServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryServicemapping"}},"/api/v2/audits/query/{transactionId}/results":{"get":{"tags":["Audit"],"summary":"Get results of audit query","description":"","operationId":"getAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionIdResults"}},"/api/v2/audits/query":{"post":{"tags":["Audit"],"summary":"Create audit query execution","description":"Use /api/v2/audits/query/servicemapping endpoint for a list of valid values","operationId":"postAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQuery"}},"/api/v2/audits/query/{transactionId}":{"get":{"tags":["Audit"],"summary":"Get status of audit query execution","description":"","operationId":"getAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionId"}},"/api/v2/audits/query/realtime":{"post":{"tags":["Audit"],"summary":"This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits.","description":"Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values","operationId":"postAuditsQueryRealtime","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeQueryResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtime"}},"/api/v2/audits/query/realtime/related":{"post":{"tags":["Audit"],"summary":"Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id.","description":"","operationId":"postAuditsQueryRealtimeRelated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeRelatedRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeRelatedResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtimeRelated"}},"/api/v2/audits/query/realtime/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in realtime audits.","description":"","operationId":"getAuditsQueryRealtimeServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryRealtimeServicemapping"}},"/api/v2/authorization/divisions/home":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve the home division for the organization.","description":"Will not include object counts.","operationId":"getAuthorizationDivisionsHome","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsHome"}},"/api/v2/authorization/divisions/limit":{"get":{"tags":["Authorization","Objects"],"summary":"Returns the maximum allowed number of divisions.","description":"","operationId":"getAuthorizationDivisionsLimit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int32"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsLimit"}},"/api/v2/authorization/divisions/{divisionId}/objects/{objectType}":{"post":{"tags":["Authorization","Objects"],"summary":"Assign a list of objects to a division","description":"Set the division of a specified list of objects. The objects must all be of the same type, one of: \nCAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. \nThe body of the request is a list of object IDs, which are expected to be \nGUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]","operationId":"postAuthorizationDivisionObject","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectType","in":"path","description":"The type of the objects. Must be one of the valid object types","required":true,"type":"string","enum":["QUEUE","CAMPAIGN","CONTACTLIST","DNCLIST","EMAILCAMPAIGN","MESSAGINGCAMPAIGN","MANAGEMENTUNIT","BUSINESSUNIT","FLOW","FLOWMILESTONE","FLOWOUTCOME","USER","CALLROUTE","EMERGENCYGROUPS","ROUTINGSCHEDULES","ROUTINGSCHEDULEGROUPS","DATATABLES","TEAM","WORKBIN","WORKTYPE","EXTENSIONPOOL","SKILLGROUP","SCRIPT"]},{"in":"body","name":"body","description":"Object Id List","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The divisions were updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.bulk.division.updates":"Unable to move objects because the request contained too many objects","empty.bulk.division.update":"Unable to move object because the request contained an empty object.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bulk.move.no.permission.division":"Unable to move object(s) because the requesting user does not have edit permission in the destination division","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.units.not.found":"One or more requested management units were not found","wfm.business.units.not.found":"One or more requested business units were not found","general.resource.not.found":"Requested resource is not available.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.unable.to.move":"One or more of the object(s) failed to be moved to the destination division"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed","bulk.move.permission.check.error":"Failed to check permissions in one or more of the divisions in the request","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-purecloud-method-name":"postAuthorizationDivisionObject"}},"/api/v2/authorization/subjects/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for the currently authenticated user.","description":"","operationId":"getAuthorizationSubjectsMe","produces":["application/json"],"parameters":[{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationSubjectsMe"}},"/api/v2/authorization/subjects/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getAuthorizationSubject","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"includeDuplicates","in":"query","description":"Include multiple entries with the same role and division but different subjects","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has ocurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubject"}},"/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}":{"post":{"tags":["Authorization","Users"],"summary":"Make a grant of a role in a division","description":"","operationId":"postAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division to which to make the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role to grant","required":true,"type":"string"},{"name":"subjectType","in":"query","description":"what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)","required":false,"type":"string","default":"PC_USER"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectDivisionRole"},"delete":{"tags":["Authorization","Users"],"summary":"Delete a grant of a role in a division","description":"","operationId":"deleteAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division of the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role of the grant","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"deleteAuthorizationSubjectDivisionRole"}},"/api/v2/authorization/subjects/{subjectId}/bulkadd":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-grant roles and divisions to a subject.","description":"","operationId":"postAuthorizationSubjectBulkadd","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkadd"}},"/api/v2/authorization/subjects/{subjectId}/bulkreplace":{"post":{"tags":["Authorization","Users"],"summary":"Replace subject's roles and divisions with the exact list supplied in the request.","description":"This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.","operationId":"postAuthorizationSubjectBulkreplace","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Replaced"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","bad.role.divisions":"Invalid role divisions in request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add","authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkreplace"}},"/api/v2/authorization/subjects/{subjectId}/bulkremove":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-remove grants from a subject.","description":"","operationId":"postAuthorizationSubjectBulkremove","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"204":{"description":"Bulk Grants Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkremove"}},"/api/v2/authorization/roles/{roleId}/users":{"get":{"tags":["Authorization"],"summary":"Get a list of the users in a specified role.","description":"Get an array of the UUIDs of the users in the specified role.","operationId":"getAuthorizationRoleUsers","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationRoleUsers"}},"/api/v2/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putAuthorizationRoleUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putAuthorizationRoleUsersAdd"}},"/api/v2/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putAuthorizationRoleUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"putAuthorizationRoleUsersRemove"}},"/api/v2/authorization/divisions/{divisionId}/grants":{"get":{"tags":["Authorization"],"summary":"Gets all grants for a given division.","description":"Returns all grants assigned to a given division. Maximum page size is 500.","operationId":"getAuthorizationDivisionGrants","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionGrantEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationDivisionGrants"}},"/api/v2/authorization/divisionspermitted/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedMe","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedMe"}},"/api/v2/authorization/divisionspermitted/paged/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"","operationId":"getAuthorizationDivisionspermittedPagedMe","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedMe"}},"/api/v2/authorization/divisionspermitted/paged/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the specified user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedPagedSubjectId","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedSubjectId"}},"/api/v2/authorization/settings":{"get":{"tags":["Authorization"],"summary":"Get authorization settings","description":"","operationId":"getAuthorizationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:view"]},"x-purecloud-method-name":"getAuthorizationSettings"},"patch":{"tags":["Authorization"],"summary":"Change authorization settings","description":"Change authorization settings","operationId":"patchAuthorizationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Authorization Settings","required":true,"schema":{"$ref":"#/definitions/AuthorizationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthorizationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","authorization:settings:edit"]},"x-purecloud-method-name":"patchAuthorizationSettings"}},"/api/v2/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"userCount","in":"query","description":"Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts.","required":false,"type":"boolean","default":true,"enum":["true","false"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role","required":false,"type":"array","items":{"type":"string","enum":["unusedPermissions"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal service error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRole"},"post":{"tags":["Authorization"],"summary":"Bulk-grant subjects and divisions with an organization role.","description":"","operationId":"postAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Subjects and Divisions","required":true,"schema":{"$ref":"#/definitions/SubjectDivisions"}},{"name":"subjectType","in":"query","description":"what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.subject.type":"Bad request, invalid subject type","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationRole"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRole"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:delete"]},"x-purecloud-method-name":"deleteAuthorizationRole"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"patchAuthorizationRole"}},"/api/v2/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getAuthorizationRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"defaultRoleId","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.ids":"Only 100 roles can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postAuthorizationRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:add"]},"x-purecloud-method-name":"postAuthorizationRoles"}},"/api/v2/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getAuthorizationPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"queryType","in":"query","description":"Query filter type","required":false,"type":"string","enum":["domain","permission"]},{"name":"query","in":"query","description":"Comma-separated list of permissions or domains to query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationPermissions"}},"/api/v2/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getAuthorizationProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationProducts"}},"/api/v2/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"postAuthorizationRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization roles list","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRolesDefault"}},"/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleComparedefaultRightRoleId"},"post":{"tags":["Authorization"],"summary":"Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"postAuthorizationRoleComparedefaultRightRoleId"}},"/api/v2/authorization/roles/{roleId}/subjectgrants":{"get":{"tags":["Authorization"],"summary":"Get the subjects' granted divisions in the specified role.","description":"Includes the divisions for which the subject has a grant.","operationId":"getAuthorizationRoleSubjectgrants","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SubjectDivisionGrantsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleSubjectgrants"}},"/api/v2/authorization/subjects/rolecounts":{"get":{"tags":["Authorization"],"summary":"Get the count of roles granted to a list of subjects","description":"","operationId":"getAuthorizationSubjectsRolecounts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","max.subject.ids":"Only 100 subjects can be requested at a time.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubjectsRolecounts"}},"/api/v2/users/{subjectId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getUserRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserRoles","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.assignments.exceeded":"Too many roles granted to a subject","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an active user with that ID in this organization.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putUserRoles"}},"/api/v2/screenrecording/token":{"post":{"tags":["Screen Recording"],"summary":"Sign identifying information for screen recording","description":"","operationId":"postScreenrecordingToken","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingUserAuthenticatedInfo"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization:readonly"]}],"x-purecloud-method-name":"postScreenrecordingToken"}},"/api/v2/billing/reports/billableusage":{"get":{"tags":["Billing"],"summary":"Get a report of the billable license usages","description":"Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","operationId":"getBillingReportsBillableusage","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BillingUsageReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["billing:subscription:read","billing:subscription:view"]},"x-purecloud-method-name":"getBillingReportsBillableusage"}},"/api/v2/billing/trusteebillingoverview/{trustorOrgId}":{"get":{"tags":["Billing"],"summary":"Get the billing overview for an organization that is managed by a partner.","description":"Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/","operationId":"getBillingTrusteebillingoverviewTrustorOrgId","produces":["application/json"],"parameters":[{"name":"billingPeriodIndex","in":"query","description":"0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"trustorOrgId","in":"path","description":"The organization ID of the trustor (customer) organization.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeBillingOverview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing","billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["affiliateOrganization:clientBilling:view"]},"x-purecloud-method-name":"getBillingTrusteebillingoverviewTrustorOrgId"}},"/api/v2/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","callforwarding.usernotpermitted":"User is not permitted to use call forwarding","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected response code from external service"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"putUserCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callForwarding:edit"]},"x-purecloud-method-name":"patchUserCallforwarding"}},"/api/v2/carrierservices/integrations/emergencylocations/me":{"get":{"tags":["Carrier Services"],"summary":"Get location for the logged in user","description":"","operationId":"getCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Phone number in E164 format","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getCarrierservicesIntegrationsEmergencylocationsMe"},"post":{"tags":["Carrier Services"],"summary":"Set current location for the logged in user","description":"","operationId":"postCarrierservicesIntegrationsEmergencylocationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmergencyLocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyLocation"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/EmergencyLocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorInfo"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"postCarrierservicesIntegrationsEmergencylocationsMe"}},"/api/v2/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postCertificateDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Certificate","required":true,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"postCertificateDetails"}},"/api/v2/chats/settings":{"get":{"tags":["Chat"],"summary":"Get Chat Settings.","description":"","operationId":"getChatsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:view","chat:setting:edit"]},"x-purecloud-method-name":"getChatsSettings"},"put":{"tags":["Chat"],"summary":"Update Chat Settings.","description":"","operationId":"putChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"putChatsSettings"},"patch":{"tags":["Chat"],"summary":"Patch Chat Settings.","description":"","operationId":"patchChatsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"patchChatsSettings"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a room","description":"","operationId":"getChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages/{messageIds}":{"get":{"tags":["Chat"],"summary":"Get messages by id(s) from a 1on1","description":"","operationId":"getChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageIds","in":"path","description":"messageIds, comma separated","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessage"}},"/api/v2/chats/messages/{messageId}":{"get":{"tags":["Chat"],"summary":"Get a message","description":"","operationId":"getChatsMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view","chat:room:view"]},"x-purecloud-method-name":"getChatsMessage"}},"/api/v2/chats/messages/{messageId}/reactions":{"put":{"tags":["Chat"],"summary":"Update reactions to a message","description":"","operationId":"putChatsMessageReactions","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"reactionUpdate","required":true,"schema":{"$ref":"#/definitions/ChatReactionUpdate"}}],"responses":{"204":{"description":"Reactions updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:reactions:edit"]},"x-purecloud-method-name":"putChatsMessageReactions"}},"/api/v2/chats/rooms/{roomJid}/messages":{"get":{"tags":["Chat"],"summary":"Get a room's message history","description":"","operationId":"getChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a room","description":"","operationId":"postChatsRoomMessages","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:add"]},"x-purecloud-method-name":"postChatsRoomMessages"}},"/api/v2/chats/rooms/{roomJid}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message in a room","description":"","operationId":"deleteChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:delete"]},"x-purecloud-method-name":"deleteChatsRoomMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message in a room","description":"","operationId":"patchChatsRoomMessage","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"messageBody","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:roomMessage:edit"]},"x-purecloud-method-name":"patchChatsRoomMessage"}},"/api/v2/chats/users/{userId}/messages":{"get":{"tags":["Chat"],"summary":"Get 1on1 History between a user","description":"","operationId":"getChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"getChatsUserMessages"},"post":{"tags":["Chat"],"summary":"Send a message to a user","description":"","operationId":"postChatsUserMessages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:add"]},"x-purecloud-method-name":"postChatsUserMessages"}},"/api/v2/chats/users/{userId}/messages/{messageId}":{"delete":{"tags":["Chat"],"summary":"Delete a message to a user","description":"","operationId":"deleteChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"204":{"description":"Message deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:delete"]},"x-purecloud-method-name":"deleteChatsUserMessage"},"patch":{"tags":["Chat"],"summary":"Edit a message to a user","description":"","operationId":"patchChatsUserMessage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"in":"body","name":"body","description":"message body","required":true,"schema":{"$ref":"#/definitions/SendMessageBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSendMessageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1Message:view"]},"x-purecloud-method-name":"patchChatsUserMessage"}},"/api/v2/chats/rooms/{roomJid}/participants/{participantJid}":{"get":{"tags":["Chat"],"summary":"Get a room participant","description":"","operationId":"getChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"participantJid","in":"path","description":"participantJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants/{userId}":{"post":{"tags":["Chat"],"summary":"Join a room","description":"","operationId":"postChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"Joined room successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:add"]},"x-purecloud-method-name":"postChatsRoomParticipant"},"delete":{"tags":["Chat"],"summary":"Remove a user from a room.","description":"","operationId":"deleteChatsRoomParticipant","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"204":{"description":"User removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:participant:delete"]},"x-purecloud-method-name":"deleteChatsRoomParticipant"}},"/api/v2/chats/rooms/{roomJid}/participants":{"get":{"tags":["Chat"],"summary":"Get room participants in a room","description":"","operationId":"getChatsRoomParticipants","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoomParticipantsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoomParticipants"}},"/api/v2/chats/rooms/{roomJid}":{"get":{"tags":["Chat"],"summary":"Get a room","description":"","operationId":"getChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Room"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsRoom"},"patch":{"tags":["Chat"],"summary":"Set properties for a room","description":"","operationId":"patchChatsRoom","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/RoomUpdateRequest"}}],"responses":{"204":{"description":"Room updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"patchChatsRoom"}},"/api/v2/chats/rooms":{"post":{"tags":["Chat"],"summary":"Create an adhoc room","description":"","operationId":"postChatsRooms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Room properties","required":true,"schema":{"$ref":"#/definitions/CreateRoomRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateRoomResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:add"]},"x-purecloud-method-name":"postChatsRooms"}},"/api/v2/chats/rooms/{roomJid}/messages/pins":{"post":{"tags":["Chat"],"summary":"Add pinned messages for a room, up to a maximum of 5 pinned messages","description":"","operationId":"postChatsRoomMessagesPins","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"in":"body","name":"body","description":"Pinned Message Ids","required":true,"schema":{"$ref":"#/definitions/PinnedMessageRequest"}}],"responses":{"204":{"description":"Pinned messages added successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"postChatsRoomMessagesPins"}},"/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}":{"delete":{"tags":["Chat"],"summary":"Remove a pinned message from a room","description":"","operationId":"deleteChatsRoomMessagesPin","produces":["application/json"],"parameters":[{"name":"roomJid","in":"path","description":"roomJid","required":true,"type":"string"},{"name":"pinnedMessageId","in":"path","description":"pinnedMessageId","required":true,"type":"string"}],"responses":{"204":{"description":"Pinned message removed successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:edit"]},"x-purecloud-method-name":"deleteChatsRoomMessagesPin"}},"/api/v2/chats/threads/{threadId}/messages":{"get":{"tags":["Chat"],"summary":"Get history by thread","description":"","operationId":"getChatsThreadMessages","produces":["application/json"],"parameters":[{"name":"threadId","in":"path","description":"threadId","required":true,"type":"string"},{"name":"limit","in":"query","description":"The maximum number of messages to retrieve","required":false,"type":"string"},{"name":"before","in":"query","description":"The cutoff date for messages to retrieve","required":false,"type":"string"},{"name":"after","in":"query","description":"The beginning date for messages to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:room:view"]},"x-purecloud-method-name":"getChatsThreadMessages"}},"/api/v2/conversations/{conversationId}/cobrowse":{"post":{"tags":["Conversations"],"summary":"Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.","description":"","operationId":"postConversationCobrowse","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cobrowse:add","conversation:cobrowseVoice:add"]},"x-purecloud-method-name":"postConversationCobrowse"}},"/api/v2/scripts/{scriptId}/export":{"post":{"tags":["Scripts"],"summary":"Export a script via download service.","description":"","operationId":"postScriptExport","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ExportScriptRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportScriptResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"postScriptExport"}},"/api/v2/scripts/uploads/{uploadId}/status":{"get":{"tags":["Scripts"],"summary":"Get the upload status of an imported script","description":"","operationId":"getScriptsUploadStatus","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload ID","required":true,"type":"string"},{"name":"longPoll","in":"query","description":"Enable longPolling endpoint","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScriptStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsUploadStatus"}},"/api/v2/scripts/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get a page","description":"","operationId":"getScriptPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPage"}},"/api/v2/scripts/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of pages","description":"","operationId":"getScriptPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPages"}},"/api/v2/scripts/published/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get the published page.","description":"","operationId":"getScriptsPublishedScriptIdPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPage"}},"/api/v2/scripts/published/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of published pages","description":"","operationId":"getScriptsPublishedScriptIdPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPages"}},"/api/v2/scripts/published/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get the published script.","description":"","operationId":"getScriptsPublishedScriptId","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptId"}},"/api/v2/scripts/published/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the published scripts metadata.","description":"","operationId":"getScriptsPublishedDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:search"]},"x-purecloud-method-name":"getScriptsPublishedDivisionviews"}},"/api/v2/scripts/published":{"get":{"tags":["Scripts"],"summary":"Get the published scripts.","description":"","operationId":"getScriptsPublished","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublished"},"post":{"tags":["Scripts"],"summary":"Publish a script.","description":"","operationId":"postScriptsPublished","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PublishScriptRequestData"}},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","script.validation.error":"The script contained validation errors","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:add"]},"x-purecloud-method-name":"postScriptsPublished"}},"/api/v2/scripts/published/{scriptId}/variables":{"get":{"tags":["Scripts"],"summary":"Get the published variables","description":"","operationId":"getScriptsPublishedScriptIdVariables","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"input","in":"query","description":"input","required":false,"type":"string","enum":["true","false"]},{"name":"output","in":"query","description":"output","required":false,"type":"string","enum":["true","false"]},{"name":"type","in":"query","description":"type","required":false,"type":"string","enum":["string","number","boolean"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdVariables"}},"/api/v2/scripts/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get a script","description":"","operationId":"getScript","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScript"}},"/api/v2/scripts/divisionviews":{"get":{"tags":["Scripts"],"summary":"Get the metadata for a list of scripts","description":"","operationId":"getScriptsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:search"]},"x-purecloud-method-name":"getScriptsDivisionviews"}},"/api/v2/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"},{"name":"divisionIds","in":"query","description":"Filters scripts to requested divisionIds","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScripts"}},"/api/v2/conversations/keyconfigurations/{keyconfigurationsId}":{"get":{"tags":["Conversations"],"summary":"Get the encryption key configurations","description":"","operationId":"getConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfiguration"},"put":{"tags":["Conversations"],"summary":"Update the encryption key configurations","description":"","operationId":"putConversationsKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyconfigurationsId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"putConversationsKeyconfiguration"}},"/api/v2/conversations/keyconfigurations":{"get":{"tags":["Conversations"],"summary":"Get a list of key configurations data","description":"","operationId":"getConversationsKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:view"]},"x-purecloud-method-name":"getConversationsKeyconfigurations"},"post":{"tags":["Conversations"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postConversationsKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurations"}},"/api/v2/conversations/keyconfigurations/validate":{"post":{"tags":["Conversations"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postConversationsKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:encryptionKey:edit"]},"x-purecloud-method-name":"postConversationsKeyconfigurationsValidate"}},"/api/v2/recording/crossplatform/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:add"]},"x-purecloud-method-name":"postRecordingCrossplatformMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicies"}},"/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingCrossplatformMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingCrossplatformMediaretentionpolicy"}},"/api/v2/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"},{"name":"deleteDaysThreshold","in":"query","description":"provides a way to fetch all policies with any actions having deleteDays exceeding the provided value","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"Policy does not work retroactively","operationId":"postRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.invalid":"The recording policy is invalid.","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.duplicate.name":"Policy name already exists, cannot duplicate.","recording.policy.description.exceeds.limit":"Policy description exceeds size limit.","recording.policy.analytics.retention.violation":"Policy retention was violated.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","recording.policy.name.exceeds.limit":"Policy named exceeds size limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:add"]},"x-purecloud-method-name":"postRecordingMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicies"}},"/api/v2/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"Policy does not work retroactively","operationId":"putRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","constraint.validation":"%s","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.policy.name.required":"Recording policy named required.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error updating policy.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingMediaretentionpolicy"}},"/api/v2/recording/recordingkeys":{"get":{"tags":["Recording"],"summary":"Get encryption key list","description":"","operationId":"getRecordingRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeys"},"post":{"tags":["Recording"],"summary":"Create encryption key","description":"","operationId":"postRecordingRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingRecordingkeys"}},"/api/v2/recording/recordingkeys/rotationschedule":{"get":{"tags":["Recording"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeysRotationschedule"},"put":{"tags":["Recording"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":true,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingRecordingkeysRotationschedule"}},"/api/v2/recording/localkeys":{"post":{"tags":["Recording"],"summary":"create a local key management recording key","description":"","operationId":"postRecordingLocalkeys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption body","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionKeyRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeys"}},"/api/v2/recording/keyconfigurations/{keyConfigurationId}":{"get":{"tags":["Recording"],"summary":"Get the encryption key configurations","description":"","operationId":"getRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfiguration"},"put":{"tags":["Recording"],"summary":"Update the encryption key configurations","description":"","operationId":"putRecordingKeyconfiguration","produces":["application/json"],"parameters":[{"name":"keyConfigurationId","in":"path","description":"Key Configurations Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Encryption key configuration metadata","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingKeyconfiguration"}},"/api/v2/recording/keyconfigurations":{"get":{"tags":["Recording"],"summary":"Get a list of key configurations data","description":"","operationId":"getRecordingKeyconfigurations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingKeyconfigurations"},"post":{"tags":["Recording"],"summary":"Setup configurations for encryption key creation","description":"","operationId":"postRecordingKeyconfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurations"}},"/api/v2/recording/keyconfigurations/validate":{"post":{"tags":["Recording"],"summary":"Validate encryption key configurations without saving it","description":"","operationId":"postRecordingKeyconfigurationsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingKeyconfigurationsValidate"}},"/api/v2/externalcontacts/bulk/contacts/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove contacts","description":"","operationId":"postExternalcontactsBulkContactsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsRemove"}},"/api/v2/externalcontacts/bulk/contacts/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add contacts","description":"","operationId":"postExternalcontactsBulkContactsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsAdd"}},"/api/v2/externalcontacts/bulk/contacts":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch contacts","description":"","operationId":"postExternalcontactsBulkContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContacts"}},"/api/v2/externalcontacts/bulk/contacts/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update contacts","description":"","operationId":"postExternalcontactsBulkContactsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contacts","required":true,"schema":{"$ref":"#/definitions/BulkContactsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUpdate"}},"/api/v2/externalcontacts/bulk/contacts/unresolved":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch unresolved ancestor contacts","description":"","operationId":"postExternalcontactsBulkContactsUnresolved","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchContactsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"postExternalcontactsBulkContactsUnresolved"}},"/api/v2/externalcontacts/bulk/notes/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add notes","description":"","operationId":"postExternalcontactsBulkNotesAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesAdd"}},"/api/v2/externalcontacts/bulk/notes/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove notes","description":"","operationId":"postExternalcontactsBulkNotesRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesRemove"}},"/api/v2/externalcontacts/bulk/notes":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch notes","description":"","operationId":"postExternalcontactsBulkNotes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Note ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkNotes"}},"/api/v2/externalcontacts/bulk/notes/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update notes","description":"","operationId":"postExternalcontactsBulkNotesUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Notes","required":true,"schema":{"$ref":"#/definitions/BulkNotesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkNotesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided note list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkNotesUpdate"}},"/api/v2/externalcontacts/bulk/organizations/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsAdd"}},"/api/v2/externalcontacts/bulk/organizations/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsRemove"}},"/api/v2/externalcontacts/bulk/organizations":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch organizations","description":"","operationId":"postExternalcontactsBulkOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizations"}},"/api/v2/externalcontacts/bulk/organizations/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update organizations","description":"","operationId":"postExternalcontactsBulkOrganizationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organizations","required":true,"schema":{"$ref":"#/definitions/BulkOrganizationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkOrganizationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided externalOrganization list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkOrganizationsUpdate"}},"/api/v2/externalcontacts/bulk/relationships/remove":{"post":{"tags":["External Contacts"],"summary":"Bulk remove relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkDeleteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsRemove"}},"/api/v2/externalcontacts/bulk/relationships":{"post":{"tags":["External Contacts"],"summary":"Bulk fetch relationships","description":"","operationId":"postExternalcontactsBulkRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships ids","required":true,"schema":{"$ref":"#/definitions/BulkIdsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkFetchRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationships"}},"/api/v2/externalcontacts/bulk/relationships/update":{"post":{"tags":["External Contacts"],"summary":"Bulk update relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsUpdate"}},"/api/v2/externalcontacts/bulk/relationships/add":{"post":{"tags":["External Contacts"],"summary":"Bulk add relationships","description":"","operationId":"postExternalcontactsBulkRelationshipsAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationships","required":true,"schema":{"$ref":"#/definitions/BulkRelationshipsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkRelationshipsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or entity list too big","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"description":"Validation Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided relationship list was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["externalContacts:contact:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsBulkRelationshipsAdd"}},"/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external contact","description":"","operationId":"getExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external contact","description":"","operationId":"putExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContactNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external contact","description":"","operationId":"deleteExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactNote"}},"/api/v2/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external contact","description":"","operationId":"getExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external contact","description":"","operationId":"postExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsContactNotes"}},"/api/v2/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external contact","description":"","operationId":"getExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContact"},"put":{"tags":["External Contacts"],"summary":"Update an external contact","description":"","operationId":"putExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:edit","externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContact"},"delete":{"tags":["External Contacts"],"summary":"Delete an external contact","description":"","operationId":"deleteExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:delete","externalContacts:contact:delete"]},"x-purecloud-method-name":"deleteExternalcontactsContact"}},"/api/v2/externalcontacts/contacts/{contactId}/identifiers":{"get":{"tags":["External Contacts"],"summary":"List the identifiers for a contact","description":"","operationId":"getExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactIdentifiers"},"patch":{"tags":["External Contacts"],"summary":"Claim or release identifiers for a contact","description":"","operationId":"patchExternalcontactsContactIdentifiers","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ClaimRequest","required":true,"schema":{"$ref":"#/definitions/IdentifierClaimRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactIdentifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.operation.type":"Invalid operation type","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","identifier.cannot.be.released":"Identifier cannot be released because it is not claimed by the contact","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.claim.conflict":"Identifier is already claimed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.cannot.be.claimed":"Identifier cannot be claimed as there's no empty field on the contact to place the identifier","operation.validation.failed":"Operation cannot take the value","validation.failed":"Field operation is not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"patchExternalcontactsContactIdentifiers"}},"/api/v2/externalcontacts/contacts/{contactId}/promotion":{"post":{"tags":["External Contacts"],"summary":"Promote an observed contact (ephemeral or identified) to a curated contact","description":"","operationId":"postExternalcontactsContactPromotion","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","promotion.of.curated.contact.failed":"The contact is a curated contact and cannot be promoted","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"The contact's type must be equal to \"Ephemeral\" or \"Identified\""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:promote"]},"x-purecloud-method-name":"postExternalcontactsContactPromotion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsContactsSchema"},"delete":{"tags":["External Contacts"],"summary":"Delete a schema","description":"","operationId":"deleteExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Delete operation forbidden.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactsSchema"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsContactsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersion"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external contact's schema","description":"","operationId":"getExternalcontactsContactsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersions"}},"/api/v2/externalcontacts/contacts/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsContactsSchemas"}},"/api/v2/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts","description":"","operationId":"getExternalcontactsContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContacts"},"post":{"tags":["External Contacts"],"summary":"Create an external contact","description":"","operationId":"postExternalcontactsContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:add","externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsContacts"}},"/api/v2/externalcontacts/merge/contacts":{"post":{"tags":["External Contacts"],"summary":"Merge two contacts into a new contact record","description":"Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details","operationId":"postExternalcontactsMergeContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MergeRequest","required":true,"schema":{"$ref":"#/definitions/MergeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"One of the contacts in the merge request was not found by ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"mergeset.max.size":"The number of merges exceeds the maximum size"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"User supplied an invalid merge request","merge.across.divisions.disallowed":"User supplied an invalid merge request"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:identity:merge"]},"x-purecloud-method-name":"postExternalcontactsMergeContacts"}},"/api/v2/externalcontacts/scan/contacts":{"get":{"tags":["External Contacts"],"summary":"Scan for external contacts using paging","description":"","operationId":"getExternalcontactsScanContacts","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of contacts per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanContacts"}},"/api/v2/externalcontacts/conversations/{conversationId}":{"put":{"tags":["External Contacts"],"summary":"Associate/disassociate an external contact with a conversation","description":"To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","operationId":"putExternalcontactsConversation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationAssociation","required":true,"schema":{"$ref":"#/definitions/ConversationAssociation"}},{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing association"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The JSON body of the request was not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","eternal.contacts.invalid.entity.id":"The entity ID was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.association.communication.id.required":"The communication id is required"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External contact is not found by conversation id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:conversation:associate","externalContacts:conversation:associate"]},"x-purecloud-method-name":"putExternalcontactsConversation"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts in an external organization","description":"","operationId":"getExternalcontactsOrganizationContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationContacts"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external organization","description":"","operationId":"getExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external organization","description":"","operationId":"putExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external organization","description":"","operationId":"deleteExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationNote"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external organization","description":"","operationId":"getExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external organization","description":"","operationId":"postExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsOrganizationNotes"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship for an external organization","description":"","operationId":"getExternalcontactsOrganizationRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\"","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External Organization is not found by externalOrganizationId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationRelationships"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external organization","description":"","operationId":"getExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganization"},"put":{"tags":["External Contacts"],"summary":"Update an external organization","description":"","operationId":"putExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganization"},"delete":{"tags":["External Contacts"],"summary":"Delete an external organization","description":"","operationId":"deleteExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"deleteExternalcontactsOrganization"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationsSchema"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersion"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external organization's schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersions"}},"/api/v2/externalcontacts/organizations/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizationsSchemas"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}":{"put":{"tags":["External Contacts"],"summary":"Links a Trustor with an External Organization","description":"","operationId":"putExternalcontactsOrganizationTrustorTrustorId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"trustorId","in":"path","description":"Trustor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationTrustorLink"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Trustor is not found by trustor id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided fields are not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationTrustorTrustorId"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor":{"delete":{"tags":["External Contacts"],"summary":"Unlink the Trustor for this External Organization","description":"","operationId":"deleteExternalcontactsOrganizationTrustor","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"204":{"description":"Trustor link has been deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Organization is not found by organization id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationTrustor"}},"/api/v2/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for external organizations","description":"","operationId":"getExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"trustorId","in":"query","description":"Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\"","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an external organization","description":"","operationId":"postExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The provided custom field is not valid.","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizations"}},"/api/v2/externalcontacts/scan/organizations":{"get":{"tags":["External Contacts"],"summary":"Scan for external organizations using paging","description":"","operationId":"getExternalcontactsScanOrganizations","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of organizations per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsScanOrganizations"}},"/api/v2/externalcontacts/identifierlookup":{"post":{"tags":["External Contacts"],"summary":"Fetch a contact using an identifier type and value.","description":"Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"","operationId":"postExternalcontactsIdentifierlookup","produces":["application/json"],"parameters":[{"in":"body","name":"identifier","required":true,"schema":{"$ref":"#/definitions/ContactIdentifier"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request body","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided identifier is not valid."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view","relate:contact:view"]},"x-purecloud-method-name":"postExternalcontactsIdentifierlookup"}},"/api/v2/externalcontacts/contacts/{contactId}/journey/sessions":{"get":{"tags":["External Contacts","Journey"],"summary":"Retrieve all sessions for a given external contact.","description":"","operationId":"getExternalcontactsContactJourneySessions","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"includeMerged","in":"query","description":"Indicates whether to return sessions from all external contacts in the merge-set of the given one.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:session:view"]},"x-purecloud-method-name":"getExternalcontactsContactJourneySessions"}},"/api/v2/externalcontacts/scan/notes":{"get":{"tags":["External Contacts"],"summary":"Scan for notes using paging","description":"","operationId":"getExternalcontactsScanNotes","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of notes per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorNoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanNotes"}},"/api/v2/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsRelationship"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsRelationship"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.division.id":"The specified division(s) is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsRelationship"}},"/api/v2/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postExternalcontactsRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The provided external organization was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsRelationships"}},"/api/v2/externalcontacts/scan/relationships":{"get":{"tags":["External Contacts"],"summary":"Scan for relationships","description":"","operationId":"getExternalcontactsScanRelationships","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of relationships per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorRelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"User supplied an invalid entity or an invalid/expired cursor"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:contact:view","externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanRelationships"}},"/api/v2/externalcontacts/reversewhitepageslookup":{"get":{"tags":["External Contacts"],"summary":"Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.","description":"","operationId":"getExternalcontactsReversewhitepageslookup","produces":["application/json"],"parameters":[{"name":"lookupVal","in":"query","description":"User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)","required":true,"type":"string"},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["contacts.externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReverseWhitepagesLookupResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsReversewhitepageslookup"}},"/api/v2/externalcontacts/contacts/{contactId}/unresolved":{"get":{"tags":["External Contacts"],"summary":"Fetch an unresolved external contact","description":"","operationId":"getExternalcontactsContactUnresolved","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.division.id":"The specified division(s) is not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"User doesn't have required permissions to the division","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactUnresolved"}},"/api/v2/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: a file attachment or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from downloading content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":true,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Ready for upload","schema":{"$ref":"#/definitions/ReplaceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid request, null argument provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"resource.conflict":"Resource conflict - Unexpected changeNumber was provided."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation","x-inin-error-codes":{"locked":"Locked - The document is locked by another operation."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocumentContent"}},"/api/v2/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["lockInfo","acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from getting document","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocument"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocument"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementDocument"}},"/api/v2/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getContentmanagementDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postContentmanagementDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.null.argument":"Invalid, null arguments provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from adding a document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocuments"}},"/api/v2/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getContentmanagementQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postContentmanagementQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","trustee.forbidden":"Forbidden due to trustee from deleting query content.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting query content.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementQuery"}},"/api/v2/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getContentmanagementSecurityprofile","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofile"}},"/api/v2/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getContentmanagementSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofiles"}},"/api/v2/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShare"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a share.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementShare"}},"/api/v2/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getContentmanagementSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated.","schema":{"$ref":"#/definitions/SharedResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","unauthorized":"Unauthorized to access document.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSharedSharedId"}},"/api/v2/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares. You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getContentmanagementShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postContentmanagementShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":true,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from saving a share.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementShares"}},"/api/v2/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementStatusStatusId"}},"/api/v2/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getContentmanagementStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatus"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalue"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tag.value.too.long":"The tag value is too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","tag.value.empty":"The tag value cannot be empty.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceTagvalue"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceTagvalue"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postContentmanagementWorkspaceTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvaluesQuery"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvalues"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getContentmanagementUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementUsage"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementWorkspaceDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceDocuments"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMember"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace Member","required":true,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to add a member to a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceMember"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to delete a member from a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceMember"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getContentmanagementWorkspaceMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get workspace members","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMembers"}},"/api/v2/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from getting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspace"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to update a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspace"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspace"}},"/api/v2/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level.","required":false,"type":"array","items":{"type":"string","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"],"default":"document:viewmetadata"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.workspace.access.fields":"Has invalid workspace fields.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a workspace.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaces"}},"/api/v2/conversations/participants/attributes/search":{"post":{"tags":["Conversations","Search"],"summary":"Search conversations","description":"","operationId":"postConversationsParticipantsAttributesSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/ConversationParticipantSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonCursorSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"postConversationsParticipantsAttributesSearch"}},"/api/v2/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:view"]},"x-purecloud-method-name":"getConversation"}},"/api/v2/conversations/{conversationId}/disconnect":{"post":{"tags":["Conversations"],"summary":"Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.","description":"","operationId":"postConversationDisconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationDisconnect"}},"/api/v2/conversations/{conversationId}/assign":{"post":{"tags":["Conversations"],"summary":"Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"postConversationAssign","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/ConversationUser"}}],"responses":{"202":{"description":"The manual assignment request was accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.status":"The user's current routing status does not allow for new conversation assignments.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","feature.not.enabled":"The feature allowing manual assignment is not enabled for this queue.","operation.failed":"The manual assignment attempt failed.","invalid.id":"The targeted user ID is missing or invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You do not have the required permission for this operation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The conversation or queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Too many active requests. Try again later."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:pull","conversation:call:assign","conversation:callback:pull","conversation:callback:assign","conversation:webchat:pull","conversation:webchat:assign","conversation:email:pull","conversation:email:assign","conversation:message:pull","conversation:message:assign"]},"x-purecloud-method-name":"postConversationAssign"}},"/api/v2/conversations/{conversationId}/tags":{"put":{"tags":["Conversations"],"summary":"Update the tags on a conversation.","description":"","operationId":"putConversationTags","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Tags","required":true,"schema":{"$ref":"#/definitions/ConversationTagsUpdate"}}],"responses":{"202":{"description":"The tags update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:externalTag:edit"]},"x-purecloud-method-name":"putConversationTags"}},"/api/v2/conversations/{conversationId}/secureattributes":{"get":{"tags":["Conversations"],"summary":"Get the secure attributes on a conversation.","description":"","operationId":"getConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"Secure attributes retrieved successfully","schema":{"$ref":"#/definitions/ConversationSecureAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","secure.attributes.not.found":"Secure attributes could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesview"]},"x-purecloud-method-name":"getConversationSecureattributes"},"put":{"tags":["Conversations"],"summary":"Set the secure attributes on a conversation.","description":"","operationId":"putConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes set request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred setting the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"putConversationSecureattributes"},"patch":{"tags":["Conversations"],"summary":"Update the secure attributes on a conversation.","description":"","operationId":"patchConversationSecureattributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Secure Attributes","required":true,"schema":{"$ref":"#/definitions/ConversationSecureAttributes"}}],"responses":{"202":{"description":"The secure attributes update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.secure.attribute.conflict":"A conflict occurred updating the secure attributes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:attributesedit"]},"x-purecloud-method-name":"patchConversationSecureattributes"}},"/api/v2/conversations":{"get":{"tags":["Conversations"],"summary":"Get active conversations for the logged in user","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversations"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postConversationsFaxes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":true,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.content.type.not.supported":"The fax content type is not supported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","fax.missing.field":"Missing required field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","fax.internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsFaxes"}},"/api/v2/conversations/settings":{"get":{"tags":["Conversations"],"summary":"Get Settings","description":"","operationId":"getConversationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Settings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getConversationsSettings"},"patch":{"tags":["Conversations"],"summary":"Update Settings","description":"","operationId":"patchConversationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/Settings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchConversationsSettings"}},"/api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update after-call work for this conversation communication.","description":"","operationId":"patchConversationsAftercallworkConversationIdParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"AfterCallWorkUpdate","required":true,"schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/AfterCallWorkUpdate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsAftercallworkConversationIdParticipantCommunication"}},"/api/v2/conversations/callbacks/bulk/update":{"post":{"tags":["Conversations"],"summary":"Update multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackPatchRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkCallbackPatchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk edit request.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"postConversationsCallbacksBulkUpdate"}},"/api/v2/conversations/callbacks/bulk/disconnect":{"post":{"tags":["Conversations"],"summary":"Disconnect multiple scheduled callbacks","description":"","operationId":"postConversationsCallbacksBulkDisconnect","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"BulkCallbackDisconnectRequest","required":true,"schema":{"$ref":"#/definitions/BulkCallbackDisconnectRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.too.many.entities":"There were too many entities in the bulk disconnect request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationsCallbacksBulkDisconnect"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get active call conversations for the logged in user","description":"","operationId":"getConversationsCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postConversationsCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Call request","required":true,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.create.conversation.parameters":"Only a single destination can be supplied in a create conversation request.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.create.conversation.destination.parameter":"At least one destination should be supplied in a create conversation request.","constraint.validation":"%s","conversation.error.no.user.station":"A station is required to place a call.","conversation.error.cannot.create.conference":"Unable to create a conference.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.invalid.external.contact":"The external contact supplied is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.cannot.resolve":"Cannot resolve station.","providerapi.error.user.does.not.have.a.station":"User does not have a station.","conversation.error.media.failed":"The media request failed.","providerapi.error.edge.cannot.resolve":"Cannot resolve edge.","providerapi.error.ccxml.uri.not_found":"Failed to get CCXML URI from edge config.","providerapi.error.edge.no.active":"Could not find an active Edge in Site.","providerapi.error.phone.cannot.resolve":"Cannot resolve phone.","providerapi.error.phone.no.active.edge":"The phone is not assigned to active Edges."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conference:add"]},"x-purecloud-method-name":"postConversationsCalls"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantReplace"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsCallParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:monitor"]},"x-purecloud-method-name":"postConversationsCallParticipantMonitor"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapupcodes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer"]},"x-purecloud-method-name":"postConversationsCallParticipantConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversation.error.consult.transfer.not.started":"The consult transfer can't be canceled since it hasn't started yet."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsCallParticipantConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantConsult"}},"/api/v2/conversations/calls/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.common.user":"This conference can not be created because there is no common user among all the active participants.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.media.failed":"The media request failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCall"},"post":{"tags":["Conversations"],"summary":"Place a new call as part of a callback conversation.","description":"","operationId":"postConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.callback.call.cannot.be.placed":"An error occurred while trying to place the callback.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCall"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants","description":"","operationId":"patchConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"Call is disconnected, cannot alter recordingState","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCall"}},"/api/v2/conversations/calls/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallRecordingstate"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantAttributes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantCommunication"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallParticipantCommunicationWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.call.disconnected":"The call is already disconnected.","conversation.error.user.not.party":"The participant for this request does not belong to the user making the request.","constraint.validation":"%s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.error.hold.alerting":"An alerting call cannot be placed on hold.","conversation.error.cannot.create.conference":"Unable to create a conference.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"Conversation not found.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallParticipant"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getConversationsCallsMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.","description":"","operationId":"postConversationsCallParticipantCoach","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:coach"]},"x-purecloud-method-name":"postConversationsCallParticipantCoach"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an agent","description":"","operationId":"postConversationsCallParticipantConsultAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination agent & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToAgent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferAgent"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultAgent"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to a queue","description":"","operationId":"postConversationsCallParticipantConsultQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination queue & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferQueue"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultQueue"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external":{"post":{"tags":["Conversations"],"summary":"Initiate a consult transfer to an external contact","description":"","operationId":"postConversationsCallParticipantConsultExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferToExternal"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","object.participant.id.required":"A connected object participant is required.","constraint.validation":"%s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","not.a.participant":"You are not a connected participant on the call","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:consultTransfer","conversation:communication:consultTransferExternal"]},"x-purecloud-method-name":"postConversationsCallParticipantConsultExternal"}},"/api/v2/conversations/calls/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationsCallParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipants"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getConversationsCallsHistory","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size, maximum 50","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["externalorganization","externalcontact","user","queue","group"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallHistoryConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsHistory"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata":{"put":{"tags":["Conversations"],"summary":"Set uuiData to be sent on future commands.","description":"","operationId":"putConversationsCallParticipantCommunicationUuidata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"UUIData Request","required":true,"schema":{"$ref":"#/definitions/SetUuiDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsCallParticipantCommunicationUuidata"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get active callback conversations for the logged in user","description":"","operationId":"getConversationsCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Callback","required":true,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.scheduled.callback.limit.exceeded":"Number of callbacks has been exceeded for a single conversation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.number.limit.exceeded":"Number of attributes has exceeded the limit","callback.error.cannot.create.agent.owned.callback":"Cannot create agent owned callback on queue that does not have agent owned callbacks enabled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationsCallbacks"},"patch":{"tags":["Conversations"],"summary":"Update a scheduled callback","description":"","operationId":"patchConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"PatchCallbackRequest","required":true,"schema":{"$ref":"#/definitions/PatchCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PatchCallbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","callback.error.missing.required.information.for.patch.request":"The patch request requires either a scheduled time or queueId.","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","constraint.validation":"%s","callback.error.conversation.not.found":"conversation not found.","callback.error.cannot.update.non.agent.owned.callback":"Cannot update non agent owned callback","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.queue.not.found":"queue not found","callback.error.agent.not.member.of.queue":"Agent is not a member of the queue","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","callback.error.scheduled.callback.job.id.not.found":"The scheduled callback job id was not found","callback.error.callback.not.found":"The callback was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.already.triggered":"Unable to update an already triggered callback."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.error.unable.to.update.schedule.callback":"Unable to update scheduled callback"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:callback:edit"]},"x-purecloud-method-name":"patchConversationsCallbacks"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallbackParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","callback.error.transfer.not.connected":"Only connected participants can be transferred","callback.error.additional.info.value.length.invalid":"The length of the additional info value is invalid.","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","conversations.error.transfer.acd.call.unattended.":"An ACD call cannot be transferred unattended.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.unable.to.schedule.callback":"Server error unable to schedule callback.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCallbackParticipantReplace"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallbackParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapupcodes"}},"/api/v2/conversations/callbacks/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallback"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","conversation.error.cannot.conference.self":"A conversation cannot be merged with itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCallback"}},"/api/v2/conversations/callbacks/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCallbackRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCallbackRecordingstate"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallbackParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantAttributes"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallbackParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallbackParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantCommunication"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsCallbackParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.communication.not.found":"Communication could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCallbackParticipantCommunicationWrapup"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallbackParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","callback.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","callback.error.conversation.not.found":"Conversation not found.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCallbackParticipant"}},"/api/v2/conversations/chats/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get a web chat conversation message","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessage"}},"/api/v2/conversations/chats/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get the messages of a chat conversation.","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If specified, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If specified, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send a message on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"chat error occurred due to null request body.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Chat error occurred due to bad request.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationMessages"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send a typing-indicator on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"chat conversation typing-indicator is not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationTyping"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get active chat conversations for the logged in user","description":"","operationId":"getConversationsChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChats"},"post":{"tags":["Conversations"],"summary":"Create a web chat conversation","description":"","operationId":"postConversationsChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create web chat request","required":true,"schema":{"$ref":"#/definitions/CreateWebChatRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.provider":"The provider property may not be null.","chat.error.queue.not.found":"The queue does not exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:webchat:create"]},"x-purecloud-method-name":"postConversationsChats"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsChatParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsChatParticipantReplace"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsChatParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapupcodes"}},"/api/v2/conversations/chats/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChat"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsChat"}},"/api/v2/conversations/chats/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsChatRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsChatRecordingstate"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsChatParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantAttributes"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsChatParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsChatParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsChatParticipant"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsChatParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantCommunication"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsChatParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsChatParticipantCommunicationWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantReplace"}},"/api/v2/conversations/cobrowsesessions":{"get":{"tags":["Conversations"],"summary":"Get active cobrowse conversations for the logged in user","description":"","operationId":"getConversationsCobrowsesessions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessions"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapupcodes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get cobrowse conversation","description":"","operationId":"getConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesession"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCobrowsesession"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsCobrowsesessionRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsCobrowsesessionRecordingstate"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantAttributes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantCommunication"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsCobrowsesessionParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantCommunicationWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchConversationsCobrowsesessionParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsEmailParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.transfer.replace.external":"External participants may not be replaced.","constraint.validation":"%s","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.transfer.not.connected":"Only connected participants can be transferred."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsEmailParticipantReplace"}},"/api/v2/conversations/emails/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsEmailMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessage"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get active email conversations for the logged in user","description":"","operationId":"getConversationsEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmails"},"post":{"tags":["Conversations"],"summary":"Create an email conversation","description":"If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","operationId":"postConversationsEmails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create email request","required":true,"schema":{"$ref":"#/definitions/CreateEmailRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.outbound.invalid.external.contact":"The external contact supplied is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","email.outbound.queue.address.required":"The queue does not have an outbound email address configured.","constraint.validation":"%s","postino.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","too.many.create.email.parameters":"One of queueId or flowId must be supplied.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.outbound.queue.required":"An outbound email conversation requires a queue ID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create"]},"x-purecloud-method-name":"postConversationsEmails"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsEmailParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapupcodes"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy":{"post":{"tags":["Conversations"],"summary":"Copy attachments from an email message to the current draft.","description":"","operationId":"postConversationsEmailMessagesDraftAttachmentsCopy","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Copy Attachment Request","required":true,"schema":{"$ref":"#/definitions/CopyAttachmentsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.userid":"Reply emails must have a userId.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessagesDraftAttachmentsCopy"}},"/api/v2/conversations/emails/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessagePreviewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageReply"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.attachments.upload.size":"Upload too large.","email.error.external.provider":"Operation not supported on emails with external providers.","email.error.domain.not.verified":"The email domain has not been verified.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.body":"Replies must have a textBody or htmlBody.","postino.error.reply.no.sender":"No connected internal participant found for the reply.","postino.error.reply.no.to":"Replies must have a to address.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.reply.no.receiver":"No connected external participant found for the reply.","postino.error.reply.no.userid":"Reply emails must have a userId.","email.error.invalid.email":"Attempted to send an email with an invalid parameter.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The request has timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessages"}},"/api/v2/conversations/emails/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmail"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsEmail"}},"/api/v2/conversations/emails/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsEmailRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsEmailRecordingstate"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsEmailParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantAttributes"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsEmailParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapup"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsEmailParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsEmailParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsEmailParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantCommunication"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsEmailParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsEmailParticipantCommunicationWrapup"}},"/api/v2/conversations/emails/{conversationId}/settings":{"get":{"tags":["Conversations"],"summary":"Get emails settings for a given conversation","description":"","operationId":"getConversationsEmailSettings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.wrong.org":"The provided conversationId doesn't belong to the current organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The domain that should be used for sending, which is therefore used to determinate the emails settings, cannot be found","postino.error.not.found":"Either the conversation or related elements that permit to retrieve the concerned domain cannot be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailSettings"}},"/api/v2/conversations/emails/{conversationId}/reconnect":{"post":{"tags":["Conversations"],"summary":"Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation","description":"","operationId":"postConversationsEmailReconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.reconnect.already.connected":"Cannot reconnect. Not all communications are disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","email.reconnect.expired":"Cannot reconnect. Conversation is expired based on this organization's email threading settings.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","email.reconnect.no.internal":"Cannot reconnect. No previous Agent communication found on the conversation.","email.reconnect.no.external":"Cannot reconnect. No previous customer communication found on the conversation.","postino.route.not.found":"Cannot reconnect. No inbound route found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:reconnect"]},"x-purecloud-method-name":"postConversationsEmailReconnect"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationsEmailMessagesDraftAttachment","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.org.missing":"OrganizationId header is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsEmailMessagesDraftAttachment"}},"/api/v2/conversations/emails/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","postino.error.org.missing":"OrganizationId header is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsEmailMessagesDraft"},"patch":{"tags":["Conversations"],"summary":"Reset conversation draft to its initial state and/or auto-fill draft content","description":"","operationId":"patchConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"autoFill","in":"query","description":"autoFill","required":false,"type":"boolean"},{"name":"discard","in":"query","description":"discard","required":false,"type":"boolean"},{"in":"body","name":"body","description":"Draft Manipulation Request","required":false,"schema":{"$ref":"#/definitions/DraftManipulationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax or missing field(s).","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.route.not.found":"The inbound route does not exist.","constraint.validation":"%s","postino.error.wrong.org":"OrganizationId does not match the resources organization.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","postino.error.forbidden":"User is not an active participant on the conversation","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.draft.initialized":"The draft is already initialized."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailMessagesDraft"}},"/api/v2/conversations/emails/{conversationId}/inboundmessages":{"post":{"tags":["Conversations"],"summary":"Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.","description":"","operationId":"postConversationsEmailInboundmessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Send external email reply","required":true,"schema":{"$ref":"#/definitions/InboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","email.error.invalid.queue":"An invalid queue ID was specified.","email.error.internal.provider":"Operation not supported on emails with PureCloud providers","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"Invalid flow ID was specified.","too.many.external.email.parameters":"Only one of queueId or flowId may be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailInboundmessages"}},"/api/v2/conversations/emails/agentless":{"post":{"tags":["Conversations"],"summary":"Create an email conversation, per API","description":"","operationId":"postConversationsEmailsAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless email request","required":true,"schema":{"$ref":"#/definitions/AgentlessEmailSendRequestDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentlessEmailSendResponseDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.subject.too.long":"The subject message was too long.","postino.error.invalid.sender.type":"The sender type is invalid","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.not.verified":"The outbound domain is not verified.","postino.error.missing.field":"Missing required field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.conversation.not.found":"The conversation does not exist or is not an email interaction.","postino.error.not.found":"The outbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error":"An error has occurred. Please contact support.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","postino.error.internal":"An internal service error has occurred. Please contact support."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create","conversation:agentlessEmail:send"]},"x-purecloud-method-name":"postConversationsEmailsAgentless"}},"/api/v2/emails/settings":{"get":{"tags":["Emails","Settings"],"summary":"Get email Contact Center settings","description":"","operationId":"getEmailsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:view"]},"x-purecloud-method-name":"getEmailsSettings"},"patch":{"tags":["Emails","Settings"],"summary":"Patch email Contact Center settings","description":"","operationId":"patchEmailsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EmailSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:settings:edit"]},"x-purecloud-method-name":"patchEmailsSettings"}},"/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}":{"get":{"tags":["Conversations"],"summary":"Get a cached media item","description":"","operationId":"getConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmediaCachedMediaItemId"},"delete":{"tags":["Conversations"],"summary":"Remove a cached media item asychronously","description":"","operationId":"deleteConversationsMessagesCachedmediaCachedMediaItemId","produces":["application/json"],"parameters":[{"name":"cachedMediaItemId","in":"path","description":"cachedMediaItemId","required":true,"type":"string"}],"responses":{"202":{"description":"Request accepted to delete media from cache"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:delete"]},"x-purecloud-method-name":"deleteConversationsMessagesCachedmediaCachedMediaItemId"}},"/api/v2/conversations/messages/cachedmedia":{"get":{"tags":["Conversations"],"summary":"Get a list of cached media items","description":"","operationId":"getConversationsMessagesCachedmedia","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"url","in":"query","description":"URL to search for","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CachedMediaItemEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:cachedMedia:view"]},"x-purecloud-method-name":"getConversationsMessagesCachedmedia"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsMessageParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationsMessageParticipantReplace"}},"/api/v2/conversations/messages/{messageId}/details":{"get":{"tags":["Conversations"],"summary":"Get message","description":"","operationId":"getConversationsMessageDetails","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageDetails"}},"/api/v2/conversations/messages":{"get":{"tags":["Conversations"],"summary":"Get active message conversations for the logged in user","description":"","operationId":"getConversationsMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessages"},"post":{"tags":["Conversations"],"summary":"Create an outbound messaging conversation.","description":"If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","operationId":"postConversationsMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create outbound messaging conversation","required":true,"schema":{"$ref":"#/definitions/CreateOutboundMessagingConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.phone.numbers":"SMS phone number addresses are not in a valid E.164 format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.address.required":"The queue does not have an outbound messaging address configured.","invalid.whatsapp.address":"WhatsApp address must only contain numeric characters of destination phone number.","queue.membership.required":"Queue membership is invalid.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The SMS phone number address is not a valid E.164 format.","active.conversation":"An alerting or connected conversation is already in progress.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessages"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsMessageParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","too.many.monitors":"Only one monitor is allowed per conversation.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:monitor"]},"x-purecloud-method-name":"postConversationsMessageParticipantMonitor"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsMessageParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapupcodes"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send message","description":"Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.","operationId":"postConversationsMessageCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/AdditionalMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","not.found":"Message not found.","constraint.validation":"%s","media.too.large":"Media must comply with the size limits of the channel","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Server error handing chat."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessages"}},"/api/v2/conversations/messages/{conversationId}/messages/bulk":{"post":{"tags":["Conversations"],"summary":"Get messages in batch","description":"The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]","operationId":"postConversationsMessageMessagesBulk","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"messageIds","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"postConversationsMessageMessagesBulk"}},"/api/v2/conversations/messages/inbound/open":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Message","description":"[This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessagesInboundOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessagesInboundOpen"}},"/api/v2/conversations/messages/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get message conversation","description":"","operationId":"getConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessage"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsMessage"}},"/api/v2/conversations/messages/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsMessageRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsMessageRecordingstate"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsMessageParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ParticipantAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantAttributes"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsMessageParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapup"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsMessageParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationsMessageParticipant"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsMessageParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantCommunication"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsMessageParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsMessageParticipantCommunicationWrapup"}},"/api/v2/conversations/messages/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsMessageMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"},{"name":"useNormalizedMessage","in":"query","description":"If true, response removes deprecated fields (textBody, media, stickers)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageMessage"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media":{"post":{"tags":["Conversations"],"summary":"Create media","description":"See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","operationId":"postConversationsMessageCommunicationMessagesMedia","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessagesMedia"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}":{"get":{"tags":["Conversations"],"summary":"Get media","description":"See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","operationId":"getConversationsMessageCommunicationMessagesMediaMediaId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"mediaId","in":"path","description":"mediaId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view","conversation:webmessaging:view"]},"x-purecloud-method-name":"getConversationsMessageCommunicationMessagesMediaMediaId"}},"/api/v2/conversations/messages/agentless":{"post":{"tags":["Conversations"],"summary":"Send an agentless outbound message","description":"Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and 'toAddress' specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.","operationId":"postConversationsMessagesAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless outbound messaging request","required":true,"schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageResponse"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.whatsapp.address":"WhatsApp address must only contain numeric characters of destination phone number.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","active.conversation":"An alerting or connected conversation is already in progress.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessagesAgentless"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/event":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Event Message","description":"Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenEvent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedEvent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenEventNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenEvent"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/message":{"post":{"tags":["Conversations"],"summary":"Send inbound Open Message","description":"Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenMessage","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenMessageNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenMessage"}},"/api/v2/conversations/messages/{integrationId}/inbound/open/receipt":{"post":{"tags":["Conversations"],"summary":"Send an inbound Open Receipt Message","description":"Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","operationId":"postConversationsMessageInboundOpenReceipt","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"integrationId","required":true,"type":"string"},{"in":"body","name":"body","description":"NormalizedMessage","required":true,"schema":{"$ref":"#/definitions/OpenInboundNormalizedReceipt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenReceiptNormalizedMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","missing.open.channel.date":"Missing open channel date.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:receive"]},"x-purecloud-method-name":"postConversationsMessageInboundOpenReceipt"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send message typing event","description":"Send message typing event for existing conversation/communication.","operationId":"postConversationsMessageCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"MessageTypingEvent","required":true,"schema":{"$ref":"#/definitions/MessageTypingEventRequest"}}],"responses":{"204":{"description":"Message typing event sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:create","conversation:webmessaging:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationTyping"}},"/api/v2/conversations/screenshares/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"putConversationsScreenshareRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsScreenshareRecordingstate"}},"/api/v2/conversations/screenshares/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConversationsScreenshareParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"postConversationsScreenshareParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsScreenshareParticipantCommunicationWrapup"}},"/api/v2/conversations/socials/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsSocialRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsSocialRecordingstate"}},"/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsSocialParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsSocialParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsSocialParticipantCommunicationWrapup"}},"/api/v2/conversations/videos/{conversationId}/recordingstate":{"put":{"tags":["Conversations"],"summary":"Update a conversation by setting its recording state","description":"","operationId":"putConversationsVideoRecordingstate","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"SetRecordingState","required":true,"schema":{"$ref":"#/definitions/SetRecordingState"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"type":"string","enum":["ACTIVE","PAUSED","NONE"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.disconnected":"Conversation is disconnected, cannot alter recordingState","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","conversation.error.forbidden.not.active.participant":"User is not active on conversation and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:recording:pauseOthers"]},"x-purecloud-method-name":"putConversationsVideoRecordingstate"}},"/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation communication. ","description":"","operationId":"getConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsVideoParticipantCommunicationWrapup"},"post":{"tags":["Conversations"],"summary":"Apply wrap-up for this conversation communication","description":"","operationId":"postConversationsVideoParticipantCommunicationWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Wrap-up","required":false,"schema":{"$ref":"#/definitions/WrapupInput"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.wrapup.code":"Wrapup code is required for non-provisional wrapup.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"postConversationsVideoParticipantCommunicationWrapup"}},"/api/v2/conversations/messaging/integrations":{"get":{"tags":["Conversations"],"summary":"Get a list of Integrations","description":"","operationId":"getConversationsMessagingIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"array","items":{"type":"string","enum":["supportedContent","messagingSetting"]},"collectionFormat":"multi"},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrations"}},"/api/v2/conversations/messaging/threadingtimeline":{"get":{"tags":["Conversations"],"summary":"Get conversation threading window timeline for each messaging type","description":"Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.","operationId":"getConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:view"]},"x-purecloud-method-name":"getConversationsMessagingThreadingtimeline"},"put":{"tags":["Conversations"],"summary":"Update conversation threading window timeline for each messaging type","description":"PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.","operationId":"putConversationsMessagingThreadingtimeline","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationThreadingWindowRequest","required":true,"schema":{"$ref":"#/definitions/ConversationThreadingWindow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationThreadingWindow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.threading.window.timeout":"The provided conversation threading window timeout for a messaging type is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:threadingTimeline:edit"]},"x-purecloud-method-name":"putConversationsMessagingThreadingtimeline"}},"/api/v2/conversations/messaging/facebook/app":{"get":{"tags":["Conversations"],"summary":"Get Genesys Facebook App Id","description":"","operationId":"getConversationsMessagingFacebookApp","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookAppCredentials"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookApp"}},"/api/v2/conversations/messaging/integrations/facebook/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Facebook messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebookIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Facebook messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Facebook integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsFacebookIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Facebook messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"FacebookIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsFacebookIntegrationId"}},"/api/v2/conversations/messaging/integrations/facebook":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Integrations","description":"","operationId":"getConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebook"},"post":{"tags":["Conversations"],"summary":"Create a Facebook Integration","description":"","operationId":"postConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FacebookIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Facebook permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","unsupported.message.channel":"Unsupported messageChannel.","constraint.validation":"%s","facebook.public.not.yet.supported":"Facebook Public not yet supported.","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature.","existing.active.webhook.facebook.subscription":"There is another active webhook subscription for this Facebook App."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsFacebook"}},"/api/v2/conversations/messaging/facebook/permissions":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Permissions","description":"","operationId":"getConversationsMessagingFacebookPermissions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Completed request for public message.","schema":{"$ref":"#/definitions/FacebookPermissionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:integration:add","messaging:integration:edit","messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookPermissions"}},"/api/v2/conversations/messaging/integrations/instagram/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get Instagram messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagramIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete Instagram messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Instagram integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsInstagramIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Instagram messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsInstagramIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"InstagramIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsInstagramIntegrationId"}},"/api/v2/conversations/messaging/integrations/instagram":{"get":{"tags":["Conversations"],"summary":"Get a list of Instagram Integrations","description":"","operationId":"getConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsInstagram"},"post":{"tags":["Conversations"],"summary":"Create Instagram Integration","description":"","operationId":"postConversationsMessagingIntegrationsInstagram","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"InstagramIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/InstagramIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InstagramIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/InstagramIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"The provided access token is missing Instagram permissions for this feature.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.access.token.combination":"The request requires either the pageId and userAccessToken fields, or the pageAccessToken field.","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","could.not.find.page.access.token":"Could not find Page Access Token for the pageId provided.","instagram.not.yet.supported":"Instagram not yet supported.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","no.instagram.account.associated.with.page":"No Instagram account associated with page.","invalid.page.access.token.provided":"Provided Page Access Token is invalid.","page.subscription.error":"Encountered an error while subscribing Facebook page to webhooks. Verify that any existing integration linked to this page is in a valid state","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.already.integrated":"There is an existing integration for this page with the requested feature."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:conversationInstagramIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsInstagram"}},"/api/v2/conversations/messaging/integrations/open/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpenIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"deleteConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"Open messaging integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsOpenIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"patchConversationsMessagingIntegrationsOpenIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OpenIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsOpenIntegrationId"}},"/api/v2/conversations/messaging/integrations/open":{"get":{"tags":["Conversations"],"summary":"Get a list of Open messaging integrations","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"getConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsOpen"},"post":{"tags":["Conversations"],"summary":"Create an Open messaging integration","description":"See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.","operationId":"postConversationsMessagingIntegrationsOpen","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OpenIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/OpenIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OpenIntegration"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/OpenIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","notification.webhook.signature.secret.token.longer.than.15.characters":"The notification webhook signature secret token for the integration must be longer than 15 characters.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.outbound.webhook.url":"The outboundNotificationWebhookUrl provided is not a valid url.","too.many.webhook.headers":"Too many webhook headers provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsOpen"}},"/api/v2/conversations/messaging/settings/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"getConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettingsDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default setting that may be applied to to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"putConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putConversationsMessagingSettingsDefault"},"delete":{"tags":["Conversations"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","operationId":"deleteConversationsMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSettingsDefault"}},"/api/v2/conversations/messaging/settings":{"get":{"tags":["Conversations"],"summary":"Get a list of messaging settings","description":"","operationId":"getConversationsMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSettings"},"post":{"tags":["Conversations"],"summary":"Create a messaging setting","description":"","operationId":"postConversationsMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postConversationsMessagingSettings"}},"/api/v2/conversations/messaging/settings/{messageSettingId}":{"get":{"tags":["Conversations"],"summary":"Get a messaging setting","description":"","operationId":"getConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getConversationsMessagingSetting"},"delete":{"tags":["Conversations"],"summary":"Delete a messaging setting","description":"","operationId":"deleteConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSetting"},"patch":{"tags":["Conversations"],"summary":"Update a messaging setting","description":"","operationId":"patchConversationsMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Setting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.messaging.setting":"The messaging setting request was invalid. One or more errors may be reported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSetting"}},"/api/v2/conversations/messaging/supportedcontent/default":{"get":{"tags":["Conversations"],"summary":"Get the organization's default supported content profile that will be used as the default when creating an integration.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"getConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentDefault"},"put":{"tags":["Conversations"],"summary":"Set the organization's default supported content profile that may be assigned to an integration when it is created.","description":"When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","operationId":"putConversationsMessagingSupportedcontentDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContentReference"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.id.required":"The supported content ID is required","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"putConversationsMessagingSupportedcontentDefault"}},"/api/v2/conversations/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Conversations"],"summary":"Get a supported content profile","description":"","operationId":"getConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Conversations"],"summary":"Delete a supported content profile","description":"","operationId":"deleteConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Conversations"],"summary":"Update a supported content profile","description":"","operationId":"patchConversationsMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchConversationsMessagingSupportedcontentSupportedContentId"}},"/api/v2/conversations/messaging/supportedcontent":{"get":{"tags":["Conversations"],"summary":"Get a list of Supported Content profiles","description":"","operationId":"getConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getConversationsMessagingSupportedcontent"},"post":{"tags":["Conversations"],"summary":"Create a Supported Content profile","description":"","operationId":"postConversationsMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postConversationsMessagingSupportedcontent"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}":{"patch":{"tags":["Conversations"],"summary":"Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow","description":"Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active","operationId":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationActivationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationActivationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration activation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","phone.number.not.found.on.waba":"The phone number provided was not found on the WABA.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"please.ensure.two.factor.authentication.is.disabled":"Please ensure two-factor authentication is disabled.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappEmbeddedsignupIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup":{"post":{"tags":["Conversations"],"summary":"Create a WhatsApp Integration using the WhatsApp embedded signup flow","description":"Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.","operationId":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppEmbeddedSignupIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppEmbeddedSignupIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsappEmbeddedsignup"}},"/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a WhatsApp messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsappIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a WhatsApp messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Request Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recipient.has.flow":"WhatsApp integration cannot be deleted with an existing flow associated to it. Remove associated flow before deleting integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update a WhatsApp messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Processing Request","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappIntegrationId"}},"/api/v2/conversations/messaging/integrations/whatsapp":{"get":{"tags":["Conversations"],"summary":"Get a list of WhatsApp Integrations","description":"","operationId":"getConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["supportedContent","messagingSetting"]},{"name":"supportedContent.id","in":"query","description":"Filter integrations returned based on the supported content ID","required":false,"type":"string"},{"name":"messagingSetting.id","in":"query","description":"Filter integrations returned based on the setting ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsapp"},"post":{"tags":["Conversations"],"summary":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration","description":"[This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.","operationId":"postConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Accepted - The integration creation in progress.","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number provided is invalid as it is not in E.164 phone format.","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.integrations.for.this.message.channel":"There are too many WhatsApp integrations already created.","phone.number.already.in.use":"A WhatsApp integration has already been created for this phone number."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsapp"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationParticipantCode","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantCode"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.cannot.disconnect.call":"The call for this request cannot be disconnected.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversation.error.hold.alerting":"An alerting call cannot be placed on hold","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","conversation.error.participant.attribute.null":"Cannot update participant attribute map to a null value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:participant:wrapup"]},"x-purecloud-method-name":"patchConversationParticipant"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer"]},"x-purecloud-method-name":"postConversationParticipantReplace"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/digits":{"post":{"tags":["Conversations"],"summary":"Sends DTMF to the participant","description":"","operationId":"postConversationParticipantDigits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digits","required":false,"schema":{"$ref":"#/definitions/Digits"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantDigits"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapupcodes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationParticipantCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackOnConversationCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.callback.already.being.routed":"A callback is already in the process of being routed on this conversation.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversation.error.queue.required":"Queue id is required for this request.","callback.error.scheduled.time.too.far.in.future":"The callback scheduled time cannot be more than 30 days into the future.","constraint.validation":"%s","conversation.error.cannot.callback.acd":"Cannot create a callback for an ACD participant.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","callback.error.scheduled.callback.already.exists":"A callback is already scheduled on this conversation.","callback.error.target.communication.cannot.be.acd.or.ivr":"Target communication cannot belong to an acd or ivr participant.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationParticipantCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"The participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipantAttributes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapup"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified agent","description":"","operationId":"postConversationParticipantReplaceAgent","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToAgentRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferAgent"]},"x-purecloud-method-name":"postConversationParticipantReplaceAgent"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified queue","description":"","operationId":"postConversationParticipantReplaceQueue","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToQueueRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferQueue"]},"x-purecloud-method-name":"postConversationParticipantReplaceQueue"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the an external contact","description":"","operationId":"postConversationParticipantReplaceExternal","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferToExternalRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","constraint.validation":"%s","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:blindTransfer","conversation:communication:blindTransferExternal"]},"x-purecloud-method-name":"postConversationParticipantReplaceExternal"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason":{"put":{"tags":["Conversations"],"summary":"Set flagged reason on conversation participant to indicate bad conversation quality.","description":"","operationId":"putConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was set successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationParticipantFlaggedreason"},"delete":{"tags":["Conversations"],"summary":"Remove flagged reason from conversation participant.","description":"","operationId":"deleteConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was removed successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantFlaggedreason"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}":{"get":{"tags":["Conversations"],"summary":"Fetch info on a secure session","description":"","operationId":"getConversationParticipantSecureivrsession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"secureSessionId","in":"path","description":"secure IVR session ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsession"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions":{"get":{"tags":["Conversations"],"summary":"Get a list of secure sessions for this participant.","description":"","operationId":"getConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSessionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsessions"},"post":{"tags":["Conversations"],"summary":"Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.","description":"","operationId":"postConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSecureSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantSecureivrsessions"}},"/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback":{"post":{"tags":["Conversations"],"summary":"Submit feedback for the summary.","description":"","operationId":"postConversationSummaryFeedback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"summaryId","in":"path","description":"Summary ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FeedbackAddRequest"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conversation.not.found":"Invalid conversationId supplied.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:summaryFeedback:add"]},"x-purecloud-method-name":"postConversationSummaryFeedback"}},"/api/v2/integrations/credentials/{credentialId}":{"get":{"tags":["Integrations"],"summary":"Get a single credential with sensitive fields redacted","description":"","operationId":"getIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredential"},"put":{"tags":["Integrations"],"summary":"Update a set of credentials","description":"","operationId":"putIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationsCredential"},"delete":{"tags":["Integrations"],"summary":"Delete a set of credentials","description":"","operationId":"deleteIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegrationsCredential"}},"/api/v2/integrations/credentials/types":{"get":{"tags":["Integrations"],"summary":"List all credential types","description":"","operationId":"getIntegrationsCredentialsTypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialTypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentialsTypes"}},"/api/v2/integrations/credentials":{"get":{"tags":["Integrations"],"summary":"List multiple sets of credentials","description":"","operationId":"getIntegrationsCredentials","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfoListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentials"},"post":{"tags":["Integrations"],"summary":"Create a set of credentials","description":"","operationId":"postIntegrationsCredentials","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsCredentials"}},"/api/v2/uploads/learning/coverart":{"post":{"tags":["Uploads"],"summary":"Generates pre-signed URL to upload cover art for learning modules","description":"","operationId":"postUploadsLearningCoverart","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/LearningCoverArtUploadUrlRequest"}}],"responses":{"200":{"description":"Pre-signed urls successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:coverart:upload"]},"x-purecloud-method-name":"postUploadsLearningCoverart"}},"/api/v2/uploads/workforcemanagement/historicaldata/csv":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in csv format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataCsv","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataCsv"}},"/api/v2/uploads/publicassets/images":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a public asset image","description":"","operationId":"postUploadsPublicassetsImages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["uploads:publicasset:upload"]},"x-purecloud-method-name":"postUploadsPublicassetsImages"}},"/api/v2/uploads/recordings":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a recording file","description":"","operationId":"postUploadsRecordings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:upload"]},"x-purecloud-method-name":"postUploadsRecordings"}},"/api/v2/dataextensions/coretypes/{coretypeName}":{"get":{"tags":["Data Extensions"],"summary":"Get a specific named core type.","description":"","operationId":"getDataextensionsCoretype","produces":["application/json"],"parameters":[{"name":"coretypeName","in":"path","description":"The core type's name","required":true,"type":"string","enum":["text","longtext","url","identifier","enum","date","datetime","integer","number","checkbox","tag"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Coretype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretype"}},"/api/v2/dataextensions/coretypes":{"get":{"tags":["Data Extensions"],"summary":"Get the core types from which all schemas are built.","description":"","operationId":"getDataextensionsCoretypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoretypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretypes"}},"/api/v2/dataextensions/limits":{"get":{"tags":["Data Extensions"],"summary":"Get quantitative limits on schemas","description":"","operationId":"getDataextensionsLimits","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaQuantityLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsLimits"}},"/api/v2/flows/datatables/divisionviews/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatablesDivisionview","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionview"}},"/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an export job","description":"Returns the state information about an export job.","operationId":"getFlowsDatatableExportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"id of export job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableExportJob"}},"/api/v2/flows/datatables/{datatableId}/export/jobs":{"post":{"tags":["Architect"],"summary":"Begin an export process for exporting all rows from a datatable","description":"Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response","operationId":"postFlowsDatatableExportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"postFlowsDatatableExportJobs"}},"/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an import job","description":"Returns the state information about an import job.","operationId":"getFlowsDatatableImportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"id of import job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJob"}},"/api/v2/flows/datatables/{datatableId}/import/jobs":{"get":{"tags":["Architect"],"summary":"Get all recent import jobs","description":"Get all recent import jobs","operationId":"getFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The specified datatableId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJobs"},"post":{"tags":["Architect"],"summary":"Begin an import process for importing rows into a datatable","description":"Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response","operationId":"postFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"body","description":"import job information","required":true,"schema":{"$ref":"#/definitions/DataTableImportJob"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableImportJobs"}},"/api/v2/flows/datatables/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatable"},"put":{"tags":["Architect"],"summary":"Updates a specific datatable by id","description":"Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","operationId":"putFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.cannot.remove.fields":"The updated schema had missing fields from the old schema (can't remove previously existing fields).","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatable"},"delete":{"tags":["Architect"],"summary":"deletes a specific datatable by id","description":"Deletes an entire datatable (including the schema and data) with a given datatableId","operationId":"deleteFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"force","in":"query","description":"force delete, even if in use","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"The datatable was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.possibly.in.use":"This datatable may be in use by a published flow.","flows.datatables.in.use":"This datatable is in use by a published flow."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatable"}},"/api/v2/flows/datatables/divisionviews":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatablesDivisionviews","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:datatable:search"]},"x-purecloud-method-name":"getFlowsDatatablesDivisionviews"}},"/api/v2/flows/datatables":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatables","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.","required":false,"type":"string","x-example":"exactMatch, beginsWith*, *endsWith, *contains*"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatables"},"post":{"tags":["Architect"],"summary":"Create a new datatable with the specified json-schema definition","description":"This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/","operationId":"postFlowsDatatables","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","invalid.division.id":"The division id was invalid.","constraint.validation":"%s","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","flows.datatables.too.many.tables":"The max number of datatables allowed has been reached.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatables"}},"/api/v2/flows/datatables/{datatableId}/rows/{rowId}":{"get":{"tags":["Architect"],"summary":"Returns a specific row for the datatable","description":"Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.","operationId":"getFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"The key for the row","required":true,"type":"string"},{"name":"showbrief","in":"query","description":"if true returns just the key field for the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRow"},"put":{"tags":["Architect"],"summary":"Update a row entry","description":"Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}","operationId":"putFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"},{"in":"body","name":"body","description":"datatable row","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit","architect:datatableRow:edit"]},"x-purecloud-method-name":"putFlowsDatatableRow"},"delete":{"tags":["Architect"],"summary":"Delete a row entry","description":"Deletes a row with a given rowId (the value of the key field).","operationId":"deleteFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"}],"responses":{"204":{"description":"The row was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete","architect:datatableRow:delete"]},"x-purecloud-method-name":"deleteFlowsDatatableRow"}},"/api/v2/flows/datatables/{datatableId}/rows":{"get":{"tags":["Architect"],"summary":"Returns the rows for the datatable with the given id","description":"Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.","operationId":"getFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showbrief","in":"query","description":"If true returns just the key value of the row","required":false,"type":"boolean","default":true},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableRowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view","architect:datatableRow:view"]},"x-purecloud-method-name":"getFlowsDatatableRows"},"post":{"tags":["Architect"],"summary":"Create a new row entry for the datatable.","description":"Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}","operationId":"postFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"dataTableRow","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.too.many.rows":"The max number of datatable rows allowed has been reached.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flows.datatables.syntax.error":"There was an error parsing user data","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add","architect:datatableRow:add"]},"x-purecloud-method-name":"postFlowsDatatableRows"}},"/api/v2/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDate"}},"/api/v2/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putOutboundCampaignAgent","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":true,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.stage":"No stage was provided.","invalid.campaign.status":"The dialer campaign was not active.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-purecloud-method-name":"putOutboundCampaignAgent"}},"/api/v2/outbound/attemptlimits/{attemptLimitsId}":{"get":{"tags":["Outbound"],"summary":"Get attempt limits","description":"","operationId":"getOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimit"},"put":{"tags":["Outbound"],"summary":"Update attempt limits","description":"","operationId":"putOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts allowed per contact is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts allowed per number is 100.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:edit"]},"x-purecloud-method-name":"putOutboundAttemptlimit"},"delete":{"tags":["Outbound"],"summary":"Delete attempt limits","description":"","operationId":"deleteOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:delete"]},"x-purecloud-method-name":"deleteOutboundAttemptlimit"}},"/api/v2/outbound/attemptlimits":{"get":{"tags":["Outbound"],"summary":"Query attempt limits list","description":"","operationId":"getOutboundAttemptlimits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimits"},"post":{"tags":["Outbound"],"summary":"Create attempt limits","description":"","operationId":"postOutboundAttemptlimits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts per contact limit is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","invalid.property":"Value [%s] is not a valid property for object [%s]","exceeded.max.attempts.per.number":"The maximum attempts per number limit is 100.","constraint.validation":"%s","max.entity.count.reached":"The maximum attempt limits count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:add"]},"x-purecloud-method-name":"postOutboundAttemptlimits"}},"/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponseset"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.call.analysis.response.set":"The call analysis response set is invalid.","constraint.validation":"%s","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:edit"]},"x-purecloud-method-name":"putOutboundCallanalysisresponseset"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallanalysisresponseset"}},"/api/v2/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum call analysis response set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:add"]},"x-purecloud-method-name":"postOutboundCallanalysisresponsesets"}},"/api/v2/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimeset"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.time.zone":"Not recognized as a valid time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:edit"]},"x-purecloud-method-name":"putOutboundCallabletimeset"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","callable.time.set.in.use":"The callable time set is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallabletimeset"}},"/api/v2/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getOutboundCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postOutboundCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.time.zone":"There is an unrecognized time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum callable time set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:add"]},"x-purecloud-method-name":"postOutboundCallabletimesets"}},"/api/v2/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign (Deprecated)","description":"This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"","operationId":"postOutboundCampaignCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":true,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.cannot.be.blank":"The contact cannot be blank.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"The contact list cannot be blank.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","schedule.cannot.be.blank":"The schedule cannot be blank.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.schedule.format":"The schedule format is invalid.","callback.schedule.invalid":"The callback schedule is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.scheduling.error":""}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"deprecated":true,"x-purecloud-method-name":"postOutboundCampaignCallbackSchedule"}},"/api/v2/outbound/campaigns/divisionviews/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Campaign information object","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionview"}},"/api/v2/outbound/campaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Campaign information objects","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionviews"}},"/api/v2/outbound/campaigns/{campaignId}/interactions":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign interactions.","description":"","operationId":"getOutboundCampaignInteractions","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignInteractions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The specified campaignId was not found.","resource.not.found":"Resource not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignInteractions"}},"/api/v2/outbound/campaigns/{campaignId}/linedistribution":{"get":{"tags":["Outbound"],"summary":"Get line distribution information for campaigns using same Edge Group or Site as given campaign","description":"","operationId":"getOutboundCampaignLinedistribution","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"includeOnlyActiveCampaigns","in":"query","description":"If true will return only active Campaigns","required":false,"type":"boolean","default":true},{"name":"edgeGroupId","in":"query","description":"Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"siteId","in":"query","description":"Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive.","required":false,"type":"string"},{"name":"useWeight","in":"query","description":"Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations","required":false,"type":"boolean"},{"name":"relativeWeight","in":"query","description":"Relative weight to be used in line distribution calculations instead of current Campaign's relative weight","required":false,"type":"integer","format":"int32"},{"name":"outboundLineCount","in":"query","description":"The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignOutboundLinesDistribution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.campaign.outbound.line.count":"The outbound line count is invalid","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.campaign":"The campaign is invalid","site.has.no.active.edges":"There are no active edges in the site","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","edge.group.not.found":"The edge group could not be found","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","no.edge.group.for.site":"No edge group was found for the site","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:lineDistribution:view"]},"x-purecloud-method-name":"getOutboundCampaignLinedistribution"}},"/api/v2/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"deleteOutboundCampaignProgress"}},"/api/v2/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaign"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.update":"","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","resources.in.use":"Resources are already in use.","cannot.update.dynamic.contact.queueing.settings":"The dynamic contact queueing settings cannot be updated","invalid.update.bad.status.transition":"The status transition is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","agent.owned.column.cannot.be.changed":"The agent owned column cannot be changed.","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","invalid.update.campaign.active":"The campaign is already active","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","agent.owned.queue.cannot.be.changed":"The queue cannot be changed on a campaign configured for agent owned records.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.ani.address":"The caller id number is invalid.","name.required":"A name must be provided.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"Invalid dialing mode","site.is.empty":"There are no edges in the site","contact.list.import.in.progress":"The contact list on the camapign is still importing contacts."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","all.campaigns.black.listed":"This organization has been blacklisted from starting campaigns. Please contact support.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","campaign.black.listed":"This campaign has been blacklisted. Please contact support."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.campaign.active":"The campaign is already active.","too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"putOutboundCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","campaign.in.use":"The campaign is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundCampaign"}},"/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results":{"get":{"tags":["Outbound"],"summary":"Get a preview of how agents will be mapped to this campaign's contact list.","description":"","operationId":"getOutboundCampaignAgentownedmappingpreviewResults","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentOwnedMappingPreviewListing"}},"202":{"description":"The preview is not yet ready"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.is.not.agent.owned":"This campaign is not configured for agent-owned records.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The preview does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","routing:queue:view"]},"x-purecloud-method-name":"getOutboundCampaignAgentownedmappingpreviewResults"}},"/api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview":{"post":{"tags":["Outbound"],"summary":"Initiate request for a preview of how agents will be mapped to this campaign's contact list.","description":"","operationId":"postOutboundCampaignAgentownedmappingpreview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.is.not.agent.owned":"This campaign is not configured for agent-owned records.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:view","outbound:contact:view","directory:user:view"]},"x-purecloud-method-name":"postOutboundCampaignAgentownedmappingpreview"}},"/api/v2/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getOutboundCampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignDiagnostics"}},"/api/v2/outbound/campaignrules/{campaignRuleId}":{"get":{"tags":["Outbound"],"summary":"Get Campaign Rule","description":"","operationId":"getOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrule"},"put":{"tags":["Outbound"],"summary":"Update Campaign Rule","description":"","operationId":"putOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"Campaign rule must have an action entity.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","cannot.modify.enabled.campaign.rule":"Cannot modify a rule that is enabled.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:edit"]},"x-purecloud-method-name":"putOutboundCampaignrule"},"delete":{"tags":["Outbound"],"summary":"Delete Campaign Rule","description":"","operationId":"deleteOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","cannot.delete.enabled.campaign.rule":"Cannot delete a rule that is enabled."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:delete"]},"x-purecloud-method-name":"deleteOutboundCampaignrule"}},"/api/v2/outbound/campaignrules":{"get":{"tags":["Outbound"],"summary":"Query Campaign Rule list","description":"","operationId":"getOutboundCampaignrules","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRuleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrules"},"post":{"tags":["Outbound"],"summary":"Create Campaign Rule","description":"","operationId":"postOutboundCampaignrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","cannot.create.enabled.campaign.rule":"Cannot create a rule that is enabled.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","constraint.validation":"%s","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","invalid.turn.on.campaign.action":"Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"At least one rule action entity is required.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","max.entity.count.reached":"The maximum campaign rule count has been reached.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.dialing.mode.update":"Invalid dialing mode specified.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:add"]},"x-purecloud-method-name":"postOutboundCampaignrules"}},"/api/v2/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaign"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":true,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesCampaign"}},"/api/v2/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getOutboundSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaigns"}},"/api/v2/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getOutboundCampaignStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignStats"}},"/api/v2/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postOutboundCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"postOutboundCampaignsProgress"}},"/api/v2/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getOutboundCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListIds","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 campaigns can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postOutboundCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","invalid.max.calls.per.agent":"Max calls per agent must be inside allowed range","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.agent.owned.dialing.mode":"Agent owned records are only available for the Preview dialing mode.","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"Property is not allowed for external calling","max.entity.count.reached":"The maximum campaign count has been reached.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","dynamic.contact.queueing.settings.cannot.be.set.for.agent.owned.campaigns":"Dynamic contact queueing cannot be enabled for agent owned campaigns","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","invalid.create":"","missing.caller.id.name":"No caller id name supplied","invalid.campaign.skill.column.data.type.specifications.max.length.limit.exceeded":"The column data type specification length value exceeds the max length allowed for a skill column","constraint.validation":"%s","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","invalid.acw.queue.setting":"Please change the After Call Work setting on the queue as Agent Requested is not valid","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","invalid.relative.weight":"Relative weight must be between values 0 and 100 inclusively","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","invalid.property":"Value [%s] is not a valid property for object [%s]","edge.group.has.no.active.edges":"There are no active edges in the edge group","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","invalid.ani.address":"The caller id number is invalid.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","invalid.campaign.skill.column.data.type":"The column data type specification that is selected as a skill column must be of Data Type text.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"A campaign may not be updated to or from external dialing mode to any other dialing mode.","site.is.empty":"There are no edges in the site"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.skill.queue.members":"The limit for number of queue members on a campaign configured for skill records has been exceeded. See details."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:add"]},"x-purecloud-method-name":"postOutboundCampaigns"}},"/api/v2/outbound/campaigns/all/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns","description":"","operationId":"getOutboundCampaignsAllDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:search","outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsAllDivisionviews"}},"/api/v2/outbound/campaigns/all":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns by division","description":"","operationId":"getOutboundCampaignsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["email","sms","voice"]},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.filter.field":"Invalid query parameter supplied for filtering.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view","outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundCampaignsAll"}},"/api/v2/outbound/contactlists/divisionviews/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic ContactList information object","description":"This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contactlist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionview"}},"/api/v2/outbound/contactlists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified contact list objects.","description":"This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionviews"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","no.available.list.export.uri":"There is no available download URI for contact list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Export information to get","required":false,"schema":{"$ref":"#/definitions/ContactsExportRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.export.in.progress":"An export is already in progress for this contact list.","internal.error":"An internal service error occurred.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.contact.list.filter":"The contact list filter provided is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","contact.list.import.in.progress":"The contact list cannot be exported while it is being imported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"postOutboundContactlistExport"}},"/api/v2/outbound/contactlistfilters/preview":{"post":{"tags":["Outbound"],"summary":"Get a preview of the output of a contact list filter","description":"","operationId":"postOutboundContactlistfiltersPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FilterPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersPreview"}},"/api/v2/outbound/contactlistfilters/{contactListFilterId}":{"get":{"tags":["Outbound"],"summary":"Get Contact list filter","description":"","operationId":"getOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilter"},"put":{"tags":["Outbound"],"summary":"Update Contact List Filter","description":"","operationId":"putOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not update the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","filter.modification.in.progress":"Could not update the contact list filter because filter modification is in progress.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","cannot.edit.contact.list.filter.source.type":"Could not update the contact list filter because the source type can not be edited.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not update the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not update the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not update the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.predicates.exceeded":"Could not update the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not update the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:edit"]},"x-purecloud-method-name":"putOutboundContactlistfilter"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Filter","description":"","operationId":"deleteOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list filter deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistfilter"}},"/api/v2/outbound/contactlistfilters/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Retrieve multiple contact list filters","description":"","operationId":"postOutboundContactlistfiltersBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The contact list filters to retrieve","required":true,"schema":{"$ref":"#/definitions/ContactListFilterBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No body with contact list filter ids was provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersBulkRetrieve"}},"/api/v2/outbound/contactlistfilters":{"get":{"tags":["Outbound"],"summary":"Query Contact list filters","description":"","operationId":"getOutboundContactlistfilters","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilters"},"post":{"tags":["Outbound"],"summary":"Create Contact List Filter","description":"","operationId":"postOutboundContactlistfilters","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not create the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","constraint.validation":"%s","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","contact.list.template.not.found":"Could not create the contact list filter because the contact list template could not be found.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.cannot.be.blank":"Could not create the contact list filter because the contact list field was blank when source type is ContactList.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","invalid.contact.list.filter.source.type":"Could not create the contact list filter because the source type is invalid.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.entity.count.reached":"The maximum contact list filter count has been reached.","max.predicates.exceeded":"Could not create the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.template.required":"Could not create the contact list filter because the contact list template field was blank when source type is ContactListTemplate.","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:add"]},"x-purecloud-method-name":"postOutboundContactlistfilters"}},"/api/v2/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getOutboundContactlistImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistImportstatus"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","description":"","operationId":"getOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlist"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain one or more of the specified phone number columns","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns can not be updated.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns can not be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain one or more of the specified email addresses columns","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns are not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names can not be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:edit"]},"x-purecloud-method-name":"putOutboundContactlist"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","internal.error":"An internal server error occurred.","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","contact.list.import.in.progress":"The contact list import is in progress.","contact.list.in.use":"The contact list is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlist"}},"/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview":{"get":{"tags":["Outbound"],"summary":"Preview the result of applying Automatic Time Zone Mapping to a contact list","description":"","operationId":"getOutboundContactlistTimezonemappingpreview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneMappingPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.automatic.time.zone.mapping":"This contact list is not set up for Automatic Time Zone Mapping","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The contact list could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistTimezonemappingpreview"}},"/api/v2/outbound/contactlisttemplates/{contactListTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Contact List Template","description":"","operationId":"getOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplate"},"put":{"tags":["Outbound"],"summary":"Update a contact list template.","description":"","operationId":"putOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","invalid.contact.email.column":"At least one email column is required, and all email columns must have a columnName and type.","invalid.update":"","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid","cannot.update.email.columns":"The email columns cannot be updated.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","contact.list.template.email.columns.not.supported":"Contact list template email columns are not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns cannot be updated.","invalid.contact.phone.column":"At least one phone column is required, and all phone columns must have a columnName and type.","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.update.column.data.type.specifications":"The column data type specifications cannot be updated.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required.","cannot.update.contact.column.names":"The contact column names cannot be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:edit"]},"x-purecloud-method-name":"putOutboundContactlisttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Template","description":"","operationId":"deleteOutboundContactlisttemplate","produces":["application/json"],"parameters":[{"name":"contactListTemplateId","in":"path","description":"ContactListTemplate ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplate"}},"/api/v2/outbound/contactlisttemplates":{"get":{"tags":["Outbound"],"summary":"Query a list of contact list templates","description":"","operationId":"getOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"getOutboundContactlisttemplates"},"post":{"tags":["Outbound"],"summary":"Create Contact List Template","description":"","operationId":"postOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListTemplate","required":true,"schema":{"$ref":"#/definitions/ContactListTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.column.data.type.specification.in.contact.list.template":"Column data type specifications must be provided for all columns","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","constraint.validation":"%s","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.list.template.email.columns.not.supported":"Contact list template email columns not supported.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.zip.code.column":"The zip code column must be a column of the contact list template and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","contact.list.template.both.phone.email.column.empty":"Contact list template phone and email columns are empty.","max.entity.count.reached":"The maximum contact list template count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list template column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact list templates.","description":"","operationId":"deleteOutboundContactlisttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact list templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact list templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundContactlisttemplates"}},"/api/v2/outbound/contactlisttemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ContactListTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contact.list.templates.added":"The number of contact list templates being added exceeds the limit","bad.request":"No contact list templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:add"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkAdd"}},"/api/v2/outbound/contactlisttemplates/bulk/retrieve":{"post":{"tags":["Outbound"],"summary":"Get multiple contact list templates","description":"","operationId":"postOutboundContactlisttemplatesBulkRetrieve","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"contact list templates to get","required":true,"schema":{"$ref":"#/definitions/ContactListTemplateBulkRetrieveBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"No contact list template ids were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListTemplate:view"]},"x-purecloud-method-name":"postOutboundContactlisttemplatesBulkRetrieve"}},"/api/v2/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getOutboundContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postOutboundContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"The contact columns do not contain phone number column","no.phone.columns":"No phone columns provided","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","not.unique.email.columns":"Email Columns contain duplicate values.","missing.column.data.type.specification.max":"The numeric column data type specifications max value is required.","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be provided for all columns","division.not.found":"The division could not be found.","no.contact.columns.defined":"There are no contact columns defined.","constraint.validation":"%s","contact.list.both.phone.email.column.empty":"Contact list phone and email columns are empty.","invalid.contact.email.column":"The contact email columns are invalid.","invalid.column.data.type.specifications.max.length.values":"The text column data type specifications max length value is invalid.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","missing.column.data.type.specification.min":"The numeric column data type specifications min value is required.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","contact.columns.do.not.contain.email.column":"The contact columns do not contain email column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.columns.limit.exceeded":"Number of email columns must not exceed the limit.","contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","column.data.type.specifications.summed.maxlength.exceeds.maximum.allowed":"The sum of maxlength for all column data type specifications text columns exceeds the maximum allowed.","invalid.column.data.type.specifications.max.values":"The numeric column data type specifications max value is invalid.","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","invalid.property":"Value [%s] is not a valid property for object [%s]","no.email.columns":"No email columns provided","max.entity.count.reached":"The maximum contact list count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","column.data.type.specification.column.name.not.found":"Column data type specification column name is not a valid contact list column","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.data.value":"The contact data values are invalid.","invalid.column.data.type.specifications.min.values":"The numeric column data type specifications min value is invalid.","contact.list.email.columns.not.supported":"Contact list email columns not supported.","missing.column.data.type.specification.max.length":"The numeric column data type specifications max length value is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:add"]},"x-purecloud-method-name":"postOutboundContactlists"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact lists.","description":"","operationId":"deleteOutboundContactlists","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact lists accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact lists in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested contact lists could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlists"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get a contact.","description":"","operationId":"getOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"getOutboundContactlistContact"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"$ref":"#/definitions/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.missing.columns":"The contact is missing columns from its contact list.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.does.not.exist":"The contact does not exist.","constraint.validation":"%s","invalid.update":"An attempt was made to update a contact in an invalid way","invalid.contact.id":"An attempt was made to update a contact with an invalid contact ID","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"putOutboundContactlistContact"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.in.use":"The contact cannot be deleted because it is currently in use.","invalid.delete":"An attempt was made to delete a contact in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","contact.not.found":"The contact could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContact"}},"/api/v2/outbound/contactlists/{contactListId}/clear":{"post":{"tags":["Outbound"],"summary":"Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.","description":"","operationId":"postOutboundContactlistClear","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contacts will be deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.is.on.running.campaign":"The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","contact.list.import.in.progress":"The contacts cannot be removed from a contactlist that is currently in progress of an import.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistClear"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk":{"post":{"tags":["Outbound"],"summary":"Get contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsBulk","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactIds to get.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.requested":"Only 50 contacts can be retrieved at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulk"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove":{"post":{"tags":["Outbound"],"summary":"Start an async job to delete contacts using a filter.","description":"","operationId":"postOutboundContactlistContactsBulkRemove","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact filter information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkSearchParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts deletion has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkRemove"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update":{"post":{"tags":["Outbound"],"summary":"Start an async job to bulk edit contacts.","description":"","operationId":"postOutboundContactlistContactsBulkUpdate","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact bulk edit request information.","required":true,"schema":{"$ref":"#/definitions/ContactBulkEditRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"202":{"description":"Contacts edit has been started on the Contact List.","schema":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","contact.bulk.operation.in.progress":"There is already a bulk operation in progress for this contact list.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulkUpdate"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/search":{"post":{"tags":["Outbound"],"summary":"Query contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsSearch","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact search parameters.","required":true,"schema":{"$ref":"#/definitions/ContactListingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.contact.list.filter":"The contact list filter provided is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsSearch"}},"/api/v2/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableDialerContact"}}},{"name":"priority","in":"query","description":"Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.","required":false,"type":"boolean"},{"name":"clearSystemData","in":"query","description":"Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.","required":false,"type":"boolean"},{"name":"doNotQueue","in":"query","description":"Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"Too many contacts added, the limit is 1000 per request","uploads.black.listed":"This organization has been prohibited from uploading contacts. Please contact support.","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.columns":"The contact columns are invalid.","contact.list.clear.in.progress":"The contact list is currently being cleared.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create contacts in an invalid way","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"An attempt was made to update contacts in an invalid way","invalid.contact.id":"The custom contactId field is not valid. It cannot contain special characters.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.missing.data":"The data field is required.","contact.id.length.limit.exceeded":"The length of a contact id must not exceed the limit.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contacts.per.org.limit.exceeded":"The organization has reached the limit on total contacts","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal service error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:add"]},"x-purecloud-method-name":"postOutboundContactlistContacts"},"delete":{"tags":["Outbound"],"summary":"Delete contacts from a contact list.","description":"","operationId":"deleteOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactIds","in":"query","description":"ContactIds to delete.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Contacts Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"There were too many contacts in the request, the limit is 250","invalid.contact.id":"One or more of the contacts was invalidly formed with non UTF-8 characters.","invalid.delete":"An attempt was made to delete contacts in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","no.contacts.specified":"There were no contacts specified in the request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContacts"}},"/api/v2/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer. (Deprecated)","description":"This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use \"/api/v2/audits/query\" instead.","operationId":"postOutboundAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":true,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:audit:view"]},"x-purecloud-method-name":"postOutboundAudits"}},"/api/v2/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postOutboundConversationDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundConversationDnc"}},"/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns":{"delete":{"tags":["Outbound"],"summary":"Deletes all or expired custom exclusion column entries from a DNC list.","description":"This operation is only for Internal DNC lists of custom exclusion column entries","operationId":"deleteOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC custom exclusion column entries deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"Custom exclusion column entries cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal custom","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistCustomexclusioncolumns"},"patch":{"tags":["Outbound"],"summary":"Add entries to or delete entries from a DNC list.","description":"Only Internal DNC lists may be deleted from","operationId":"patchOutboundDnclistCustomexclusioncolumns","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Custom exclusion column entries","required":true,"schema":{"$ref":"#/definitions/DncPatchCustomExclusionColumnsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add to or delete from a DNC list that is not of type Rds-custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Custom exclusion column entries must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add to or delete from a DNC list that is not of Contact Method Any","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC entries. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistCustomexclusioncolumns"}},"/api/v2/outbound/dnclists/divisionviews/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic DncList information object","description":"This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionview","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"Dnclist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionview"}},"/api/v2/outbound/dnclists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified dnc list objects.","description":"This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 dnc lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionviews"}},"/api/v2/outbound/dnclists/{dncListId}/emailaddresses":{"post":{"tags":["Outbound"],"summary":"Add email addresses to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC email addresses","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"Accepted - Adding email addresses"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append emails to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistEmailaddresses"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired email addresses from a DNC list.","description":"This operation is Only for Internal DNC lists of email addresses","operationId":"deleteOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC email addresses deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The email addresses cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete emails from a DNC list that is not of Contact Method Email"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistEmailaddresses"},"patch":{"tags":["Outbound"],"summary":"Add emails to or Delete emails from a DNC list.","description":"Only Internal DNC lists may be added to or deleted from","operationId":"patchOutboundDnclistEmailaddresses","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Emails","required":true,"schema":{"$ref":"#/definitions/DncPatchEmailsRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add emails addresses to or delete email addresses from a DNC list that is not of type rds_custom\"","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Email addresses must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add emails to or delete emails from a DNC list that is not of Contact Method Email","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistEmailaddresses"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","no.available.list.export.uri":"There is no available download URI for the dnc list at this time.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The dnc list cannot be exported while it is being imported.","unexportable.dnc.list.type":"Only internal dnc lists can be exported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.export.in.progress":"An export is already in progress for this dnc list.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dnc list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"postOutboundDnclistExport"}},"/api/v2/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getOutboundDnclistImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistImportstatus"}},"/api/v2/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"expirationDateTime","in":"query","description":"Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format","required":false,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append numbers to a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The date was invalid.","constraint.validation":"%s","dnc.phone.numbers.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.phone.numbers.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistPhonenumbers"},"delete":{"tags":["Outbound"],"summary":"Deletes all or expired phone numbers from a DNC list.","description":"This operation is Only for Internal DNC lists of phone numbers","operationId":"deleteOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"expiredOnly","in":"query","description":"Set to true to only remove DNC entries that are expired","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"DNC phone numbers deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The phone numbers cannot be removed from a dnclist while it is being imported.","dnc.source.operation.not.supported":"An attempt was made to clear a DNC list that is not of type Internal","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dnc.list.invalid.contact.method":"An attempt was made to delete numbers from a DNC list that is not of Contact Method Phone"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:delete"]},"x-purecloud-method-name":"deleteOutboundDnclistPhonenumbers"},"patch":{"tags":["Outbound"],"summary":"Add numbers to or delete numbers from a DNC list.","description":"Only Internal DNC lists may be added to deleted from","operationId":"patchOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"$ref":"#/definitions/DncPatchPhoneNumbersRequest"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of type rds_custom","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.records.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","invalid.date.value":"The expiration date provided is invalid. It must be a UTC time in a format such as yyyy-MM-ddTHH:mmZ","constraint.validation":"%s","invalid.dnc.patch.request":"Phone numbers must be provided in the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.dnc.patch.action":"An action must be provided in the request","dnc.list.invalid.contact.method":"An attempt was made to add numbers to or delete numbers from a DNC list that is not of Contact Method Phone","dnc.records.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.delete.entries.max.per.request.exceeded":"There were too many entries in the request, the limit is 250"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The DNC list could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"DNC list delete all or expired entries feature not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:edit"]},"x-purecloud-method-name":"patchOutboundDnclistPhonenumbers"}},"/api/v2/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclist"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","cannot.update.dnc.list.type":"The Dnc source cannot be updated.","cannot.update.custom.exclusion.column":"The dnc custom exclusion column cannot be updated.","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","invalid.update":"","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:edit"]},"x-purecloud-method-name":"putOutboundDnclist"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.in.use":"The dialer DNC list is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:delete"]},"x-purecloud-method-name":"deleteOutboundDnclist"}},"/api/v2/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getOutboundDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","rds_custom","dnc.com","gryphon"]},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postOutboundDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncListCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","dnc.list.missing.custom.exclusion.column":"A custom exclusion column must be provided for this list type.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","dnc.source.configuration.invalid.campaign.id":"The DNCScrub Campaign Id in dnc source configuration is invalid","invalid.property":"Value [%s] is not a valid property for object [%s]","dnc.list.phone.columns.empty":"","dnc.records.per.list.limit.exceeded":"The dnc records per list exceeded the limit.","constraint.validation":"%s","max.entity.count.reached":"The maximum dnc list count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.region.not.supported":"The dnc source is not supported in the region","dnc.source.server.error":"External dnc source returned an error condition","dnc.records.per.organization.limit.exceeded":"The dnc records per organization exceeded the limit.","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:add"]},"x-purecloud-method-name":"postOutboundDnclists"}},"/api/v2/outbound/events/{eventId}":{"get":{"tags":["Outbound"],"summary":"Get Dialer Event","description":"","operationId":"getOutboundEvent","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Log ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventLog"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvent"}},"/api/v2/outbound/events":{"get":{"tags":["Outbound"],"summary":"Query Event Logs","description":"","operationId":"getOutboundEvents","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"category","in":"query","description":"Category","required":false,"type":"string"},{"name":"level","in":"query","description":"Level","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvents"}},"/api/v2/outbound/filespecificationtemplates/bulk":{"delete":{"tags":["Outbound"],"summary":"Delete multiple file specification templates.","description":"","operationId":"deleteOutboundFilespecificationtemplatesBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"File Specification template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"File specification templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many file specification templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested file specification templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplatesBulk"}},"/api/v2/outbound/filespecificationtemplates":{"get":{"tags":["Outbound"],"summary":"Query File Specification Templates","description":"","operationId":"getOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplates"},"post":{"tags":["Outbound"],"summary":"Create File Specification Template","description":"","operationId":"postOutboundFilespecificationtemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:add"]},"x-purecloud-method-name":"postOutboundFilespecificationtemplates"}},"/api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get File Specification Template","description":"","operationId":"getOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:view"]},"x-purecloud-method-name":"getOutboundFilespecificationtemplate"},"put":{"tags":["Outbound"],"summary":"Update File Specification Template","description":"","operationId":"putOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"fileSpecificationTemplate","required":true,"schema":{"$ref":"#/definitions/FileSpecificationTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FileSpecificationTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","column.length.out.of.bounds":"Column length is out of bounds","name.length.exceeded":"The name length exceeds the limit of 64 characters.","invalid.find.pattern":"\"find\" is not valid Java Regular Expression","bad.request":"The request could not be understood by the server due to malformed syntax.","skipped.lines.out.of.bounds":"Provided number of lines to be skipped is out of bounds","column.start.position.out.of.bounds":"Column startPosition is out of bounds","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","find.value.out.of.bounds":"\"find\" is out of bounds","replace.value.out.of.bounds":"\"replaceWith\" is out of bounds","missing.column.name":"Column name is required","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.column.information":"FixedLength format and Delimited format without header must have information about columns","invalid.delimiter.value":"When using Custom delimiter, the delimiterValue must be single character string","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.preprocessing.rules":"Too many pre-processing rules"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:edit"]},"x-purecloud-method-name":"putOutboundFilespecificationtemplate"},"delete":{"tags":["Outbound"],"summary":"Delete File Specification Template","description":"","operationId":"deleteOutboundFilespecificationtemplate","produces":["application/json"],"parameters":[{"name":"fileSpecificationTemplateId","in":"path","description":"File Specification Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"File Specification template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:fileSpecificationTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundFilespecificationtemplate"}},"/api/v2/outbound/importtemplates/{importTemplateId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get the import status for an import template.","description":"","operationId":"getOutboundImporttemplateImportstatus","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"importTemplateId","required":true,"type":"string"},{"name":"listNamePrefix","in":"query","description":"listNamePrefix","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplateImportstatus"}},"/api/v2/outbound/importtemplates/{importTemplateId}":{"get":{"tags":["Outbound"],"summary":"Get Import Template","description":"","operationId":"getOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplate"},"put":{"tags":["Outbound"],"summary":"Update Import Template","description":"","operationId":"putOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"},{"in":"body","name":"body","description":"importTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:edit"]},"x-purecloud-method-name":"putOutboundImporttemplate"},"delete":{"tags":["Outbound"],"summary":"Delete Import Template","description":"","operationId":"deleteOutboundImporttemplate","produces":["application/json"],"parameters":[{"name":"importTemplateId","in":"path","description":"Import Template ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import template deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","import.template.in.use":"The import template is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplate"}},"/api/v2/outbound/importtemplates":{"get":{"tags":["Outbound"],"summary":"Query Import Templates","description":"","operationId":"getOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"contactListTemplateId","in":"query","description":"Contact List Template ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:view"]},"x-purecloud-method-name":"getOutboundImporttemplates"},"post":{"tags":["Outbound"],"summary":"Create Import Template","description":"","operationId":"postOutboundImporttemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ImportTemplate","required":true,"schema":{"$ref":"#/definitions/ImportTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","contact.list.template.not.found":"Could not update the import template because the contact list template could not be found.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","criteria.value.cannot.be.blank":"Criteria value must be provided.","constraint.validation":"%s","invalid.contact.list.filter":"Could not update the import template because the contact list filter is not valid.","max.entity.count.reached":"The maximum import template count has been reached.","invalid.criteria.value":"Could not update the import template because the criteria value is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","contact.list.template.required":"A contact list template id must be provided.","spllitting.information.cannot.be.blank":"The splitting information must be provided when useSplittingCriteria is true.","criteria.value.is.out.of.bounds":"Criteria value is out of bounds.","invalid.list.name.format":"List name format is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"Could not update the import template because the contact list filter could not be found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"duplicate.name":"The name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplates"},"delete":{"tags":["Outbound"],"summary":"Delete multiple import templates.","description":"","operationId":"deleteOutboundImporttemplates","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"import template id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Import templates accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many import templates in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.import.template":"Not all the requested import templates could be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:delete"]},"x-purecloud-method-name":"deleteOutboundImporttemplates"}},"/api/v2/outbound/importtemplates/bulk/add":{"post":{"tags":["Outbound"],"summary":"Add multiple import templates","description":"","operationId":"postOutboundImporttemplatesBulkAdd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"import template(s) to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ImportTemplate"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportTemplateEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.import.templates.added":"The number of import templates being added exceeds the limit","bad.request":"No import templates were provided in request.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:importTemplate:add"]},"x-purecloud-method-name":"postOutboundImporttemplatesBulkAdd"}},"/api/v2/outbound/messagingcampaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of messaging campaigns","description":"","operationId":"postOutboundMessagingcampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"postOutboundMessagingcampaignsProgress"}},"/api/v2/outbound/settings":{"get":{"tags":["Outbound"],"summary":"Get the outbound settings for this organization","description":"","operationId":"getOutboundSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:view"]},"x-purecloud-method-name":"getOutboundSettings"},"patch":{"tags":["Outbound"],"summary":"Update the outbound settings for this organization","description":"","operationId":"patchOutboundSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outboundSettings","required":true,"schema":{"$ref":"#/definitions/OutboundSettings"}}],"responses":{"204":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.callable.window.stop.time":"Latest callable time must not be later than 21:00","invalid.country.code":"Invalid country country provided for atzm supportedCountries","invalid.callable.window":"Earliest callable time must be before Latest callable time and only one callable time window is allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.max.calls.per.agent":"Max calls per agent must be between values 1 and 15.","missing.time.zone":"Time zone must be provided for unmapped call window","invalid.time.zone":"Invalid time zone for unmapped call window","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.abandon.seconds":"Abandon seconds must be between 1 and 300.","constraint.validation":"%s","invalid.callable.window.start.time":"Earliest callable time must not be earlier than 08:00","invalid.update":"An attempt was made to update the outbound settings in an invalid way","invalid.max.line.utilization":"Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"outbound settings version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:edit"]},"x-purecloud-method-name":"patchOutboundSettings"}},"/api/v2/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRuleset"},"put":{"tags":["Outbound"],"summary":"Update a Rule Set.","description":"","operationId":"putOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","invalid.update":"","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:edit"]},"x-purecloud-method-name":"putOutboundRuleset"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule Set.","description":"","operationId":"deleteOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:delete"]},"x-purecloud-method-name":"deleteOutboundRuleset"}},"/api/v2/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getOutboundRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Rule Set.","description":"","operationId":"postOutboundRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.rule.condition":"","invalid.property":"Value [%s] is not a valid property for object [%s]","data.action.not.found":"The requested data action could not be found","constraint.validation":"%s","max.entity.count.reached":"The maximum rule set count has been reached.","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:add"]},"x-purecloud-method-name":"postOutboundRulesets"}},"/api/v2/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequence"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","campaign.sequence.cannot.change.both.status.and.campaigns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","invalid.property":"Value [%s] is not a valid property for object [%s]","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","constraint.validation":"%s","invalid.update":"","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.update.bad.status.transition":"The status transition is invalid and failed to update.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:edit"]},"x-purecloud-method-name":"putOutboundSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.in.use":"The campaign sequence is already in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:delete"]},"x-purecloud-method-name":"deleteOutboundSequence"}},"/api/v2/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequence"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":true,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"The sequence schedule version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesSequence"}},"/api/v2/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getOutboundSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequences"}},"/api/v2/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getOutboundSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postOutboundSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.create":"","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing a campaign.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","max.entity.count.reached":"The maximum campaign sequence count has been reached.","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:add"]},"x-purecloud-method-name":"postOutboundSequences"}},"/api/v2/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getOutboundWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:view"]},"x-purecloud-method-name":"getOutboundWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putOutboundWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":true,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a wrap up code mapping in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"Wrap up code mapping version does not match expected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:edit"]},"x-purecloud-method-name":"putOutboundWrapupcodemappings"}},"/api/v2/outbound/digitalrulesets/{digitalRuleSetId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Digital Rule Set","description":"","operationId":"getOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalruleset"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Digital Rule Set","description":"","operationId":"putOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.update":"An attempt was made to update a digital rule set in an invalid way. See details","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected digital rule set version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:edit"]},"x-purecloud-method-name":"putOutboundDigitalruleset"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Digital Rule Set","description":"","operationId":"deleteOutboundDigitalruleset","produces":["application/json"],"parameters":[{"name":"digitalRuleSetId","in":"path","description":"The Digital Rule Set ID","required":true,"type":"string"}],"responses":{"204":{"description":"Digital Rule Set Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a digital rule set in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:delete"]},"x-purecloud-method-name":"deleteOutboundDigitalruleset"}},"/api/v2/outbound/digitalrulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Outbound Digital Rule Sets","description":"","operationId":"getOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["name"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of digital rule set ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:view"]},"x-purecloud-method-name":"getOutboundDigitalrulesets"},"post":{"tags":["Outbound"],"summary":"Create an Outbound Digital Rule Set","description":"","operationId":"postOutboundDigitalrulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Digital Rule Set","required":true,"schema":{"$ref":"#/definitions/DigitalRuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DigitalRuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"One or more rule actions are invalid","name.length.exceeded":"The name length exceeds the limit of 64 characters","missing.rule.actions":"Each rule must have at least one action configured","too.many.rule.actions":"The number of actions in one or more rules exceeds the limit. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to update a digital rule set in an invalid way. See details","duplicate.name":"The name is in use by another digital rule set","invalid.rule.condition":"One or more rule conditions are invalid","invalid.rule.category":"A category must be provided for each rule","rule.name.length.exceeded":"The name length of a rule exceeds the limit of 64 characters","invalid.rule.name":"A name must be provided for each rule","constraint.validation":"%s","invalid.name":"A name must be provided","too.many.rule.conditions":"The number of conditions in one or more rules exceeds the limit. See details","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions per rule set has been exceeded. See details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","too.many.of.action":"One or more actions exceed the limit for that action. See details","too.many.data.action.conditions.per.ruleset":"The limit for the number of data action conditions per rule set has been exceeded. See details","invalid.rule.order":"An order must be provided for each rule","missing.rule.conditions":"At least one condition must be configured on each rule","rule.set.invalid.contact.list":"The contactListId must be a valid UUID representing a contact list","too.many.rules":"The number of rules exceeds the limit. See details","rule.conflict":"A unique id and unique name must be provided for each rule","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"One or more rule conditions are invalid for the rule's category","invalid.rule.action.category":"One or more rule actions are invalid for the rule's category"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:digitalRuleSet:add"]},"x-purecloud-method-name":"postOutboundDigitalrulesets"}},"/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Messaging Campaign information object","description":"This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionview"}},"/api/v2/outbound/messagingcampaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Messaging Campaign information objects","description":"This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"a","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:search","outbound:emailCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionviews"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Messaging Campaign","description":"","operationId":"getOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Messaging Campaign","description":"","operationId":"putOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","too.many.messages.per.minute.with.data.actions.requested":"The total number of messages per minute for this organization and campaign with data actions would be exceeded by turning this campaign on (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.update":"An attempt was made to update a messaging campaign in an invalid way. See details","cannot.update.campaign.type":"The campaign type cannot be updated to a different type configuration","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","too.many.set.sms.phone.number.actions":"The limit for the number of set sms phone number actions has been exceeded. See details","cannot.update.dynamic.contact.queueing.settings":"Dynamic queueing cannot be changed once it's set","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","simultaneous.field.and.status.update":"A Messaging Campaign cannot have other fields changed in the same update as a status transition","invalid.status.transition":"The campaign status transition is invalid","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html","invalid.dnc.list":"One or more DNC List references are invalid","invalid.division":"A valid division must be provided","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","contact.list.in.use":"The contact list is in use by another messaging campaign","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","missing.contact.list.filter":"A contact list filter must be provided when dynamic filtering is enabled.","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","too.many.messages.per.minute.per.phone.number.requested":"The total number of messages per minute for this organization and phone number would be exceeded by turning this campaign on (see documentation)","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The Content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","another.campaign.starting":"There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The responseType of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.sms.content.template.contentType":"The content type of the content template must be 'text/plain'","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","sms.phone.number.in.use":"The SMS phone number is in use by another messaging campaign","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","too.many.messages.per.minute.requested":"The total number of messages per minute for this organization and campaign type would be exceeded by turning this campaign on (see documentation)","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"User doesn't have authorization to access content template","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [emailConfig, smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected messaging campaign version"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit","outbound:emailCampaign:edit"]},"x-purecloud-method-name":"putOutboundMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Messaging Campaign","description":"","operationId":"deleteOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"204":{"description":"Messaging Campaign Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a messaging campaign in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.running.campaign":"A messaging campaign in status ON or STOPPING cannot be deleted"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:delete","outbound:emailCampaign:delete"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaign"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign's progress","description":"","operationId":"getOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset messaging campaign progress and recycle the messaging campaign","description":"","operationId":"deleteOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Accepted - the messaging campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit","outbound:emailCampaign:edit"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaignProgress"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign diagnostics","description":"","operationId":"getOutboundMessagingcampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignDiagnostics"}},"/api/v2/outbound/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of Messaging Campaigns","description":"","operationId":"getOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["campaignStatus","name","type"]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["EMAIL","SMS"]},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of messaging campaign ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view","outbound:emailCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaigns"},"post":{"tags":["Outbound"],"summary":"Create a Messaging Campaign","description":"","operationId":"postOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.email.columns.in.contactlist":"The contact list must have at least one email column configured when the campaign is configured for email","column.data.type.specification.not.found.for.contact.sort":"A column data type specification must be defined for contact sort column","name.length.exceeded":"The name length exceeds the limit of 64 characters","active.campaigns.with.data.action.conditions.limit.exceeded":"The limit for the maximum number of active messaging campaigns using a data action condition has been exceeded. See details","invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","duplicate.name":"The name is in use by another messaging campaign","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","contact.list.not.found":"The contact list could not be found","email.reply.to.address.domain.not.verified":"The reply-to address domain must have a verification result of 'VERIFIED'","missing.column.data.type.specification.in.contact.list":"Column data type specifications must be defined on the campaign's contact list","invalid.email.reply.to.address.domain":"The reply-to address domain must be provided, and must be a verified inbound domain registered with Genesys Cloud","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","email.reply.to.address.route.not.inbound":"The reply-to address route must have one of queueId or workflowId configured","invalid.name":"A name must be provided","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.sms.content.template.contenttype":"The content type of the content template must be 'text/plain'","missing.email.content.template.subject":"The content template must contain exactly one response text of type subject","invalid.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found","dnc.list.not.found":"One or more dnc lists could not be found","invalid.rule.set":"One or more rule set references are invalid","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","email.from.address.domain.not.found":"The from address domain could not be found","too.many.data.action.conditions.per.campaign":"The limit for the number of data action conditions per campaign has been exceeded. See details","rule.set.not.found":"One or more rule sets could not be found","invalid.email.content.template.body.content.type":"The content type of the content template body must be 'text/plain' or 'text/html'","invalid.dnc.list":"One or more DNC List references are invalid","max.entity.count.reached":"The maximum messaging campaign count has been reached","invalid.division":"A valid division must be provided","email.from.address.domain.not.verified":"The from address domain must have a cname verification result of 'VERIFIED'","sms.phone.number.not.found":"The SMS phone number could not be found","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.dnc.list.contact.method":"One or more dnc lists have an invalid contact method. All lists must have the appropriate contact method for the campaign type. See details","invalid.sms.content.template.content":"The content of the content template is blank","invalid.email.content.template.body.content":"The content of the content template body must not be blank","rule.set.count.exceeded":"The limit for the number of rule sets has been exceeded. See details","email.reply.to.address.route.not.found":"The reply-to address route could not be found","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create an invalid messaging campaign. See details","callable.time.set.not.found":"The callable time set could not be found","invalid.callable.time.set":"The provided callable time set is invalid","callable.time.set.not.allowed.for.email":"A callable time set cannot be included on the campaign when it is configured for email","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for this campaign type (see documentation)","invalid.email.from.address.friendly.name":"The from address friendly name must be a between 1 and 64 characters long","constraint.validation":"%s","invalid.email.reply.to.address.route.pattern":"The reply-to address route must have a pattern configured","dnc.list.invalid.custom.exclusion.column":"The Custom Exclusion Column on one of the chosen DNC lists does not match any of the columns on the chosen Contact List","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.email.content.template.texts":"The content template must contain exactly two response texts","missing.email.content.template.body":"The content template must contain exactly one response text of type body","invalid.email.from.address":"The from address must be provided","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sms.content.template.not.found":"The content template could not be found","contact.list.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","invalid.email.reply.to.address.route":"The reply-to address route must be provided, and must be a route configured on the reply-to address domain","invalid.email.content.template.subject.content.type":"The content type of the content template subject must be 'text/plain'","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","invalid.sms.content.template.responsetype":"The response type of the content template must be 'CampaignSmsTemplate'","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.email.content.template.response.type":"The response type of the content template must be 'CampaignEmailTemplate'","invalid.email.columns":"The email columns must be provided, and all entries must be valid columns on the contact list","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.email.content.template.subject.content":"The content of the content template subject must not be blank","email.content.template.not.found":"The content template could not be found","dynamic.queueing.active.campaigns.count.exceeded":"The limit for active dynamic queueing campaigns has been exceeded","too.many.email.columns":"The limit for number of email columns has been exceeded. See details","too.many.contact.list.filters":"Only one contact list filter is allowed per campaign","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping","invalid.email.from.address.local.part":"The from address local part must be provided, and must be between 1 and 64 characters long","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","sms.content.template.not.authorized":"The user does not have authorization to access the content template","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.email.from.address.domain":"The from address domain must be provided, and must be a verified outbound domain registered with Genesys Cloud","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:add","outbound:emailCampaign:add"]},"x-purecloud-method-name":"postOutboundMessagingcampaigns"}},"/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an email campaign schedule.","description":"","operationId":"getOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaign"},"put":{"tags":["Outbound"],"summary":"Update an email campaign schedule.","description":"","operationId":"putOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EmailCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/EmailCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the email campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the email campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of a schedule must be 'emailcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesEmailcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an email campaign schedule.","description":"","operationId":"deleteOutboundSchedulesEmailcampaign","produces":["application/json"],"parameters":[{"name":"emailCampaignId","in":"path","description":"Email Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The email campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesEmailcampaign"}},"/api/v2/outbound/schedules/emailcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of email campaign schedules.","description":"","operationId":"getOutboundSchedulesEmailcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:emailCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesEmailcampaigns"}},"/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a messaging campaign schedule.","description":"","operationId":"getOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update a new messaging campaign schedule.","description":"","operationId":"putOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaignSchedule","required":true,"schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"The end time of each interval must be after its start time","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create the messaging campaign schedule in an invalid way","recurrences.exceeded.limit":"The number of recurrences exceeds the limit.","invalid.number.of.occurrences":"The number of occurrences is a required field for numbered ranges and cannot exceed the limit.","recurrence.invalid.alteration.start.time":"The alteration start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.end.time":"The end time of an interval must not be in the past","invalid.pattern.type":"The pattern type is a required field and must be a valid pattern type.","recurrence.invalid.end.time":"The end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","constraint.validation":"%s","future.intervals.exceeded.limit":"The number of future intervals on the schedule must not exceed 500","invalid.update":"An attempt was made to update the messaging campaign schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","recurrence.id.duplicate.found":"Duplicate recurrence ID found.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.range.end":"The range end date must be a valid future date, greater than the recurrence start date, and in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.timezone":"The time zone of a schedule must be a valid timezone string like ‘America/New_York’","invalid.pattern.interval":"The interval field is a required field and must be a number between 1 and the limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","overlapping.interval":"Each interval must not overlap with any other interval","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"The start time of an interval must not be in the past","recurrence.invalid.start.time":"The start date must be a valid future date in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.range.type":"The range type is a required field and must be a valid range type.","recurrence.id.not.allowed":"Recurrence ID is not allowed.","recurrence.invalid.alteration.end.time":"The alteration end date must be a valid future date before the start date, in the format \"YYYY-MM-DDThh:mm:ss\"","invalid.associated.resource.type":"The associated resource type of the schedule must be 'messagingcampaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a messaging campaign schedule.","description":"","operationId":"deleteOutboundSchedulesMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesMessagingcampaign"}},"/api/v2/outbound/schedules/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of messaging campaign schedules.","description":"","operationId":"getOutboundSchedulesMessagingcampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaignSchedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesMessagingcampaigns"}},"/api/v2/mobiledevices/{deviceId}":{"get":{"tags":["Mobile Devices"],"summary":"Get device","description":"","operationId":"getMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a device with that deviceId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevice"},"put":{"tags":["Mobile Devices"],"summary":"Update device","description":"","operationId":"putMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Device","required":false,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"putMobiledevice"},"delete":{"tags":["Mobile Devices"],"summary":"Delete device","description":"","operationId":"deleteMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"deleteMobiledevice"}},"/api/v2/mobiledevices":{"get":{"tags":["Mobile Devices"],"summary":"Get a list of all devices.","description":"","operationId":"getMobiledevices","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DirectoryUserDevicesListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevices"},"post":{"tags":["Mobile Devices"],"summary":"Create User device","description":"","operationId":"postMobiledevices","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Device","required":true,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"postMobiledevices"}},"/api/v2/fieldconfig":{"get":{"tags":["Users","Groups","Organization"],"summary":"Fetch field config for an entity type","description":"","operationId":"getFieldconfig","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Field type","required":true,"type":"string","enum":["person","group","org"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FieldConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.entity.type":"The entity type is invalid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getFieldconfig"}},"/api/v2/groups/{groupId}/individuals":{"get":{"tags":["Groups"],"summary":"Get all individuals associated with the group","description":"","operationId":"getGroupIndividuals","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupIndividuals"}},"/api/v2/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members, includes individuals, owners, and dynamically included people","description":"","operationId":"getGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":true,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.resource.not.found":"Group members were not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict updating members."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"deleteGroupMembers"}},"/api/v2/groups/{groupId}/profile":{"get":{"tags":["Groups"],"summary":"Get group profile","description":"This api is deprecated. Use /api/v2/groups instead","operationId":"getGroupProfile","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the group profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getGroupProfile"}},"/api/v2/profiles/groups":{"get":{"tags":["Groups"],"summary":"Get group profile listing","description":"This api is deprecated. Use /api/v2/groups instead.","operationId":"getProfilesGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesGroups"}},"/api/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a group with that groupId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroup"},"put":{"tags":["Groups"],"summary":"Update group","description":"","operationId":"putGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Group","required":false,"schema":{"$ref":"#/definitions/GroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a tab configuration due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict - Unexpected version was provided"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroup"},"delete":{"tags":["Groups"],"summary":"Delete group","description":"","operationId":"deleteGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","group.name.in.use":"This group name is currently in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified group not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroup"}},"/api/v2/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group","required":true,"schema":{"$ref":"#/definitions/GroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add"]},"x-purecloud-method-name":"postGroups"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search groups using the q64 value returned from a previous search","description":"","operationId":"getGroupsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupsSearch"},"post":{"tags":["Groups","Search"],"summary":"Search groups","description":"","operationId":"postGroupsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupsSearch"}},"/api/v2/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})","operationId":"deleteLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteLanguage"}},"/api/v2/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages. (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages)","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language (Deprecated)","description":"This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postLanguages"}},"/api/v2/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Location is not found by given location id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocation"},"delete":{"tags":["Locations"],"summary":"Delete a location","description":"","operationId":"deleteLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"204":{"description":"The location was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to delete a location due to invalid request.","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:delete"]},"x-purecloud-method-name":"deleteLocation"},"patch":{"tags":["Locations"],"summary":"Update a location","description":"","operationId":"patchLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationUpdateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to update a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Unable to update a location due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:edit"]},"x-purecloud-method-name":"patchLocation"}},"/api/v2/locations/{locationId}/sublocations":{"get":{"tags":["Locations"],"summary":"Get sublocations for location ID.","description":"","operationId":"getLocationSublocations","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocationSublocations"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Unable to get a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocations"},"post":{"tags":["Locations"],"summary":"Create a location","description":"","operationId":"postLocations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationCreateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Unable to create a location due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:add"]},"x-purecloud-method-name":"postLocations"}},"/api/v2/locations/search":{"get":{"tags":["Locations","Search"],"summary":"Search locations using the q64 value returned from a previous search","description":"","operationId":"getLocationsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Provides more details about a specified resource","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"getLocationsSearch"},"post":{"tags":["Locations","Search"],"summary":"Search locations","description":"","operationId":"postLocationsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"postLocationsSearch"}},"/api/v2/organizations/features/{featureName}":{"patch":{"tags":["Organization"],"summary":"Update organization","description":"","operationId":"patchOrganizationsFeature","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"Organization feature","required":true,"type":"string","enum":["realtimeCIC","purecloud","hipaa","ucEnabled","pci","purecloudVoice","xmppFederation","chat","informalPhotos","directory","contactCenter","unifiedCommunications","custserv"]},{"in":"body","name":"enabled","description":"New state of feature","required":true,"schema":{"$ref":"#/definitions/FeatureState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationFeatures"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsFeature"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getOrganizationsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsMe"},"put":{"tags":["Organization"],"summary":"Update organization.","description":"","operationId":"putOrganizationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsMe"}},"/api/v2/users/{userId}/favorites":{"get":{"tags":["Users"],"summary":"Deprecated; will be revived with new contract","description":"","operationId":"getUserFavorites","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserFavorites"}},"/api/v2/users/{userId}/adjacents":{"get":{"tags":["Users"],"summary":"Get adjacents","description":"","operationId":"getUserAdjacents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Adjacents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserAdjacents"}},"/api/v2/users/{userId}/superiors":{"get":{"tags":["Users"],"summary":"Get superiors","description":"","operationId":"getUserSuperiors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserSuperiors"}},"/api/v2/users/{userId}/directreports":{"get":{"tags":["Users"],"summary":"Get direct reports","description":"","operationId":"getUserDirectreports","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserDirectreports"}},"/api/v2/languages/translations/builtin":{"get":{"tags":["Languages"],"summary":"Get the builtin translation for a language","description":"","operationId":"getLanguagesTranslationsBuiltin","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the builtin translation to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsBuiltin"}},"/api/v2/languages/translations/organization":{"get":{"tags":["Languages"],"summary":"Get effective translation for an organization by language","description":"","operationId":"getLanguagesTranslationsOrganization","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the translation to retrieve for the organization","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsOrganization"}},"/api/v2/languages/translations":{"get":{"tags":["Languages"],"summary":"Get all available languages for translation","description":"","operationId":"getLanguagesTranslations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTranslations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslations"}},"/api/v2/languages/translations/users/{userId}":{"get":{"tags":["Languages"],"summary":"Get effective language translation for a user","description":"","operationId":"getLanguagesTranslationsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsUser"}},"/api/v2/users/{userId}/profile":{"get":{"tags":["Users"],"summary":"Get user profile","description":"This api has been deprecated. Use api/v2/users instead","operationId":"getUserProfile","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the user profile","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserProfile"}},"/api/v2/profiles/users":{"get":{"tags":["Users"],"summary":"Get a user profile listing","description":"This api is deprecated. User /api/v2/users","operationId":"getProfilesUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jid","in":"query","description":"jid","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesUsers"}},"/api/v2/downloads/{downloadId}":{"get":{"tags":["Downloads"],"summary":"Issues a redirect to a signed secure download URL for specified download","description":"this method will issue a redirect to the url to the content","operationId":"getDownload","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"Download ID","required":true,"type":"string"},{"name":"contentDisposition","in":"query","required":false,"type":"string"},{"name":"issueRedirect","in":"query","required":false,"type":"boolean","default":true},{"name":"redirectToAuth","in":"query","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Access to download is denied.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Redirect URL is not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDownload"}},"/api/v2/employeeperformance/externalmetrics/data":{"post":{"tags":["Gamification"],"summary":"Write External Metric Data","description":"","operationId":"postEmployeeperformanceExternalmetricsData","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Data to be added","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDataWriteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDataWriteResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","employee.performance.external.metric.data.input.validation.error":"There was an error parsing argument","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.data.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","employee.performance.external.metric.data.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricData:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsData"}},"/api/v2/employeeperformance/externalmetrics/definitions/{metricId}":{"get":{"tags":["Gamification"],"summary":"Get an External Metric Definition","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinition"},"delete":{"tags":["Gamification"],"summary":"Delete an External Metric Definition","description":"","operationId":"deleteEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the External Metric Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"The External Metric Definition was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:delete"]},"x-purecloud-method-name":"deleteEmployeeperformanceExternalmetricsDefinition"},"patch":{"tags":["Gamification"],"summary":"Update External Metric Definition","description":"","operationId":"patchEmployeeperformanceExternalmetricsDefinition","produces":["application/json"],"parameters":[{"name":"metricId","in":"path","description":"Specifies the metric definition ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The External Metric Definition parameters to be updated","required":true,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.not.found":"The operation failed because the metric definition was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.state.conflict.error":"The operation failed because the metric definition is in use and cannot be set to false"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:edit"]},"x-purecloud-method-name":"patchEmployeeperformanceExternalmetricsDefinition"}},"/api/v2/employeeperformance/externalmetrics/definitions":{"get":{"tags":["Gamification"],"summary":"Get a list of External Metric Definitions of an organization, sorted by name in ascending order","description":"","operationId":"getEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance","employee-performance:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:view"]},"x-purecloud-method-name":"getEmployeeperformanceExternalmetricsDefinitions"},"post":{"tags":["Gamification"],"summary":"Create External Metric Definition","description":"","operationId":"postEmployeeperformanceExternalmetricsDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The External Metric Definition to be created","required":false,"schema":{"$ref":"#/definitions/ExternalMetricDefinitionCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"201":{"description":"The External Metric Definition was successfully created","schema":{"$ref":"#/definitions/ExternalMetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","employee.performance.external.metric.definition.input.validation.error":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","employee.performance.external.metric.definition.too.many.metric.definitions":"The operation failed as the maximum number of External Metric Definitions has been reached"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.internal.service.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"employee.performance.external.metric.definition.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["employee-performance"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["employeePerformance:externalMetricDefinition:add"]},"x-purecloud-method-name":"postEmployeeperformanceExternalmetricsDefinitions"}},"/api/v2/flows/instances/{instanceId}":{"get":{"tags":["Architect"],"summary":"Start a process (job) to prepare a download of a singular flow execution data instance by Id","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"getFlowsInstance","produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"Instance ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand various details.","required":false,"type":"string","enum":["bots","dataActions"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstance"}},"/api/v2/flows/instances/jobs/{jobId}":{"get":{"tags":["Architect"],"summary":"Get the status and/or results of an asynchronous flow execution data retrieval job","description":"","operationId":"getFlowsInstancesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"getFlowsInstancesJob"}},"/api/v2/flows/instances/jobs":{"post":{"tags":["Architect"],"summary":"Start a process (job) that will prepare a list of execution data IDs for download.","description":"Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.","operationId":"postFlowsInstancesJobs","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["bots","dataActions"]},{"in":"body","name":"body","description":"Requested Flow Ids","required":true,"schema":{"$ref":"#/definitions/ExecutionDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetFlowExecutionDataJobResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:view"]},"x-purecloud-method-name":"postFlowsInstancesJobs"}},"/api/v2/flows/instances/querycapabilities":{"get":{"tags":["Architect"],"summary":"Retrieve a list of capabilities that the org can use to query for execution data","description":"Returns the queryable parameters that can be used to build a query for execution data.","operationId":"getFlowsInstancesQuerycapabilities","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand various query types.","required":false,"type":"string","enum":["flow","action"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowsQueryCriteriaResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"getFlowsInstancesQuerycapabilities"}},"/api/v2/flows/instances/query":{"post":{"tags":["Architect"],"summary":"Query the database of existing flow histories to look for particular flow criteria","description":"Returns a list of matching flow histories up to 200 max.","operationId":"postFlowsInstancesQuery","produces":["application/json"],"parameters":[{"name":"indexOnly","in":"query","description":"indexes only","required":false,"type":"boolean"},{"name":"pageSize","in":"query","description":"number of results to return","required":false,"type":"integer","default":50,"format":"int32"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/CriteriaQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowResultEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowInstance:search"]},"x-purecloud-method-name":"postFlowsInstancesQuery"}},"/api/v2/fax/settings":{"get":{"tags":["Fax"],"summary":"Get organization config for given organization","description":"","operationId":"getFaxSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.status.not.found":"Organization config not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSettings"},"put":{"tags":["Fax"],"summary":"Update/write organization config for given organization","description":"","operationId":"putFaxSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxConfig"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted config is either null or contains a null field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putFaxSettings"}},"/api/v2/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getFaxDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocumentContent"}},"/api/v2/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a document is not permitted by given document id.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocument"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"putFaxDocument"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"deleteFaxDocument"}},"/api/v2/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getFaxDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a list of fax documents is not permitted.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocuments"}},"/api/v2/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getFaxSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSummary"}},"/api/v2/gamification/status":{"get":{"tags":["Gamification"],"summary":"Gamification activation status","description":"","operationId":"getGamificationStatus","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:profile:update","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationStatus"},"put":{"tags":["Gamification"],"summary":"Update gamification activation status","description":"","operationId":"putGamificationStatus","produces":["application/json"],"parameters":[{"in":"body","name":"status","description":"Gamification status","required":true,"schema":{"$ref":"#/definitions/GamificationStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GamificationStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationStatus"}},"/api/v2/gamification/leaderboard/all/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points by division or performance profile","description":"","operationId":"getGamificationLeaderboardAllBestpoints","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAllBestpoints"}},"/api/v2/gamification/leaderboard/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best Points of the requesting user's current performance profile or division","description":"","operationId":"getGamificationLeaderboardBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OverallBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboardBestpoints"}},"/api/v2/gamification/leaderboard/all":{"get":{"tags":["Gamification"],"summary":"Leaderboard by filter type","description":"","operationId":"getGamificationLeaderboardAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division or performance profile Id","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationLeaderboardAll"}},"/api/v2/gamification/leaderboard":{"get":{"tags":["Gamification"],"summary":"Leaderboard of the requesting user's division or performance profile","description":"","operationId":"getGamificationLeaderboard","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"metricId","in":"query","description":"Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Leaderboard"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:leaderboard:view"]},"x-purecloud-method-name":"getGamificationLeaderboard"}},"/api/v2/gamification/metricdefinitions/{metricDefinitionId}":{"get":{"tags":["Gamification"],"summary":"Metric definition by id","description":"","operationId":"getGamificationMetricdefinition","produces":["application/json"],"parameters":[{"name":"metricDefinitionId","in":"path","description":"metric definition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinition"}},"/api/v2/gamification/metricdefinitions":{"get":{"tags":["Gamification"],"summary":"All metric definitions","description":"Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric","operationId":"getGamificationMetricdefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricDefinitionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationMetricdefinitions"}},"/api/v2/gamification/templates/{templateId}":{"get":{"tags":["Gamification"],"summary":"Objective template by id","description":"","operationId":"getGamificationTemplate","produces":["application/json"],"parameters":[{"name":"templateId","in":"path","description":"template id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ObjectiveTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplate"}},"/api/v2/gamification/templates":{"get":{"tags":["Gamification"],"summary":"All objective templates","description":"","operationId":"getGamificationTemplates","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetTemplatesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationTemplates"}},"/api/v2/gamification/profiles/users/{userId}/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for a user","description":"","operationId":"postGamificationProfilesUserQuery","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:agentProfileMembership:view"]},"x-purecloud-method-name":"postGamificationProfilesUserQuery"}},"/api/v2/gamification/profiles/users/me/query":{"post":{"tags":["Gamification"],"summary":"Query performance profiles in date range for the current user","description":"","operationId":"postGamificationProfilesUsersMeQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The date range of work day.","required":true,"schema":{"$ref":"#/definitions/UserProfilesInDateRangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfilesInDateRange"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"postGamificationProfilesUsersMeQuery"}},"/api/v2/gamification/profiles/{profileId}":{"get":{"tags":["Gamification"],"summary":"Performance profile by id","description":"","operationId":"getGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfile"},"put":{"tags":["Gamification"],"summary":"Updates a performance profile","description":"","operationId":"putGamificationProfile","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"in":"body","name":"body","description":"performanceProfile","required":false,"schema":{"$ref":"#/definitions/PerformanceProfile"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfile"}},"/api/v2/gamification/profiles/{profileId}/activate":{"post":{"tags":["Gamification"],"summary":"Activate a performance profile","description":"","operationId":"postGamificationProfileActivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileActivate"}},"/api/v2/gamification/profiles/{profileId}/deactivate":{"post":{"tags":["Gamification"],"summary":"Deactivate a performance profile","description":"","operationId":"postGamificationProfileDeactivate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileDeactivate"}},"/api/v2/gamification/profiles/users/me":{"get":{"tags":["Gamification"],"summary":"Performance profile of the requesting user","description":"","operationId":"getGamificationProfilesUsersMe","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-purecloud-method-name":"getGamificationProfilesUsersMe"}},"/api/v2/gamification/profiles/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Performance profile of a user","description":"","operationId":"getGamificationProfilesUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:scorecard:viewAll","gamification:leaderboard:viewAll"]},"x-purecloud-method-name":"getGamificationProfilesUser"}},"/api/v2/gamification/profiles":{"get":{"tags":["Gamification"],"summary":"All performance profiles","description":"","operationId":"getGamificationProfiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetProfilesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:viewAll","gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationProfiles"},"post":{"tags":["Gamification"],"summary":"Create a new custom performance profile","description":"","operationId":"postGamificationProfiles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"performanceProfile","required":true,"schema":{"$ref":"#/definitions/CreatePerformanceProfile"}},{"name":"copyMetrics","in":"query","description":"Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile.","required":false,"type":"boolean","default":true}],"responses":{"201":{"description":"Performance Profile successfully created","schema":{"$ref":"#/definitions/PerformanceProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfiles"}},"/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link":{"post":{"tags":["Gamification"],"summary":"Creates a linked metric","description":"","operationId":"postGamificationProfileMetricLink","produces":["application/json"],"parameters":[{"name":"sourceProfileId","in":"path","description":"Source Performance Profile Id","required":true,"type":"string"},{"name":"sourceMetricId","in":"path","description":"Source Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"linkedMetric","required":true,"schema":{"$ref":"#/definitions/TargetPerformanceProfile"}}],"responses":{"201":{"description":"Linked Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetricLink"}},"/api/v2/gamification/profiles/{profileId}/metrics/{metricId}":{"get":{"tags":["Gamification"],"summary":"Performance profile gamified metric by id","description":"","operationId":"getGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetric"},"put":{"tags":["Gamification"],"summary":"Updates a metric in performance profile","description":"","operationId":"putGamificationProfileMetric","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"metricId","in":"path","description":"Metric Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"putGamificationProfileMetric"}},"/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails":{"get":{"tags":["Gamification"],"summary":"All metrics for a given performance profile with objective details such as order and maxPoints","description":"","operationId":"getGamificationProfileMetricsObjectivedetails","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetricsObjectivedetails"}},"/api/v2/gamification/profiles/{profileId}/metrics":{"get":{"tags":["Gamification"],"summary":"All gamified metrics for a given performance profile","description":"","operationId":"getGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"},{"name":"workday","in":"query","description":"The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"metricIds","in":"query","description":"List of metric ids to filter the response (Optional, comma-separated).","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetMetricResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view","gamification:leaderboard:view","gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationProfileMetrics"},"post":{"tags":["Gamification"],"summary":"Creates a gamified metric with a given metric definition and metric objective under in a performance profile","description":"","operationId":"postGamificationProfileMetrics","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Performance Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Metric","required":true,"schema":{"$ref":"#/definitions/CreateMetric"}}],"responses":{"201":{"description":"Metric successfully created","schema":{"$ref":"#/definitions/Metric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMetrics"}},"/api/v2/gamification/insights/users/{userId}/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the user","description":"","operationId":"getGamificationInsightsUserDetails","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserDetails"}},"/api/v2/gamification/insights/details":{"get":{"tags":["Gamification"],"summary":"Get insights details for the current user","description":"","operationId":"getGamificationInsightsDetails","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"The number of agent to rank over limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsDetails"}},"/api/v2/gamification/insights/members":{"get":{"tags":["Gamification"],"summary":"Query users in a profile during a period of time","description":"","operationId":"getGamificationInsightsMembers","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"startWorkday","in":"query","description":"The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsAgents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsMembers"}},"/api/v2/gamification/insights/groups/trends/all":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend","description":"","operationId":"getGamificationInsightsGroupsTrendsAll","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrendsAll"}},"/api/v2/gamification/insights/groups/trends":{"get":{"tags":["Gamification"],"summary":"Get insights overall trend for the current user","description":"","operationId":"getGamificationInsightsGroupsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsGroupsTrends"}},"/api/v2/gamification/insights":{"get":{"tags":["Gamification"],"summary":"Get insights summary","description":"","operationId":"getGamificationInsights","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Weekly","Monthly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortKey","in":"query","description":"Sort key","required":false,"type":"string","enum":["percentOfGoal","percentOfGoalChange","overallPercentOfGoal","overallPercentOfGoalChange","value","valueChange"]},{"name":"sortMetricId","in":"query","description":"Sort Metric Id","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"userIds","in":"query","description":"A list of up to 100 comma-separated user Ids","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InsightsSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsights"}},"/api/v2/gamification/insights/users/{userId}/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the user","description":"","operationId":"getGamificationInsightsUserTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user.","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:viewAll"]},"x-purecloud-method-name":"getGamificationInsightsUserTrends"}},"/api/v2/gamification/insights/trends":{"get":{"tags":["Gamification"],"summary":"Get insights user trend for the current user","description":"","operationId":"getGamificationInsightsTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"granularity","in":"query","description":"Granularity","required":true,"type":"string","enum":["Daily","Weekly"]},{"name":"comparativePeriodStartWorkday","in":"query","description":"The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"comparativePeriodEndWorkday","in":"query","description":"The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodStartWorkday","in":"query","description":"The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"primaryPeriodEndWorkday","in":"query","description":"The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserInsightsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","request.agent.number.over.limit":"Number of agents to rank exceeds the limit.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:insights:view"]},"x-purecloud-method-name":"getGamificationInsightsTrends"}},"/api/v2/gamification/profiles/{profileId}/members":{"get":{"tags":["Gamification"],"summary":"Members of a given performance profile","description":"","operationId":"getGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MemberListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:view"]},"x-purecloud-method-name":"getGamificationProfileMembers"},"post":{"tags":["Gamification"],"summary":"Assign members to a given performance profile","description":"","operationId":"postGamificationProfileMembers","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"assignUsers","required":true,"schema":{"$ref":"#/definitions/AssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembers"}},"/api/v2/gamification/profiles/{profileId}/members/validate":{"post":{"tags":["Gamification"],"summary":"Validate member assignment","description":"","operationId":"postGamificationProfileMembersValidate","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"string"},{"in":"body","name":"body","description":"memberAssignments","required":true,"schema":{"$ref":"#/definitions/ValidateAssignUsers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignmentValidation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:profile:update"]},"x-purecloud-method-name":"postGamificationProfileMembersValidate"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a division or a performance profile","description":"","operationId":"getGamificationScorecardsProfileMetricUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. Only required when filterType is Division.","required":false,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUsersValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of a user","description":"","operationId":"getGamificationScorecardsProfileMetricUserValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricUserValuesTrends"}},"/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Average performance values trends by metric of the requesting user","description":"","operationId":"getGamificationScorecardsProfileMetricValuesTrends","produces":["application/json"],"parameters":[{"name":"profileId","in":"path","description":"performanceProfileId","required":true,"type":"string"},{"name":"metricId","in":"path","description":"metricId","required":true,"type":"string"},{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, returns the values trends of the requesting user","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MetricValueTrendAverage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsProfileMetricValuesTrends"}},"/api/v2/gamification/scorecards/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of the requesting user","description":"","operationId":"getGamificationScorecardsBestpoints","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsBestpoints"}},"/api/v2/gamification/scorecards":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics of the requesting user","description":"","operationId":"getGamificationScorecards","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecards"}},"/api/v2/gamification/scorecards/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics of the requesting user","description":"","operationId":"getGamificationScorecardsAttendance","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsAttendance"}},"/api/v2/gamification/scorecards/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points of the requesting user","description":"","operationId":"getGamificationScorecardsPointsAlltime","produces":["application/json"],"parameters":[{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAlltime"}},"/api/v2/gamification/scorecards/points/average":{"get":{"tags":["Gamification"],"summary":"Average points of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsPointsAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsAverage"}},"/api/v2/gamification/scorecards/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trends of the requesting user","description":"","operationId":"getGamificationScorecardsPointsTrends","produces":["application/json"],"parameters":[{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsPointsTrends"}},"/api/v2/gamification/scorecards/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of the requesting user or group","description":"","operationId":"getGamificationScorecardsValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request. If not set, then the request is for the requesting user.","required":false,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"referenceWorkday","in":"query","description":"Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"Invalid timezone ID.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesTrends"}},"/api/v2/gamification/scorecards/values/average":{"get":{"tags":["Gamification"],"summary":"Average values of the requesting user's division or performance profile","description":"","operationId":"getGamificationScorecardsValuesAverage","produces":["application/json"],"parameters":[{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:view"]},"x-purecloud-method-name":"getGamificationScorecardsValuesAverage"}},"/api/v2/gamification/scorecards/users/{userId}/bestpoints":{"get":{"tags":["Gamification"],"summary":"Best points of a user","description":"","operationId":"getGamificationScorecardsUserBestpoints","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserBestPoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserBestpoints"}},"/api/v2/gamification/scorecards/users/{userId}/attendance":{"get":{"tags":["Gamification"],"summary":"Attendance status metrics for a user","description":"","operationId":"getGamificationScorecardsUserAttendance","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttendanceStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"The timezone ID was invalid.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserAttendance"}},"/api/v2/gamification/scorecards/users/{userId}/points/trends":{"get":{"tags":["Gamification"],"summary":"Points trend for a user","description":"","operationId":"getGamificationScorecardsUserPointsTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"dayOfWeek","in":"query","description":"Optional filter to specify which day of weeks to be included in the response","required":false,"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayPointsTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsTrends"}},"/api/v2/gamification/scorecards/users/{userId}/points/alltime":{"get":{"tags":["Gamification"],"summary":"All-time points for a user","description":"","operationId":"getGamificationScorecardsUserPointsAlltime","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AllTimePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserPointsAlltime"}},"/api/v2/gamification/scorecards/users/{userId}/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trends of a user","description":"","operationId":"getGamificationScorecardsUserValuesTrends","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUserValuesTrends"}},"/api/v2/gamification/scorecards/users/points/average":{"get":{"tags":["Gamification"],"summary":"Workday average points by target group","description":"","operationId":"getGamificationScorecardsUsersPointsAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAveragePoints"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersPointsAverage"}},"/api/v2/gamification/scorecards/users/values/average":{"get":{"tags":["Gamification"],"summary":"Workday average values by target group","description":"","operationId":"getGamificationScorecardsUsersValuesAverage","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type. For example, division Id","required":true,"type":"string"},{"name":"workday","in":"query","description":"The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleWorkdayAverageValues"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesAverage"}},"/api/v2/gamification/scorecards/users/values/trends":{"get":{"tags":["Gamification"],"summary":"Values trend by target group","description":"","operationId":"getGamificationScorecardsUsersValuesTrends","produces":["application/json"],"parameters":[{"name":"filterType","in":"query","description":"Filter type for the query request.","required":true,"type":"string","enum":["PerformanceProfile","Division"]},{"name":"filterId","in":"query","description":"ID for the filter type.","required":true,"type":"string"},{"name":"startWorkday","in":"query","description":"Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"endWorkday","in":"query","description":"End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"timeZone","in":"query","description":"Timezone for the workday. Defaults to UTC","required":false,"type":"string","default":"UTC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayValuesTrend"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.timezone.id":"An invalid timezone was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","missing.division.permission.implied":"User does not have access permissions for this division."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUsersValuesTrends"}},"/api/v2/gamification/scorecards/users/{userId}":{"get":{"tags":["Gamification"],"summary":"Workday performance metrics for a user","description":"","operationId":"getGamificationScorecardsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"workday","in":"query","description":"Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["objective"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkdayMetricListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gamification","gamification:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gamification:scorecard:viewAll"]},"x-purecloud-method-name":"getGamificationScorecardsUser"}},"/api/v2/gdpr/requests/{requestId}":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get an existing GDPR request","description":"","operationId":"getGdprRequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Request id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequest"}},"/api/v2/gdpr/requests":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get all GDPR requests","description":"","operationId":"getGdprRequests","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequestEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequests"},"post":{"tags":["General Data Protection Regulation"],"summary":"Submit a new GDPR request","description":"","operationId":"postGdprRequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"GDPR request","required":true,"schema":{"$ref":"#/definitions/GDPRRequest"}},{"name":"deleteConfirmed","in":"query","description":"Confirm delete","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:add"]},"x-purecloud-method-name":"postGdprRequests"}},"/api/v2/gdpr/subjects":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get GDPR subjects","description":"","operationId":"getGdprSubjects","produces":["application/json"],"parameters":[{"name":"searchType","in":"query","description":"Search Type","required":true,"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},{"name":"searchValue","in":"query","description":"Search Value","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRSubjectEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:subject:view"]},"x-purecloud-method-name":"getGdprSubjects"}},"/api/v2/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getUserGeolocation"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Geolocation","required":true,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","geolocationservice.entitypointerror":"Geolocation entity point error","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","geolocation.update.error":"Cannot update another user's Geolocation.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"featuretoggleservice.featurenotenabled":"Geolocation feature toggle not enabled"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-purecloud-method-name":"patchUserGeolocation"}},"/api/v2/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getGeolocationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getGeolocationsSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchGeolocationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Geolocation settings","required":true,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["geolocation:settings:edit"]},"x-purecloud-method-name":"patchGeolocationsSettings"}},"/api/v2/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingMedia"}},"/api/v2/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreeting"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreeting"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"deleteGreeting"}},"/api/v2/groups/{groupId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a Group's ID","description":"","operationId":"getGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified Group","description":"","operationId":"putGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGroupGreetingsDefaults"}},"/api/v2/groups/{groupId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the Group's Greetings","description":"","operationId":"getGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a Group","description":"","operationId":"postGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGroupGreetings"}},"/api/v2/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getGreetingsDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putGreetingsDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreetingsDefaults"}},"/api/v2/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGreetings"}},"/api/v2/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putUserGreetingsDefaults"}},"/api/v2/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postUserGreetings"}},"/api/v2/integrations/clientapps":{"get":{"tags":["Integrations"],"summary":"List permitted client app integrations for the logged in user","description":"","operationId":"getIntegrationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsClientapps"}},"/api/v2/integrations/{integrationId}/config/current":{"get":{"tags":["Integrations"],"summary":"Get integration configuration.","description":"","operationId":"getIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationConfigCurrent"},"put":{"tags":["Integrations"],"summary":"Update integration configuration.","description":"","operationId":"putIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Configuration","required":false,"schema":{"$ref":"#/definitions/IntegrationConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Integration configuration update failed due to version conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationConfigCurrent"}},"/api/v2/integrations/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get integration.","description":"","operationId":"getIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegration"},"delete":{"tags":["Integrations"],"summary":"Delete integration.","description":"","operationId":"deleteIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:delete"]},"x-purecloud-method-name":"deleteIntegration"},"patch":{"tags":["Integrations"],"summary":"Update an integration.","description":"","operationId":"patchIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Update","required":false,"schema":{"$ref":"#/definitions/Integration"}},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"patchIntegration"}},"/api/v2/integrations/types/{typeId}/configschemas/{configType}":{"get":{"tags":["Integrations"],"summary":"Get properties config schema for an integration type.","description":"","operationId":"getIntegrationsTypeConfigschema","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"},{"name":"configType","in":"path","description":"Config schema type","required":true,"type":"string","enum":["properties","advanced"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypeConfigschema"}},"/api/v2/integrations/types/{typeId}":{"get":{"tags":["Integrations"],"summary":"Get integration type.","description":"","operationId":"getIntegrationsType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsType"}},"/api/v2/integrations/types":{"get":{"tags":["Integrations"],"summary":"List integration types","description":"","operationId":"getIntegrationsTypes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsTypes"}},"/api/v2/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"","operationId":"getIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrations"},"post":{"tags":["Integrations"],"summary":"Create an integration.","description":"","operationId":"postIntegrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Integration","required":false,"schema":{"$ref":"#/definitions/CreateIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.integrations.reached":"The maximum number of integrations for this type have already been created. One or more integrations must be removed before a new one can be created."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:add"]},"x-purecloud-method-name":"postIntegrations"}},"/api/v2/integrations/userapps":{"get":{"tags":["Integrations"],"summary":"List permitted user app integrations for the logged in user","description":"","operationId":"getIntegrationsUserapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"appHost","in":"query","description":"The type of UserApp to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsUserapps"}},"/api/v2/integrations/actions/categories":{"get":{"tags":["Integrations"],"summary":"Retrieves all categories of available Actions","description":"","operationId":"getIntegrationsActionsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on. Only 'name' is supported on this endpoint.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsCategories"}},"/api/v2/integrations/actions/certificates":{"get":{"tags":["Integrations"],"summary":"Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.","description":"","operationId":"getIntegrationsActionsCertificates","produces":["application/json"],"parameters":[{"name":"status","in":"query","description":"Indicates the validity of the certificate in question.","required":false,"type":"string","enum":["Current","Upcoming"]},{"name":"type","in":"query","description":"Indicates the type of the certificate.","required":false,"type":"string","enum":["Client"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionCertificateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionCertificate:view"]},"x-purecloud-method-name":"getIntegrationsActionsCertificates"}},"/api/v2/integrations/actions/{actionId}/draft":{"get":{"tags":["Integrations"],"summary":"Retrieve a Draft","description":"","operationId":"getIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraft"},"post":{"tags":["Integrations"],"summary":"Create a new Draft from existing Action","description":"","operationId":"postIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","policy.violation":"A policy violation occurred creating the new draft.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraft"},"delete":{"tags":["Integrations"],"summary":"Delete a Draft","description":"","operationId":"deleteIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsActionDraft"},"patch":{"tags":["Integrations"],"summary":"Update an existing Draft","description":"","operationId":"patchIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action Draft.","required":true,"schema":{"$ref":"#/definitions/UpdateDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsActionDraft"}},"/api/v2/integrations/actions/{actionId}/draft/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionDraftTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute"]},"x-purecloud-method-name":"postIntegrationsActionDraftTest"}},"/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftSchema"}},"/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve templates for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftTemplate"}},"/api/v2/integrations/actions/{actionId}/draft/publish":{"post":{"tags":["Integrations"],"summary":"Publish a Draft and make it the active Action configuration","description":"","operationId":"postIntegrationsActionDraftPublish","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/PublishDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftPublish"}},"/api/v2/integrations/actions/{actionId}/draft/validation":{"get":{"tags":["Integrations"],"summary":"Validate current Draft configuration.","description":"","operationId":"getIntegrationsActionDraftValidation","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftValidationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"getIntegrationsActionDraftValidation"}},"/api/v2/integrations/actions/{actionId}/execute":{"post":{"tags":["Integrations"],"summary":"Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.","description":"","operationId":"postIntegrationsActionExecute","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.results":"Too many results matched criteria.","bad.request":"The 3rd party indicated an issue with the request","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There was an issue validating the schema.","constraint.validation":"%s","invalid.substitution":"There was an issue substituting a value in one of the templates","no.results":"No results were found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.credentials":"There was an issue validating the credentials.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","bad.request":"The request is badly formed.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"method not allowed":"The request method is not allowed for this resource"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionExecute"}},"/api/v2/integrations/actions/{actionId}":{"get":{"tags":["Integrations"],"summary":"Retrieves a single Action matching id.","description":"","operationId":"getIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsAction"},"delete":{"tags":["Integrations"],"summary":"Delete an Action","description":"","operationId":"deleteIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsAction"},"patch":{"tags":["Integrations"],"summary":"Patch an Action","description":"","operationId":"patchIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/UpdateActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsAction"}},"/api/v2/integrations/actions/{actionId}/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionTest"}},"/api/v2/integrations/actions/{actionId}/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for an action based on filename.","description":"","operationId":"getIntegrationsActionSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionSchema"}},"/api/v2/integrations/actions/{actionId}/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve text of templates for an action based on filename.","description":"","operationId":"getIntegrationsActionTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionTemplate"}},"/api/v2/integrations/actions/drafts":{"get":{"tags":["Integrations"],"summary":"Retrieves all action drafts associated with the filters passed in via query param.","description":"","operationId":"getIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsDrafts"},"post":{"tags":["Integrations"],"summary":"Create a new Draft","description":"","operationId":"postIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action Draft.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActionsDrafts"}},"/api/v2/integrations/actions":{"get":{"tags":["Integrations"],"summary":"Retrieves all actions associated with filters passed in via query param.","description":"","operationId":"getIntegrationsActions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"]},{"name":"category","in":"query","description":"Filter by category name.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by partial or complete action name.","required":false,"type":"string"},{"name":"ids","in":"query","description":"Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActions"},"post":{"tags":["Integrations"],"summary":"Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.","description":"","operationId":"postIntegrationsActions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.schema":"There is an error preventing a file from being read","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActions"}},"/api/v2/integrations/botconnector/{integrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBots"},"put":{"tags":["Integrations"],"summary":"Set a list of botConnector bots plus versions for this integration","description":"","operationId":"putIntegrationsBotconnectorIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"botList","required":true,"schema":{"$ref":"#/definitions/BotList"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:edit"]},"x-purecloud-method-name":"putIntegrationsBotconnectorIntegrationIdBots"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a specific botConnector bot, plus versions, for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"version","in":"query","description":"Specific Version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBot"}},"/api/v2/integrations/botconnector/{integrationId}/bots/summaries":{"get":{"tags":["Integrations"],"summary":"Get a summary list of botConnector bots for this integration","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotsSummaries","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotsSummaries"}},"/api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions":{"get":{"tags":["Integrations"],"summary":"Get a list of bot versions for a bot","description":"","operationId":"getIntegrationsBotconnectorIntegrationIdBotVersions","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID for this bot group","required":true,"type":"string"},{"name":"botId","in":"path","description":"The botID for this bot","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotConnectorBotVersionSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots","textbots:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:botconnector:view"]},"x-purecloud-method-name":"getIntegrationsBotconnectorIntegrationIdBotVersions"}},"/api/v2/integrations/speech/dialogflow/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow agent","description":"","operationId":"getIntegrationsSpeechDialogflowAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgent"}},"/api/v2/integrations/speech/dialogflow/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgents"}},"/api/v2/integrations/speech/dialogflowcx/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow CX agent","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgent"}},"/api/v2/integrations/speech/dialogflowcx/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow CX agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowcxAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowCXAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","general.forbidden":"Unauthorized to access of dialog flow cx agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowcxAgents"}},"/api/v2/integrations/speech/lex/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex bot alias","description":"","operationId":"getIntegrationsSpeechLexBotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotAlias"}},"/api/v2/integrations/speech/lex/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a bot in the customer's AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["READY","FAILED","BUILDING","NOT_BUILT"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotBotIdAliases"}},"/api/v2/integrations/speech/lex/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex bots in the customers' AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBots"}},"/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex V2 bot alias","description":"","operationId":"getIntegrationsSpeechLexv2BotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The Alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request is badly formed","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotAlias"}},"/api/v2/integrations/speech/lexv2/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a Lex V2 bot","description":"","operationId":"getIntegrationsSpeechLexv2BotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The Bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["Creating","Available","Deleting","Failed"]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2BotBotIdAliases"}},"/api/v2/integrations/speech/lexv2/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex V2 bots","description":"","operationId":"getIntegrationsSpeechLexv2Bots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexV2BotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexv2Bots"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bot GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs":{"post":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"targetChannel","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}":{"get":{"tags":["Integrations"],"summary":"Get a Nuance bot in the specified Integration","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"botId","in":"path","description":"The Nuance bot ID to get","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string","enum":["variables","transferNodes","channels","locales"]},"collectionFormat":"multi"},{"name":"targetChannel","in":"query","description":"targetChannel","required":false,"type":"string","enum":["digital","voice"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBot"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results":{"get":{"tags":["Integrations"],"summary":"Get the result of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The asynchronous operation is still in the 'running' state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}":{"get":{"tags":["Integrations"],"summary":"Get the status of an asynchronous Nuance bots GET job","description":"","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The asynchronous job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs":{"post":{"tags":["Integrations"],"summary":"Get a list of Nuance bots in the specified Integration asynchronously","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncJob"}},"202":{"description":"Job created","schema":{"$ref":"#/definitions/AsyncJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings":{"put":{"tags":["Integrations"],"summary":"Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration","description":"","operationId":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/NuanceBotLaunchSettings"}}],"responses":{"204":{"description":"Configuration updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate":{"post":{"tags":["Integrations"],"summary":"Try out a single credential for a Nuance bot to know if the secret is correct","description":"","operationId":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"in":"body","name":"settings","required":true,"schema":{"$ref":"#/definitions/BotExecutionConfiguration"}}],"responses":{"204":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate"}},"/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Nuance bots available in the specified Integration","description":"If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.","operationId":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots","produces":["application/json"],"parameters":[{"name":"nuanceIntegrationId","in":"path","description":"The integration ID for this group of bots","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"onlyRegisteredBots","in":"query","description":"Limit bots to the ones configured for Genesys Cloud usage","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NuanceBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechNuanceNuanceIntegrationIdBots"}},"/api/v2/integrations/speech/stt/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a STT engine","description":"","operationId":"getIntegrationsSpeechSttEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngine"}},"/api/v2/integrations/speech/stt/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of STT engines enabled for org","description":"","operationId":"getIntegrationsSpeechSttEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SttEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechSttEngines"}},"/api/v2/integrations/speech/tts/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngine"}},"/api/v2/integrations/speech/tts/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of TTS engines enabled for org","description":"","operationId":"getIntegrationsSpeechTtsEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"},{"name":"language","in":"query","description":"Filter on supported language. If includeVoices=true then the voices are also filtered.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngines"}},"/api/v2/integrations/speech/tts/settings":{"get":{"tags":["Integrations"],"summary":"Get TTS settings for an org","description":"","operationId":"getIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsSettings"},"put":{"tags":["Integrations"],"summary":"Update TTS settings for an org","description":"","operationId":"putIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Updated TtsSettings","required":true,"schema":{"$ref":"#/definitions/TtsSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechTtsSettings"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}":{"get":{"tags":["Integrations"],"summary":"Get details about a specific voice for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoice","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"voiceId","in":"path","description":"The voice ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoice"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices":{"get":{"tags":["Integrations"],"summary":"Get a list of voices for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoices","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoices"}},"/api/v2/journey/actionmaps/{actionMapId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action map.","description":"","operationId":"getJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmap"},"delete":{"tags":["Journey"],"summary":"Delete single action map.","description":"","operationId":"deleteJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"204":{"description":"Action map deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:delete"]},"x-purecloud-method-name":"deleteJourneyActionmap"},"patch":{"tags":["Journey"],"summary":"Update single action map.","description":"","operationId":"patchJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:edit"]},"x-purecloud-method-name":"patchJourneyActionmap"}},"/api/v2/journey/actionmaps":{"get":{"tags":["Journey"],"summary":"Retrieve all action maps.","description":"","operationId":"getJourneyActionmaps","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"filterField","in":"query","description":"Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.","required":false,"type":"string"},{"name":"filterValue","in":"query","description":"Value to filter by. Requires 'filterValue' to also be set.","required":false,"type":"string"},{"name":"actionMapIds","in":"query","description":"IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Action Map field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmaps"},"post":{"tags":["Journey"],"summary":"Create an action map.","description":"","operationId":"postJourneyActionmaps","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"201":{"description":"Action map created.","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:add"]},"x-purecloud-method-name":"postJourneyActionmaps"}},"/api/v2/journey/actiontargets/{actionTargetId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action target.","description":"","operationId":"getJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontarget"},"patch":{"tags":["Journey"],"summary":"Update a single action target.","description":"","operationId":"patchJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTarget"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:edit"]},"x-purecloud-method-name":"patchJourneyActiontarget"}},"/api/v2/journey/actiontargets":{"get":{"tags":["Journey"],"summary":"Retrieve all action targets.","description":"","operationId":"getJourneyActiontargets","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTargetListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontargets"}},"/api/v2/journey/actiontemplates/{actionTemplateId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action template.","description":"","operationId":"getJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplate"},"delete":{"tags":["Journey"],"summary":"Delete a single action template.","description":"","operationId":"deleteJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"name":"hardDelete","in":"query","description":"Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.","required":false,"type":"boolean"}],"responses":{"204":{"description":"Action template deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:delete"]},"x-purecloud-method-name":"deleteJourneyActiontemplate"},"patch":{"tags":["Journey"],"summary":"Update a single action template.","description":"","operationId":"patchJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:edit"]},"x-purecloud-method-name":"patchJourneyActiontemplate"}},"/api/v2/journey/actiontemplates":{"get":{"tags":["Journey"],"summary":"Retrieve all action templates.","description":"","operationId":"getJourneyActiontemplates","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).","required":false,"type":"string"},{"name":"mediaType","in":"query","description":"Media type","required":false,"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},{"name":"state","in":"query","description":"Action template state.","required":false,"type":"string","enum":["Active","Inactive","Deleted"]},{"name":"queryFields","in":"query","description":"ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplates"},"post":{"tags":["Journey"],"summary":"Create a single action template.","description":"","operationId":"postJourneyActiontemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"201":{"description":"Action template created.","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:add"]},"x-purecloud-method-name":"postJourneyActiontemplates"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get status of job.","description":"","operationId":"getJourneyActionmapsEstimatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"202":{"description":"Accepted - Running query asynchronously","schema":{"type":"string","enum":["Cancelled","Failed","Queued","Running","Succeeded"]}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimateJob:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJob"}},"/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get estimates from completed job.","description":"","operationId":"getJourneyActionmapsEstimatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapEstimateResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:actionmapEstimate:view"]},"x-purecloud-method-name":"getJourneyActionmapsEstimatesJobResults"}},"/api/v2/journey/actionmaps/estimates/jobs":{"post":{"tags":["Journey"],"summary":"Query for estimates","description":"","operationId":"postJourneyActionmapsEstimatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"audience estimator request","required":true,"schema":{"$ref":"#/definitions/ActionMapEstimateRequest"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/EstimateJobAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmapEstimateJob:add"]},"x-purecloud-method-name":"postJourneyActionmapsEstimatesJobs"}},"/api/v2/journey/flows/paths/query":{"post":{"tags":["Journey"],"summary":"Query for flow paths.","description":"","operationId":"postJourneyFlowsPathsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowPathsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowPaths"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:flowpaths:view"]},"x-purecloud-method-name":"postJourneyFlowsPathsQuery"}},"/api/v2/journey/outcomes/{outcomeId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome.","description":"","operationId":"getJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcome"},"delete":{"tags":["Journey"],"summary":"Delete an outcome.","description":"","operationId":"deleteJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"204":{"description":"Outcome deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:delete"]},"x-purecloud-method-name":"deleteJourneyOutcome"},"patch":{"tags":["Journey"],"summary":"Update an outcome.","description":"","operationId":"patchJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:edit"]},"x-purecloud-method-name":"patchJourneyOutcome"}},"/api/v2/journey/outcomes":{"get":{"tags":["Journey"],"summary":"Retrieve all outcomes.","description":"","operationId":"getJourneyOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"outcomeIds","in":"query","description":"IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Outcome field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcomes"},"post":{"tags":["Journey"],"summary":"Create an outcome.","description":"","operationId":"postJourneyOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"201":{"description":"Outcome created.","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:add"]},"x-purecloud-method-name":"postJourneyOutcomes"}},"/api/v2/journey/sessions/{sessionId}/outcomescores":{"get":{"tags":["Journey"],"summary":"Retrieve latest outcome score associated with a session for all outcomes.","description":"","operationId":"getJourneySessionOutcomescores","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeScoresResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomescores:view"]},"x-purecloud-method-name":"getJourneySessionOutcomescores"}},"/api/v2/journey/outcomes/predictors/{predictorId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome predictor.","description":"","operationId":"getJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictor"},"delete":{"tags":["Journey"],"summary":"Delete an outcome predictor.","description":"","operationId":"deleteJourneyOutcomesPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"ID of predictor","required":true,"type":"string"}],"responses":{"204":{"description":"Predictor deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:delete"]},"x-purecloud-method-name":"deleteJourneyOutcomesPredictor"}},"/api/v2/journey/outcomes/predictors":{"get":{"tags":["Journey"],"summary":"Retrieve all outcome predictors.","description":"","operationId":"getJourneyOutcomesPredictors","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:view"]},"x-purecloud-method-name":"getJourneyOutcomesPredictors"},"post":{"tags":["Journey"],"summary":"Create an outcome predictor.","description":"","operationId":"postJourneyOutcomesPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OutcomePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomePredictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/OutcomePredictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomepredictor:add"]},"x-purecloud-method-name":"postJourneyOutcomesPredictors"}},"/api/v2/journey/segments/{segmentId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single segment.","description":"","operationId":"getJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegment"},"delete":{"tags":["Journey"],"summary":"Delete a segment.","description":"","operationId":"deleteJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"204":{"description":"Segment deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:delete"]},"x-purecloud-method-name":"deleteJourneySegment"},"patch":{"tags":["Journey"],"summary":"Update a segment.","description":"","operationId":"patchJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchSegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:edit"]},"x-purecloud-method-name":"patchJourneySegment"}},"/api/v2/journey/segments":{"get":{"tags":["Journey"],"summary":"Retrieve all segments.","description":"","operationId":"getJourneySegments","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"isActive","in":"query","description":"Determines whether or not to show only active segments.","required":false,"type":"boolean"},{"name":"segmentIds","in":"query","description":"IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryFields","in":"query","description":"Segment field(s) to query on. Requires 'queryValue' to also be set.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"queryValue","in":"query","description":"Value to query on. Requires 'queryFields' to also be set.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SegmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegments"},"post":{"tags":["Journey"],"summary":"Create a segment.","description":"","operationId":"postJourneySegments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JourneySegmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"201":{"description":"Segment created.","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:add"]},"x-purecloud-method-name":"postJourneySegments"}},"/api/v2/journey/sessions/{sessionId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single session.","description":"","operationId":"getJourneySession","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"ID of the session.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Session"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:session:view","externalContacts:session:view"]},"x-purecloud-method-name":"getJourneySession"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"201":{"description":"Category created","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Total number, maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseCategory","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CategoryUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.parent.category":"Subcategory cannot be the parent category.","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Maximum child or maximum depth limit has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Category with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search":{"post":{"tags":["Knowledge","Search"],"summary":"Search Documents","description":"","operationId":"postKnowledgeKnowledgebaseSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum characters for the query is 5","invalid.languagecode":"Language code must be of format lang-iso2 (eg: en-US)","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageCategories"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeCategory"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageCategory"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}":{"get":{"tags":["Knowledge"],"summary":"Get import operation report","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"200":{"description":"Finished import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Pending import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocumentsImport"},"delete":{"tags":["Knowledge"],"summary":"Delete import operation","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import operation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocumentsImport"},"patch":{"tags":["Knowledge"],"summary":"Start import operation","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocumentsImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"importId","in":"path","description":"Import ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"Import operation finished","schema":{"$ref":"#/definitions/KnowledgeImport"}},"202":{"description":"Import operation started","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Import operation does exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit","knowledge:document:add"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocumentsImport"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports":{"post":{"tags":["Knowledge"],"summary":"Create import operation","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocumentsImports","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImport"}}],"responses":{"202":{"description":"Created import operation","schema":{"$ref":"#/definitions/KnowledgeImport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","kb.not.found":"Knowledge Base does not exist","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocumentsImports"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"204":{"description":"Document deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocuments","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"categories","in":"query","description":"Filter by categories ids, comma separated values expected.","required":false,"type":"string"},{"name":"title","in":"query","description":"Filter by document title.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Title","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]},{"name":"documentIds","in":"query","description":"Comma-separated list of document identifiers to fetch by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","document.limitexceeded":"Document count exceeded for kbId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocuments"},"patch":{"tags":["Knowledge"],"summary":"Update documents collection","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentBulkRequest"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"Internal server error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base","description":"","operationId":"getKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebase"},"delete":{"tags":["Knowledge"],"summary":"Delete knowledge base","description":"","operationId":"deleteKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"204":{"description":"Knowledge base deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input paramaters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledgebase not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.in.use":"knowledgebase in use by bot flow"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.bot.flow.status.unknown":"Knowledgebase bot flow status unknown"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebase"},"patch":{"tags":["Knowledge"],"summary":"Update knowledge base","description":"","operationId":"patchKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input paramaters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebase"}},"/api/v2/knowledge/knowledgebases":{"get":{"tags":["Knowledge"],"summary":"Get knowledge bases","description":"","operationId":"getKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 100. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 100.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by Name.","required":false,"type":"string"},{"name":"coreLanguage","in":"query","description":"Filter by core language.","required":false,"type":"string","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"published","in":"query","description":"Filter by published status.","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"Sort by.","required":false,"type":"string","enum":["Name","Date"]},{"name":"sortOrder","in":"query","description":"Sort Order.","required":false,"type":"string","enum":["ASC","ascending","DESC","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBaseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebases"},"post":{"tags":["Knowledge"],"summary":"Create new knowledge base","description":"","operationId":"postKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBaseCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"kb.limitexceeded":"Knowledge Base count exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebases"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered groups","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroups","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroups"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroups"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered group for a particular groupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base unanswered phrase group for a particular phraseGroupId","description":"","operationId":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be retrieved.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be retrieved.","required":true,"type":"string"},{"name":"app","in":"query","description":"The app value to be used for filtering phrases.","required":false,"type":"string","enum":["SupportCenter","MessengerKnowledgeApp","BotFlow","Assistant","SmartAdvisor"]},{"name":"dateStart","in":"query","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"},"patch":{"tags":["Knowledge"],"summary":"Update a Knowledge base unanswered phrase group","description":"","operationId":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The ID of the group to be updated.","required":true,"type":"string"},{"name":"phraseGroupId","in":"path","description":"The ID of the phraseGroup to be updated.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body of the update unanswered group endpoint.","required":true,"schema":{"$ref":"#/definitions/UnansweredPhraseGroupPatchRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnansweredPhraseGroupUpdateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:groups:edit","knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}":{"get":{"tags":["Knowledge"],"summary":"Get label","description":"","operationId":"getKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabel"},"delete":{"tags":["Knowledge"],"summary":"Delete label","description":"","operationId":"deleteKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"204":{"description":"Label deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLabel"},"patch":{"tags":["Knowledge"],"summary":"Update label","description":"","operationId":"patchKnowledgeKnowledgebaseLabel","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"labelId","in":"path","description":"Label ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with the new name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLabel"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels":{"get":{"tags":["Knowledge"],"summary":"Get labels","description":"","operationId":"getKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the labels that contains the given phrase in the name.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to label.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLabels"},"post":{"tags":["Knowledge"],"summary":"Create new label","description":"","operationId":"postKnowledgeKnowledgebaseLabels","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LabelCreateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LabelResponse"}},"201":{"description":"Label created","schema":{"$ref":"#/definitions/LabelResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"The limit for the number of labels has been reached."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Label with same name already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:label:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLabels"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}":{"get":{"tags":["Knowledge"],"summary":"Get training detail","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTraining","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTraining"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote":{"post":{"tags":["Knowledge"],"summary":"Promote trained documents from draft state to active.","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainingPromote","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainingPromote"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings":{"get":{"tags":["Knowledge"],"summary":"Get all trainings information for a knowledgebase","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"knowledgeDocumentsState","in":"query","description":"Return the training with the specified state of the trained documents.","required":false,"type":"string","enum":["Draft","Active","Discarded","Archived"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrainingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTrainings"},"post":{"tags":["Knowledge"],"summary":"Trigger training","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainings"}},"/api/v2/knowledge/documentuploads":{"post":{"tags":["Knowledge","Uploads"],"summary":"Creates a presigned URL for uploading a knowledge import file with a set of documents","description":"","operationId":"postKnowledgeDocumentuploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:upload"]},"x-purecloud-method-name":"postKnowledgeDocumentuploads"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document.","description":"","operationId":"getKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"state","in":"query","description":"\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"}],"responses":{"204":{"description":"Document deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocument","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}":{"get":{"tags":["Knowledge"],"summary":"Get document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersion","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersion"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions":{"get":{"tags":["Knowledge"],"summary":"Get document versions.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersions"},"post":{"tags":["Knowledge"],"summary":"Creates or restores a document version.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVersions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVersions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ","required":false,"type":"string","format":"interval"},{"name":"documentId","in":"query","description":"Retrieves the specified documents, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSubcategories","in":"query","description":"Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.","required":false,"type":"boolean"},{"name":"includeDrafts","in":"query","description":"If includeDrafts is true, Documents in the draft state are also returned in the response.","required":false,"type":"boolean"},{"name":"labelIds","in":"query","description":"If specified, retrieves documents associated with label ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["category","labels","variations"]},"collectionFormat":"multi"},{"name":"externalIds","in":"query","description":"If specified, retrieves documents associated with external ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document.","description":"","operationId":"postKnowledgeKnowledgebaseDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentReq"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"already.exists":"Document already exists"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocuments"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}":{"get":{"tags":["Knowledge"],"summary":"Get a variation for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariation"},"delete":{"tags":["Knowledge"],"summary":"Delete a variation for a document.","description":"","operationId":"deleteKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"}],"responses":{"204":{"description":"Document variation deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:delete","knowledge:document:edit"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseDocumentVariation"},"patch":{"tags":["Knowledge"],"summary":"Update a variation for a document.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentVariation","produces":["application/json"],"parameters":[{"name":"documentVariationId","in":"path","description":"Globally unique identifier for a document variation.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for a document.","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for a knowledge base.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for a document.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"documentState","in":"query","description":"The state of the document.","required":false,"type":"string","enum":["Draft","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVariations"},"post":{"tags":["Knowledge"],"summary":"Create a variation for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DocumentVariation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Body should have a value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","already.exists":"Variation already exists","constraint.validation":"Submitted variation is either null or contains a null field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","knowledge.variation.empty.request":"The request for knowledge variation was empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:document:add","knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}":{"get":{"tags":["Knowledge"],"summary":"Get variation for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariation","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"variationId","in":"path","description":"Globally unique identifier for the document version variation.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariation"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations":{"get":{"tags":["Knowledge"],"summary":"Get variations for the given document version.","description":"","operationId":"getKnowledgeKnowledgebaseDocumentVersionVariations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Globally unique identifier for the knowledge base.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Globally unique identifier for the document.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Globally unique identifier for the document version.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentVersionVariations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentCopies","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentCopy:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentCopies"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentPresentation:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsPresentations"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}":{"get":{"tags":["Knowledge"],"summary":"Get a single feedback record given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"Feedback ID.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Feedback not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback":{"get":{"tags":["Knowledge"],"summary":"Get a list of feedback records given on a document","description":"","operationId":"getKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"onlyCommented","in":"query","description":"If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.","required":false,"type":"boolean"},{"name":"documentVersionId","in":"query","description":"Document version ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"documentVariationId","in":"query","description":"Document variation ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"appType","in":"query","description":"Application type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},{"name":"queryType","in":"query","description":"Query type to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},{"name":"userId","in":"query","description":"The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID to filter by. Supported only if onlyCommented=true is set.","required":false,"type":"string"},{"name":"state","in":"query","description":"State to filter by. Supported only if onlyCommented=true is set. Default: Final","required":false,"type":"string","enum":["All","Draft","Final"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseDocumentFeedback"},"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeKnowledgebaseDocumentFeedback","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["knowledge:feedback:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentFeedback"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}":{"get":{"tags":["Knowledge"],"summary":"Get export job report","description":"","operationId":"getKnowledgeKnowledgebaseExportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"Export job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"202":{"description":"Export job in progress","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseExportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete export job","description":"","operationId":"deleteKnowledgeKnowledgebaseExportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"Export job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Export job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseExportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs":{"post":{"tags":["Knowledge"],"summary":"Create export job","description":"","operationId":"postKnowledgeKnowledgebaseExportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"202":{"description":"Export job in progress","schema":{"$ref":"#/definitions/KnowledgeExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.reached":"Daily or monthly limit reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:exportJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseExportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}":{"get":{"tags":["Knowledge"],"summary":"Get import job report","description":"","operationId":"getKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.","required":false,"type":"array","items":{"type":"string","enum":["urls"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseImportJob"},"delete":{"tags":["Knowledge"],"summary":"Delete import job","description":"","operationId":"deleteKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Import job deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","constraint.validation":"Input parameters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseImportJob"},"patch":{"tags":["Knowledge"],"summary":"Start import job","description":"","operationId":"patchKnowledgeKnowledgebaseImportJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"Import job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseImportJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs":{"post":{"tags":["Knowledge"],"summary":"Create import job","description":"","operationId":"postKnowledgeKnowledgebaseImportJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeImportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"202":{"description":"Import job in progress","schema":{"$ref":"#/definitions/KnowledgeImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseImportJobs"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search":{"post":{"tags":["Knowledge"],"summary":"Search the documents in a knowledge base.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields, if any, to expand for each document in the search result matching the query.","required":false,"type":"array","items":{"type":"string","enum":["documentVariations","documentAlternatives"]},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentSearch"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"The minimum characters for the query is 3.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearch"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:search:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentsSearchSearchId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"The ID of knowledge base containing the documents to query.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","min.length.expected":"The minimum length was not reached.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsSearchSuggestions"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view for a document.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentViews","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentView:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentViews"}},"/api/v2/languageunderstanding/domains/{domainId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain.","description":"","operationId":"getLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomain"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain.","description":"","operationId":"deleteLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"There was a request conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomain"},"patch":{"tags":["Language Understanding"],"summary":"Update an NLU Domain.","description":"","operationId":"patchLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:edit","dialog:bot:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingDomain"}},"/api/v2/languageunderstanding/domains":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domains.","description":"","operationId":"getLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomains"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain.","description":"","operationId":"postLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The NLU Domain to create.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"201":{"description":"","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The requested domain did not meet domain name and/or language conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","domain.limit":"This organization has reached limit for domains created.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomains"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}":{"get":{"tags":["Language Understanding"],"summary":"Find a Feedback","description":"","operationId":"getLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedbackFeedbackId"},"delete":{"tags":["Language Understanding"],"summary":"Delete the feedback on the NLU Domain Version.","description":"","operationId":"deleteLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"Feedback deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.not.found":"Could not find feedback model entry specified.","not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainFeedbackFeedbackId"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback":{"get":{"tags":["Language Understanding"],"summary":"Get all feedback in the given NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"intentName","in":"query","description":"The top intent name to retrieve feedback for.","required":false,"type":"string"},{"name":"assessment","in":"query","description":"The top assessment to retrieve feedback for.","required":false,"type":"string","enum":["Incorrect","Correct","Unknown","Disabled"]},{"name":"dateStart","in":"query","description":"Begin of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"End of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"includeDeleted","in":"query","description":"Whether to include soft-deleted items in the result.","required":false,"type":"boolean"},{"name":"language","in":"query","description":"Whether to filter response based on the language, e.g. en-us, pt-br.","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"enableCursorPagination","in":"query","description":"Enable Cursor Pagination","required":false,"type":"boolean","default":false},{"name":"includeTrainingUtterances","in":"query","description":"Include Training Utterances. By default they're included.","required":false,"type":"boolean","default":true},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true","required":false,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedback"},"post":{"tags":["Language Understanding"],"summary":"Create feedback for the NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The Feedback to create.","required":true,"schema":{"$ref":"#/definitions/NluFeedbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"201":{"description":"Feedback created successfully","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"Invalid feedback data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainFeedback"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a draft.","description":"","operationId":"getLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"name":"draftIntentId","in":"query","description":"Parameter to filter a specific intent.","required":false,"type":"string"},{"name":"draftTopicId","in":"query","description":"Parameter to filter a specific topic.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDraft"},"delete":{"tags":["Language Understanding"],"summary":"Delete a draft","description":"","operationId":"deleteLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"}],"responses":{"204":{"description":"Draft deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMinerDraft"},"patch":{"tags":["Language Understanding"],"summary":"Save information for the draft. Either topic draft or intent draft should be sent.","description":"","operationId":"patchLanguageunderstandingMinerDraft","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"draftId","in":"path","description":"Draft ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DraftRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingMinerDraft"}},"/api/v2/languageunderstanding/miners/{minerId}/drafts":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of drafts created.","description":"","operationId":"getLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerDrafts"},"post":{"tags":["Language Understanding"],"summary":"Create a new draft resource.","description":"","operationId":"postLanguageunderstandingMinerDrafts","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Details for creating draft resource","required":true,"schema":{"$ref":"#/definitions/Draft"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Draft"}},"201":{"description":"Draft created successfully","schema":{"$ref":"#/definitions/Draft"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:draft:add"]},"x-purecloud-method-name":"postLanguageunderstandingMinerDrafts"}},"/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a mined intent","description":"","operationId":"getLanguageunderstandingMinerIntent","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"intentId","in":"path","description":"The ID of the intent to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerIntent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntent"}},"/api/v2/languageunderstanding/miners/{minerId}/intents":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined intents.","description":"","operationId":"getLanguageunderstandingMinerIntents","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch utterances.","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinedIntentsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:minerIntent:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerIntents"}},"/api/v2/languageunderstanding/miners/{minerId}":{"get":{"tags":["Language Understanding"],"summary":"Get information about a miner.","description":"","operationId":"getLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiner"},"delete":{"tags":["Language Understanding"],"summary":"Delete a miner.","description":"","operationId":"deleteLanguageunderstandingMiner","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"204":{"description":"Miner deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingMiner"}},"/api/v2/languageunderstanding/miners/{minerId}/execute":{"post":{"tags":["Language Understanding"],"summary":"Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.","description":"","operationId":"postLanguageunderstandingMinerExecute","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MinerExecuteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"202":{"description":"Processing request","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:execute"]},"x-purecloud-method-name":"postLanguageunderstandingMinerExecute"}},"/api/v2/languageunderstanding/miners":{"get":{"tags":["Language Understanding"],"summary":"Retrieve the list of miners created.","description":"","operationId":"getLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"name":"minerType","in":"query","description":"Type of miner, either intent or topic","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMiners"},"post":{"tags":["Language Understanding"],"summary":"Create a unique miner.","description":"","operationId":"postLanguageunderstandingMiners","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Details for creating a new miner resource.","required":true,"schema":{"$ref":"#/definitions/Miner"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Miner"}},"201":{"description":"Miner created successfully","schema":{"$ref":"#/definitions/Miner"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:add"]},"x-purecloud-method-name":"postLanguageunderstandingMiners"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves details of a particular topic.","description":"","operationId":"getLanguageunderstandingMinerTopic","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Option to fetch phrases","required":false,"type":"string","enum":["phrases","utterances"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopic"}},"/api/v2/languageunderstanding/miners/{minerId}/topics":{"get":{"tags":["Language Understanding"],"summary":"Retrieve a list of mined topics.","description":"","operationId":"getLanguageunderstandingMinerTopics","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopics"}},"/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}":{"get":{"tags":["Language Understanding"],"summary":"Retrieves utterances related to a phrase in a topic.","description":"","operationId":"getLanguageunderstandingMinerTopicPhrase","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"name":"topicId","in":"path","description":"The ID of the topic to be retrieved.","required":true,"type":"string"},{"name":"phraseId","in":"path","description":"The ID of the phrase to be retrieved.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MinerTopicPhrase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:view"]},"x-purecloud-method-name":"getLanguageunderstandingMinerTopicPhrase"}},"/api/v2/languageunderstanding/miners/{minerId}/uploads":{"post":{"tags":["Uploads"],"summary":"Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner","description":"","operationId":"postLanguageunderstandingMinerUploads","produces":["application/json"],"parameters":[{"name":"minerId","in":"path","description":"Miner ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/Empty"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["languageUnderstanding:miner:upload"]},"x-purecloud-method-name":"postLanguageunderstandingMinerUploads"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report":{"get":{"tags":["Language Understanding"],"summary":"Retrieved quality report for the specified NLU Domain Version","description":"","operationId":"getLanguageunderstandingDomainVersionReport","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"Find quality report for NLU Domain Version.","schema":{"$ref":"#/definitions/NluDomainVersionQualityReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersionReport"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Retrieved the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersion"},"put":{"tags":["Language Understanding"],"summary":"Update an NLU Domain Version.","description":"","operationId":"putLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain Version.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"Updated the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"putLanguageunderstandingDomainVersion"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain Version","description":"","operationId":"deleteLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted the specified NLU Domain Version"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.evaluation.in.progress":"The request could not be completed due to a conflict with the current state of the target resource.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:delete","dialog:botVersion:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainVersion"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish":{"post":{"tags":["Language Understanding"],"summary":"Publish the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionPublish","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Published the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","version.untrained":"The version cannot be published as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionPublish"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train":{"post":{"tags":["Language Understanding"],"summary":"Train the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionTrain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"202":{"description":"Issued training instruction for the draft NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.not.found":"Could not find version model entry specified.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.published":"The domain version is already published and therefore immutable.","training.in.progress":"The request could not be completed due to a conflict with the current state of the target resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"training error":"The service is not available.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionTrain"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect":{"post":{"tags":["Language Understanding"],"summary":"Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","description":"","operationId":"postLanguageunderstandingDomainVersionDetect","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The input data to perform detection on.","required":true,"schema":{"$ref":"#/definitions/NluDetectionRequest"}}],"responses":{"200":{"description":"Requested NLU detection for the given input using the specified NLU domain version","schema":{"$ref":"#/definitions/NluDetectionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.intent.name":"Invalid context provided: intent name is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.entity.name":"Invalid context provided: entity name is not valid.","constraint.validation":"%s","version.untrained":"The version cannot be used for detection as it's not trained.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionDetect"}},"/api/v2/languageunderstanding/domains/{domainId}/versions":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domain Versions for a given Domain.","description":"","operationId":"getLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersions"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The NLU Domain Version to create.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Created an NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.error":"The arguments provided do not meet the required conditions.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","domain.not.found":"Could not find Domain model entry specified."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersions"}},"/api/v2/license/definitions/{licenseId}":{"get":{"tags":["License"],"summary":"Get PureCloud license definition.","description":"","operationId":"getLicenseDefinition","produces":["application/json"],"parameters":[{"name":"licenseId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinition"}},"/api/v2/license/definitions":{"get":{"tags":["License"],"summary":"Get all PureCloud license definitions available for the organization.","description":"","operationId":"getLicenseDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseDefinition"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseDefinitions"}},"/api/v2/license/infer":{"post":{"tags":["License"],"summary":"Get a list of licenses inferred based on a list of roleIds","description":"","operationId":"postLicenseInfer","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The roleIds to use while inferring licenses","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseInfer"}},"/api/v2/license/toggles/{featureName}":{"get":{"tags":["License"],"summary":"Deprecated - no alternative required. This operation will always return 'true' for requested toggles","description":"","operationId":"getLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseToggle"},"post":{"tags":["License"],"summary":"Deprecated. No alternative required - this endpoint has no effect","description":"","operationId":"postLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-purecloud-method-name":"postLicenseToggle"}},"/api/v2/license/organization":{"post":{"tags":["License"],"summary":"Update the organization's license assignments in a batch.","description":"","operationId":"postLicenseOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The license assignments to update.","required":false,"schema":{"$ref":"#/definitions/LicenseBatchAssignmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseUpdateStatus"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseOrganization"}},"/api/v2/license/users/{userId}":{"get":{"tags":["License"],"summary":"Get licenses for specified user.","description":"","operationId":"getLicenseUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"getLicenseUser"}},"/api/v2/license/users":{"get":{"tags":["License"],"summary":"Get a page of users and their licenses","description":"Retrieve a page of users in an organization along with the licenses they possess.","operationId":"getLicenseUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicensesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseUsers"},"post":{"tags":["License"],"summary":"Fetch user licenses in a batch.","description":"","operationId":"postLicenseUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user IDs to fetch.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add","authorization:license:view"]},"x-purecloud-method-name":"postLicenseUsers"}},"/api/v2/organizations/limits/changerequests/{requestId}":{"get":{"tags":["Organization"],"summary":"Get a limit change request","description":"","operationId":"getOrganizationsLimitsChangerequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Unique id for the limit change request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitChangeRequestDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequest"}},"/api/v2/organizations/limits/changerequests":{"get":{"tags":["Organization"],"summary":"Get the available limit change requests","description":"Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction.","operationId":"getOrganizationsLimitsChangerequests","produces":["application/json"],"parameters":[{"name":"after","in":"query","description":"Timestamp indicating the date to begin after when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"before","in":"query","description":"Timestamp indicating the date to end before when searching for requests.","required":false,"type":"integer","format":"int64"},{"name":"status","in":"query","description":"Status of the request to be filtered by","required":false,"type":"string","enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},{"name":"pageSize","in":"query","description":"Page Size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["statusHistory"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitChangeRequestsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.override.requests":"Only 100 override requests can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["limits:organization:view"]},"x-purecloud-method-name":"getOrganizationsLimitsChangerequests"}},"/api/v2/organizations/limits/docs":{"get":{"tags":["Organization"],"summary":"Get limit documentation","description":"","operationId":"getOrganizationsLimitsDocs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitDocumentation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocs"}},"/api/v2/organizations/limits/docs/freetrial":{"get":{"tags":["Organization"],"summary":"Get free trial limit documentation","description":"","operationId":"getOrganizationsLimitsDocsFreetrial","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FreeTrialLimitDocs"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsDocsFreetrial"}},"/api/v2/organizations/limits/namespaces":{"get":{"tags":["Organization"],"summary":"Get the available limit namespaces","description":"","operationId":"getOrganizationsLimitsNamespaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":100,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagedNamespaceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaces"}},"/api/v2/organizations/limits/namespaces/{namespaceName}":{"get":{"tags":["Organization"],"summary":"Get the effective limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespace","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespace"}},"/api/v2/organizations/limits/namespaces/{namespaceName}/defaults":{"get":{"tags":["Organization"],"summary":"Get the default limits in a namespace for an organization","description":"","operationId":"getOrganizationsLimitsNamespaceDefaults","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to fetch defaults limits for","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"The provided namespace is not valid or does not have any viewable limits"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsLimitsNamespaceDefaults"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}":{"get":{"tags":["Log Capture"],"summary":"Gets status of async download execution","description":"","operationId":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"In progress - Download execution is in progress.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"download.file.not.found":"No entries found for user; empty file not uploaded","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserEntriesDownloadJob"}},"/api/v2/diagnostics/logcapture/browser/entries/download/jobs":{"post":{"tags":["Log Capture"],"summary":"Creates an async download execution","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"202":{"description":"Accepted - Download execution is accepted.","schema":{"$ref":"#/definitions/LogCaptureDownloadExecutionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs"}},"/api/v2/diagnostics/logcapture/browser/entries/query":{"post":{"tags":["Log Capture"],"summary":"Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.","description":"","operationId":"postDiagnosticsLogcaptureBrowserEntriesQuery","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserEntriesQuery"}},"/api/v2/diagnostics/logcapture/browser/users":{"get":{"tags":["Log Capture"],"summary":"Get all log capture enabled users for an org","description":"","operationId":"getDiagnosticsLogcaptureBrowserUsers","produces":["application/json"],"parameters":[{"name":"includeExpired","in":"query","description":"Include expired users with log captures still available for search or download","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PagelessEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUsers"}},"/api/v2/diagnostics/logcapture/browser/users/{userId}":{"get":{"tags":["Log Capture"],"summary":"Get log capture configuration for the user","description":"","operationId":"getDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to get browser log capture configuration","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture","logcapture:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:view"]},"x-purecloud-method-name":"getDiagnosticsLogcaptureBrowserUser"},"post":{"tags":["Log Capture"],"summary":"Enable log capture for a user or update expiration","description":"","operationId":"postDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to enable browser log capture","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogCaptureUserConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:add"]},"x-purecloud-method-name":"postDiagnosticsLogcaptureBrowserUser"},"delete":{"tags":["Log Capture"],"summary":"Disable browser log capture for the user","description":"","operationId":"deleteDiagnosticsLogcaptureBrowserUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The id of the user to disable browser log capture","required":true,"type":"string"}],"responses":{"204":{"description":"Browser log capture successfully disabled for the user"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["logcapture"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["troubleshooting:logCapture:delete"]},"x-purecloud-method-name":"deleteDiagnosticsLogcaptureBrowserUser"}},"/api/v2/messaging/settings":{"get":{"tags":["Messaging"],"summary":"Get a list of messaging settings","description":"","operationId":"getMessagingSettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingConfigListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettings"},"post":{"tags":["Messaging"],"summary":"Create a messaging setting","description":"","operationId":"postMessagingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:setting:add"]},"x-purecloud-method-name":"postMessagingSettings"}},"/api/v2/messaging/settings/default":{"get":{"tags":["Messaging"],"summary":"Get the organization's default settings that will be used as the default when creating an integration.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"getMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSettingsDefault"},"put":{"tags":["Messaging"],"summary":"Set the organization's default settings that may be applied to an integration when it is created.","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"putMessagingSettingsDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Setting ID","required":true,"schema":{"$ref":"#/definitions/MessagingSettingDefaultRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"putMessagingSettingsDefault"},"delete":{"tags":["Messaging"],"summary":"Delete the organization's default setting, a global default will be applied to integrations without settings","description":"When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.","operationId":"deleteMessagingSettingsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSettingsDefault"}},"/api/v2/messaging/settings/{messageSettingId}":{"get":{"tags":["Messaging"],"summary":"Get a messaging setting","description":"","operationId":"getMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:view"]},"x-purecloud-method-name":"getMessagingSetting"},"delete":{"tags":["Messaging"],"summary":"Delete a messaging setting","description":"","operationId":"deleteMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:delete"]},"x-purecloud-method-name":"deleteMessagingSetting"},"patch":{"tags":["Messaging"],"summary":"Update a messaging setting","description":"","operationId":"patchMessagingSetting","produces":["application/json"],"parameters":[{"name":"messageSettingId","in":"path","description":"Message Settings ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingSetting","required":true,"schema":{"$ref":"#/definitions/MessagingSettingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingSetting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:setting:edit"]},"x-purecloud-method-name":"patchMessagingSetting"}},"/api/v2/messaging/supportedcontent/{supportedContentId}":{"get":{"tags":["Messaging"],"summary":"Get a supported content profile","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"getMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontentSupportedContentId"},"delete":{"tags":["Messaging"],"summary":"Delete a supported content profile","description":"Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"deleteMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"supported.content.in.use":"The supported content profile is in use by an integration","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:delete"]},"x-purecloud-method-name":"deleteMessagingSupportedcontentSupportedContentId"},"patch":{"tags":["Messaging"],"summary":"Update a supported content profile","description":"Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement","operationId":"patchMessagingSupportedcontentSupportedContentId","produces":["application/json"],"parameters":[{"name":"supportedContentId","in":"path","description":"Supported Content ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046 is invalid. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:edit"]},"x-purecloud-method-name":"patchMessagingSupportedcontentSupportedContentId"}},"/api/v2/messaging/supportedcontent":{"get":{"tags":["Messaging"],"summary":"Get a list of Supported Content profiles","description":"Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"getMessagingSupportedcontent","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform","messaging-platform:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:supportedContent:view"]},"x-purecloud-method-name":"getMessagingSupportedcontent"},"post":{"tags":["Messaging"],"summary":"Create a Supported Content profile","description":"Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement","operationId":"postMessagingSupportedcontent","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SupportedContent","required":true,"schema":{"$ref":"#/definitions/SupportedContent"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedContent"}},"201":{"description":"Operation was successful","schema":{"$ref":"#/definitions/SupportedContent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.media.type":"A media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types.","maximum.supported.content.profiles.exceeded":"The maximum number of supported content profiles created for an organization has been exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","maximum.supported.content.media.types.exceeded":"The maximum number of media types defined for the supported content profile has been exceeded","invalid.supported.content":"The supported content request was invalid for this operation. One or more errors may be reported.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging-platform"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["messaging:supportedContent:add"]},"x-purecloud-method-name":"postMessagingSupportedcontent"}},"/api/v2/users/{userId}/verifiers":{"get":{"tags":["Users"],"summary":"Get a list of verifiers","description":"","operationId":"getUserVerifiers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VerifierEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:view"]},"x-purecloud-method-name":"getUserVerifiers"}},"/api/v2/users/{userId}/verifiers/{verifierId}":{"put":{"tags":["Users"],"summary":"Update a verifier","description":"","operationId":"putUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Verifier Update","required":true,"schema":{"$ref":"#/definitions/UpdateVerifierRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Verifier"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:edit"]},"x-purecloud-method-name":"putUserVerifier"},"delete":{"tags":["Users"],"summary":"Delete a verifier","description":"","operationId":"deleteUserVerifier","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"verifierId","in":"path","description":"Verifier ID","required":true,"type":"string"}],"responses":{"204":{"description":"The verifier was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["mfa:verifier:delete"]},"x-purecloud-method-name":"deleteUserVerifier"}},"/api/v2/ipranges":{"get":{"tags":["Utilities"],"summary":"Get public ip address ranges for Genesys Cloud","description":"","operationId":"getIpranges","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressRangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getIpranges"}},"/api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId}":{"get":{"tags":["Web Deployments"],"summary":"Retrieves a cobrowse session","description":"","operationId":"getWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseWebMessagingSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWebdeploymentsDeploymentCobrowseSessionId"},"delete":{"tags":["Web Deployments"],"summary":"Deletes a cobrowse session","description":"","operationId":"deleteWebdeploymentsDeploymentCobrowseSessionId","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"WebMessaging deployment ID","required":true,"type":"string"},{"name":"sessionId","in":"path","description":"Cobrowse session id or join code","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"deleteWebdeploymentsDeploymentCobrowseSessionId"}},"/api/v2/journey/deployments/{deploymentId}/actionevent":{"post":{"tags":["Journey"],"summary":"Sends an action event, which is used for changing the state of actions that have been offered to the user.","description":"","operationId":"postJourneyDeploymentActionevent","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the beacon.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ActionEventRequest"}}],"responses":{"204":{"description":"Successfully transitioned the actions state. This does not return the action."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"There was an issue with this transition. The reason is returned in the body.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","access.denied":"Event Collection is not enabled","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action":"The Action, Deployment, or Session was not was found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.action.state":"Invalid Action state transition"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentActionevent"}},"/api/v2/journey/deployments/{deploymentId}/appevents":{"post":{"tags":["Journey"],"summary":"Send a journey app event, used for tracking customer activity on an application.","description":"","operationId":"postJourneyDeploymentAppevents","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the app event.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AppEventRequest"}}],"responses":{"200":{"description":"Request completed successfully.","schema":{"$ref":"#/definitions/AppEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.exceeded":"The limit allowed has been exceeded for this resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"The app event on the request is older than the start date of the active session and will not be processed."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postJourneyDeploymentAppevents"}},"/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping":{"get":{"tags":["Journey"],"summary":"Send a ping.","description":"","operationId":"getJourneyDeploymentCustomerPing","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the ping.","required":true,"type":"string"},{"name":"customerCookieId","in":"path","description":"ID of the customer associated with the ping.","required":true,"type":"string"},{"name":"dl","in":"query","description":"Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.","required":false,"type":"string"},{"name":"dt","in":"query","description":"Document Title. A human readable name for the page or screen","required":false,"type":"string"},{"name":"appNamespace","in":"query","description":"Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions","required":false,"type":"string"},{"name":"sessionId","in":"query","description":"UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session","required":false,"type":"string"},{"name":"sinceLastBeaconMilliseconds","in":"query","description":"How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeploymentPing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unauthorized to send ping request.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","server.unavailable":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getJourneyDeploymentCustomerPing"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback":{"post":{"tags":["Knowledge"],"summary":"Give feedback on a document","description":"","operationId":"postKnowledgeGuestSessionDocumentFeedback","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document version or variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentFeedback"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get a knowledge document by ID.","description":"","operationId":"getKnowledgeGuestSessionDocument","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocument"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents.","description":"","operationId":"getKnowledgeGuestSessionDocuments","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"categoryId","in":"query","description":"If specified, retrieves documents associated with category ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionDocuments"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views":{"post":{"tags":["Knowledge"],"summary":"Create view event for a document.","description":"","operationId":"postKnowledgeGuestSessionDocumentViews","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentView"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentViews"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies":{"post":{"tags":["Knowledge"],"summary":"Indicate that the document was copied by the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentCopies","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentCopy"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found.","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentCopies"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations":{"post":{"tags":["Knowledge"],"summary":"Indicate that documents were presented to the user.","description":"","operationId":"postKnowledgeGuestSessionDocumentsPresentations","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentPresentation"}}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Document not found","document.variation.not.found":"Document variation not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsPresentations"}},"/api/v2/knowledge/guest/sessions/{sessionId}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeGuestSessionCategories","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"parentId","in":"query","description":"If specified, retrieves the children categories by parent category ID.","required":false,"type":"string"},{"name":"isRoot","in":"query","description":"If specified, retrieves only the root categories.","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically","required":false,"type":"string","default":"Name","enum":["Name","Hierarchy"]},{"name":"expand","in":"query","description":"The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors.","required":false,"type":"string"},{"name":"includeDocumentCount","in":"query","description":"If specified, retrieves the number of documents related to category.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GuestCategoryResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getKnowledgeGuestSessionCategories"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search":{"post":{"tags":["Knowledge"],"summary":"Search the documents in a guest session.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearch","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields, if any, to expand for each document in the search result matching the query.","required":false,"type":"array","items":{"type":"string","enum":["documentVariations","documentAlternatives"]},"collectionFormat":"multi"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentGuestSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentGuestSearch"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"The minimum characters for the query is 3.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearch"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions":{"post":{"tags":["Knowledge"],"summary":"Query the knowledge documents to provide suggestions for auto completion.","description":"","operationId":"postKnowledgeGuestSessionDocumentsSearchSuggestions","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessionDocumentsSearchSuggestions"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}":{"patch":{"tags":["Knowledge"],"summary":"Update search result.","description":"","operationId":"patchKnowledgeGuestSessionDocumentsSearchSearchId","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"name":"searchId","in":"path","description":"Search Result ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SearchUpdateRequest"}}],"responses":{"204":{"description":"Search updated successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid document Id.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.not.found":"Session not found.","not.found":"Search not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"patchKnowledgeGuestSessionDocumentsSearchSearchId"}},"/api/v2/knowledge/guest/sessions":{"post":{"tags":["Knowledge"],"summary":"Create guest session","description":"","operationId":"postKnowledgeGuestSessions","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeGuestSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KnowledgeGuestSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"support.center.knowledge.base.id.not.set":"Knowledge base id is not set in support center configuration (when app.type is SupportCenter).","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","messenger.knowledge.base.not.enabled":"The knowledge base app is not enabled in the messenger deployment (when app.type is MessengerKnowledgeApp).","invalid.context.specified":"The context not found in the knowledgebase.","messenger.knowledge.base.id.not.set":"The knowledge base id is not set in the messenger deployment (when app.type is MessengerKnowledgeApp).","constraint.validation":"%s","app.not.found":"The app not found by deploymentId.","knowledge.base.not.found":"The knowledge base specified in the deployment configuration was not found.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","support.center.not.enabled":"Support center is not enabled in the deployment (when app.type is SupportCenter)."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postKnowledgeGuestSessions"}},"/api/v2/quality/surveys/scorable":{"get":{"tags":["Quality"],"summary":"Get a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"getQualitySurveysScorable","produces":["application/json"],"parameters":[{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.form.context.doesnt.have.valid.published.version":"All published versions of this survey form have been disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getQualitySurveysScorable"},"put":{"tags":["Quality"],"summary":"Update a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"putQualitySurveysScorable","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"survey","required":true,"schema":{"$ref":"#/definitions/ScorableSurvey"}},{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.unauthenticated.already.finished":"The survey is already finished.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"putQualitySurveysScorable"}},"/api/v2/documentation/search":{"get":{"tags":["Search"],"summary":"Search documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationSearch"},"post":{"tags":["Search"],"summary":"Search documentation","description":"","operationId":"postDocumentationSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationSearch"}},"/api/v2/documentation/gkn/search":{"get":{"tags":["Search"],"summary":"Search gkn documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationGknSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationGknSearch"},"post":{"tags":["Search"],"summary":"Search gkn documentation","description":"","operationId":"postDocumentationGknSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GKNDocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationGknSearch"}},"/api/v2/webchat/guest/conversations":{"post":{"tags":["WebChat"],"summary":"Create an ACD chat conversation from an external customer.","description":"This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.\n The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted.\n The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","operationId":"postWebchatGuestConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateConversationRequest","required":true,"schema":{"$ref":"#/definitions/CreateWebChatConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateWebChatConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.journeycontext.customer":"The customer may not be null.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapversion":"The actionmapversion property may not be null.","chat.error.invalid.queue":"The specified queue is not valid.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionid":"The actionid property may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","chat.error.notnull.createconversationrequest.journeycontext.customer.customerid":"The customerid property may not be null.","constraint.validation":"%s","chat.error.notnull.createconversationrequest.memberinfo.displayname":"The displayname property may not be null.","chat.error.notnull.createconversationrequest.routingtarget":"The routingtarget property may not be null.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","chat.error.notnull.createconversationrequest.journeycontext.customer.customeridtype":"The customeridtype property may not be null.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","chat.deployment.require.auth":"The deployment requires the customer member to be authenticated.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionid":"The sessionid property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionidtype":"The sessionidtype property may not be null.","chat.deployment.bad.auth":"The customer member authentication has failed.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapid":"The actionmapid property may not be null.","chat.error.createconversationrequest.routingtarget":"The routing target is not valid.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.deployment.disabled":"The web chat deployment is currently disabled.","chat.error.pattern.createconversationrequest.deploymentid":"The deploymentid property may not be null.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.invalid.flow":"Invalid chat flow","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.bad.request":"Error occurred due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"origin.not.allowed":"Not allowed to create an ACD chat conversation from an external customer.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"caht.error":"Error performing chat conversation operation.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.service.timeout":"Chat service timeout error.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebchatGuestConversations"}},"/api/v2/webdeployments/token/refresh":{"post":{"tags":["Web Deployments"],"summary":"Refresh a JWT.","description":"","operationId":"postWebdeploymentsTokenRefresh","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WebDeploymentsRefreshJWTRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenRefresh"}},"/api/v2/webdeployments/token/oauthcodegrantjwtexchange":{"post":{"tags":["Web Deployments"],"summary":"Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.","description":"","operationId":"postWebdeploymentsTokenOauthcodegrantjwtexchange","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webDeploymentsOAuthExchangeRequest","required":true,"schema":{"$ref":"#/definitions/WebDeploymentsOAuthExchangeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentsAuthorizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebdeploymentsTokenOauthcodegrantjwtexchange"}},"/api/v2/workforcemanagement/calendar/data/ics":{"get":{"tags":["Workforce Management"],"summary":"Get ics formatted calendar based on shareable link","description":"","operationId":"getWorkforcemanagementCalendarDataIcs","produces":["text/calendar"],"parameters":[{"name":"calendarId","in":"query","description":"The id of the ics-formatted calendar","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Query parameter did not pass validation","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden form getting calendar","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Calendar ICS not found","not.found":"The requested entity was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getWorkforcemanagementCalendarDataIcs"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getNotificationsAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","enforced","schema","visibility","transports","publicApiTemplateUriPaths","requiresPermissions","permissionDetails","topicParameters"]},"collectionFormat":"multi"},{"name":"includePreview","in":"query","description":"Whether or not to include Preview topics","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsAvailabletopics"}},"/api/v2/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getNotificationsChannels","produces":["application/json"],"parameters":[{"name":"includechannels","in":"query","description":"Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence.","required":false,"type":"string","default":"token","enum":["token","oauthclient"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.","operationId":"postNotificationsChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannels"}},"/api/v2/notifications/channels/{channelId}":{"head":{"tags":["Notifications"],"summary":"Verify a channel still exists and is valid","description":"Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't","operationId":"headNotificationsChannel","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"headNotificationsChannel"}},"/api/v2/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannelSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}},{"name":"ignoreErrors","in":"query","description":"Optionally prevent throwing of errors for failed permissions checks.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions","notification.transport.not.allowed":"unable to subscribe, transport type not permitted.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","notification.unable.to.get.channel.id":"Unable to get channel Id.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannelSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}},{"name":"ignoreErrors","in":"query","description":"Optionally prevent throwing of errors for failed permissions checks.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","notification.unable.to.get.channel.id":"Unable to get channel id.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","notification.forbidden.topic":"Topic is forbidden","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"putNotificationsChannelSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"deleteNotificationsChannelSubscriptions"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putIdentityprovidersAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersAdfs"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putIdentityprovidersCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersCic"}},"/api/v2/identityproviders/gsuite":{"get":{"tags":["Identity Provider"],"summary":"Get G Suite Identity Provider","description":"","operationId":"getIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GSuite"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGsuite"},"put":{"tags":["Identity Provider"],"summary":"Update/Create G Suite Identity Provider","description":"","operationId":"putIdentityprovidersGsuite","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GSuite"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGsuite"},"delete":{"tags":["Identity Provider"],"summary":"Delete G Suite Identity Provider","description":"","operationId":"deleteIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGsuite"}},"/api/v2/identityproviders/generic":{"get":{"tags":["Identity Provider"],"summary":"Get Generic SAML Identity Provider","description":"","operationId":"getIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenericSAML"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGeneric"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Generic SAML Identity Provider","description":"","operationId":"putIdentityprovidersGeneric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GenericSAML"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a generic SAML provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGeneric"},"delete":{"tags":["Identity Provider"],"summary":"Delete Generic SAML Identity Provider","description":"","operationId":"deleteIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGeneric"}},"/api/v2/identityproviders/identitynow":{"get":{"tags":["Identity Provider"],"summary":"Get IdentityNow Provider","description":"","operationId":"getIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersIdentitynow"},"put":{"tags":["Identity Provider"],"summary":"Update/Create IdentityNow Provider","description":"","operationId":"putIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/IdentityNow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersIdentitynow"},"delete":{"tags":["Identity Provider"],"summary":"Delete IdentityNow Provider","description":"","operationId":"deleteIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersIdentitynow"}},"/api/v2/identityproviders/{providerId}":{"get":{"tags":["Identity Provider"],"summary":"Get Identity Provider","description":"","operationId":"getIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovider"},"put":{"tags":["Identity Provider"],"summary":"Update Identity Provider","description":"","operationId":"putIdentityprovider","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}},{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovider"},"delete":{"tags":["Identity Provider"],"summary":"Delete Identity Provider","description":"","operationId":"deleteIdentityprovider","produces":["application/json"],"parameters":[{"name":"providerId","in":"path","description":"Provider ID","required":true,"type":"string"}],"responses":{"204":{"description":"The provider has been deleted successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovider"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityproviders"},"post":{"tags":["Identity Provider"],"summary":"Create Identity Provider","description":"","operationId":"postIdentityproviders","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomProvider"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add"]},"x-purecloud-method-name":"postIdentityproviders"}},"/api/v2/oauth/authorizations/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get a client that is authorized by the resource owner","description":"","operationId":"getOauthAuthorization","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"},{"name":"clientId","in":"path","description":"The ID of client","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorization"}},"/api/v2/oauth/authorizations":{"get":{"tags":["OAuth"],"summary":"List clients that have been authorized, requested, or revoked by the resource owner","description":"","operationId":"getOauthAuthorizations","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language in which to display the client descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorizations"}},"/api/v2/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClient"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"Client is disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"putOauthClient"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.client":"Clients must be marked as inactive to be eligible for deletion."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:delete"]},"x-purecloud-method-name":"deleteOauthClient"}},"/api/v2/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postOauthClientSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"postOauthClientSecret"}},"/api/v2/oauth/clients/{clientId}/usage/query":{"post":{"tags":["OAuth","Usage"],"summary":"Query for OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postOauthClientUsageQuery","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageClientQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"postOauthClientUsageQuery"}},"/api/v2/oauth/clients/{clientId}/usage/summary":{"get":{"tags":["OAuth","Usage"],"summary":"Get a summary of OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"getOauthClientUsageSummary","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"name":"days","in":"query","description":"Previous number of days to query","required":false,"type":"string","default":"7"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageSummary"}},"/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}":{"get":{"tags":["OAuth","Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getOauthClientUsageQueryResult","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"},{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:client:view"]},"x-purecloud-method-name":"getOauthClientUsageQueryResult"}},"/api/v2/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getOauthClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postOauthClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.client.role":"Client role is invalid.","bad.client.state":"New clients can only have an active state","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","bad.grant.type":"Invalid grant type.","auth.invalid.scope":"Client has invalid scope","constraint.validation":"%s","grant.type.required":"Grant type is required.","missing.client.scope":"Client scope is missing.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","auth.too.many.clients":"Too many clients exist in this organization.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","missing.client.roles":"Client roles and divisions are missing.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:add"]},"x-purecloud-method-name":"postOauthClients"}},"/api/v2/oauth/scopes/{scopeId}":{"get":{"tags":["OAuth"],"summary":"An OAuth scope","description":"","operationId":"getOauthScope","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"Scope ID","required":true,"type":"string"},{"name":"Accept-Language","in":"header","description":"The language with which to display the scope description.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScope"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScope"}},"/api/v2/oauth/scopes":{"get":{"tags":["OAuth"],"summary":"The list of OAuth scopes","description":"","operationId":"getOauthScopes","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language with which to display the scope descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScopeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScopes"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"summary":"Get Okta Identity Provider","description":"","operationId":"getIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOkta"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putIdentityprovidersOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOkta"},"delete":{"tags":["Identity Provider"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOkta"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOnelogin"},"put":{"tags":["Identity Provider"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putIdentityprovidersOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOnelogin"},"delete":{"tags":["Identity Provider"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOnelogin"}},"/api/v2/identityproviders/ping":{"get":{"tags":["Identity Provider"],"summary":"Get Ping Identity Provider","description":"","operationId":"getIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PingIdentity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPing"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Ping Identity Provider","description":"","operationId":"putIdentityprovidersPing","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PingIdentity"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPing"},"delete":{"tags":["Identity Provider"],"summary":"Delete Ping Identity Provider","description":"","operationId":"deleteIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPing"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPurecloud"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putIdentityprovidersPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPurecloud"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deleteIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPurecloud"}},"/api/v2/identityproviders/pureengage":{"get":{"tags":["Identity Provider"],"summary":"Get PureEngage Identity Provider","description":"","operationId":"getIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureEngage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPureengage"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureEngage Identity Provider","description":"","operationId":"putIdentityprovidersPureengage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureEngage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPureengage"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureEngage Identity Provider","description":"","operationId":"deleteIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPureengage"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersSalesforce"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putIdentityprovidersSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.target.url":"The target URL must be a valid HTTPS URL.","invalid.property":"Value [%s] is not a valid property for object [%s]","certificate.unparseable":"The certificate for provider cannot be parsed.","constraint.validation":"%s","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersSalesforce"},"delete":{"tags":["Identity Provider"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersSalesforce"}},"/api/v2/usage/events/definitions":{"get":{"tags":["Operational Events"],"summary":"Get all operational event definitions","description":"","operationId":"getUsageEventsDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinitions"}},"/api/v2/usage/events/definitions/{eventDefinitionId}":{"get":{"tags":["Operational Events"],"summary":"Get an operational event definition by its id","description":"","operationId":"getUsageEventsDefinition","produces":["application/json"],"parameters":[{"name":"eventDefinitionId","in":"path","description":"EventDefinition id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Event definition not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["usage","usage:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["usage:events:view"]},"x-purecloud-method-name":"getUsageEventsDefinition"}},"/api/v2/organizations/embeddedintegration":{"get":{"tags":["Organization"],"summary":"Get the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsEmbeddedintegration"},"put":{"tags":["Organization"],"summary":"Update the list of domains that will be allowed to embed PureCloud applications","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/EmbeddedIntegration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsEmbeddedintegration"}},"/api/v2/organizations/ipaddressauthentication":{"get":{"tags":["Organization"],"summary":"Get organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"getOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsIpaddressauthentication"},"put":{"tags":["Organization"],"summary":"Update organization IP address whitelist settings","description":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","operationId":"putOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"IP address Whitelist settings","required":true,"schema":{"$ref":"#/definitions/IpAddressAuthentication"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.issuing.ip.address":"IP address whitelisting cannot be configured with a token that was issued outside of the allowed ranges.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.ip.address":"IP address whitelisting cannot be configured from outside of the allowed ranges.","invalid.host.address":"IP address whitelisting cannot be configured via requests made to this host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsIpaddressauthentication"}},"/api/v2/organizations/whitelist":{"get":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"getOrganizationsWhitelist","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsWhitelist"},"put":{"tags":["Organization"],"summary":"This route is deprecated, please use /api/v2/organizations/authentication/settings instead","description":"","operationId":"putOrganizationsWhitelist","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/OrgWhitelistSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsWhitelist"}},"/api/v2/organizations/authentication/settings":{"get":{"tags":["Organization"],"summary":"Gets the organization's settings","description":"","operationId":"getOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsAuthenticationSettings"},"patch":{"tags":["Organization"],"summary":"Update the organization's settings","description":"","operationId":"patchOrganizationsAuthenticationSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Org settings","required":true,"schema":{"$ref":"#/definitions/OrgAuthSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgAuthSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsAuthenticationSettings"}},"/api/v2/orgauthorization/trustees/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustee Audits","description":"","operationId":"postOrgauthorizationTrusteesAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrusteeAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Cloned User","description":"","operationId":"getOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorCloneduser"},"put":{"tags":["Organization Authorization"],"summary":"Creates a clone of the trustee user in the trustor org.","description":"","operationId":"putOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorCloneduser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Cloned User","description":"","operationId":"deleteOrgauthorizationTrustorCloneduser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorCloneduser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users in the trustor organization (i.e. users with a native user record).","description":"","operationId":"getOrgauthorizationTrustorClonedusers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorClonedusers"}},"/api/v2/orgauthorization/trustees/default":{"get":{"tags":["Organization Authorization"],"summary":"Get organization authorization trust with Customer Care, if one exists.","description":"","operationId":"getOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteesDefault"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.","description":"","operationId":"postOrgauthorizationTrusteesDefault","produces":["application/json"],"parameters":[{"name":"assignDefaultRole","in":"query","description":"Assign Admin role to default pairing with Customer Care","required":false,"type":"boolean"},{"name":"autoExpire","in":"query","description":"Automatically expire pairing after 30 days","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.fields.validation.error":"One or more required properties are missing","self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesDefault"}},"/api/v2/orgauthorization/pairings/{pairingId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Pairing Info","description":"","operationId":"getOrgauthorizationPairing","produces":["application/json"],"parameters":[{"name":"pairingId","in":"path","description":"Pairing Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationPairing"}},"/api/v2/orgauthorization/pairings":{"post":{"tags":["Organization Authorization"],"summary":"A pairing id is created by the trustee and given to the trustor to create a trust.","description":"","operationId":"postOrgauthorizationPairings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Pairing Info","required":true,"schema":{"$ref":"#/definitions/TrustRequestCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:add"]},"x-purecloud-method-name":"postOrgauthorizationPairings"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrusteeGroup","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroup"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group Roles","description":"","operationId":"getOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroupRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee Group Roles","description":"","operationId":"putOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeGroupRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group Roles","description":"","operationId":"deleteOrgauthorizationTrusteeGroupRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeGroupId","in":"path","description":"Trustee Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeGroupRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee groups for this organization (i.e. groups granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeGroups"},"post":{"tags":["Organization Authorization"],"summary":"Add a group to the trust.","description":"","operationId":"postOrgauthorizationTrusteeGroups","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeGroups"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustee"},"put":{"tags":["Organization Authorization"],"summary":"Update Org Trust","description":"","operationId":"putOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/TrustUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrustee"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustee"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUser"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoledivisions"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User Roles","description":"","operationId":"getOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUserRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User Roles","description":"","operationId":"deleteOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUserRoles"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee users for this organization (i.e. users granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUsers"},"post":{"tags":["Organization Authorization"],"summary":"Add a user to the trust.","description":"","operationId":"postOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","trustee.user.not.found":"Trustee user not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeUsers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers":{"get":{"tags":["Organization Authorization"],"summary":"The list of cloned users from the trustee organization (i.e. users with a native user record).","description":"There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged","operationId":"getOrgauthorizationTrusteeClonedusers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClonedUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeClonedusers"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}":{"delete":{"tags":["Organization Authorization"],"summary":"Deletes cloned user","description":"","operationId":"deleteOrgauthorizationTrusteeCloneduser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Id of the cloned user to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Cloned user successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeCloneduser"}},"/api/v2/orgauthorization/trustor/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustor Audits","description":"","operationId":"postOrgauthorizationTrustorAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrustorAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrustorAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee Group","description":"","operationId":"getOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroup"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee Group to the trust.","description":"","operationId":"putOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeGroup:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorGroup"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee Group","description":"","operationId":"deleteOrgauthorizationTrustorGroup","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trustorGroupId","in":"path","description":"Trustor Group Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorGroup"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/groups":{"get":{"tags":["Organization Authorization"],"summary":"The list of groups in the trustor organization (i.e. groups granted access).","description":"","operationId":"getOrgauthorizationTrustorGroups","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeGroup:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorGroups"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustor"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustor"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUser"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee user to the trust.","description":"","operationId":"putOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorUser"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of users in the trustor organization (i.e. users granted access).","description":"","operationId":"getOrgauthorizationTrustorUsers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUsers"}},"/api/v2/orgauthorization/trustors":{"get":{"tags":["Organization Authorization"],"summary":"The list of organizations that have authorized/trusted your organization.","description":"","operationId":"getOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustors"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustors","description":"","operationId":"deleteOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustor ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustors deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"min.trustor.ids":"Minimum of 1 Trustor Org Id required.","max.trustor.ids":"Only 25 Trustors can be deleted at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustors","x-genesys-preview":true}},"/api/v2/orgauthorization/trustees":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustees for this organization (i.e. organizations granted access to this organization).","description":"","operationId":"getOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustees"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust. This is required to grant other organizations access to your organization.","description":"","operationId":"postOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","pairing.id.required":"A valid pairingId is required.","invalid.property":"Value [%s] is not a valid property for object [%s]","trustee.user.or.group.required":"Trustee user or group required","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","trustee.user.required":"At least one trustee user is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrustees"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Bulk Org Trustees","description":"","operationId":"deleteOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma separated list of trustee ids to remove","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Trustees deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","min.trustee.ids":"Minimum of 1 Trustee Org Id required.","max.trustee.ids":"Only 25 Trustees can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustees","x-genesys-preview":true}},"/api/v2/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"User was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated OutOffOffice","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserOutofoffice"}},"/api/v2/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueEstimatedwaittime"}},"/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueMediatypeEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"mediaType","in":"path","description":"mediaType","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueMediatypeEstimatedwaittime"}},"/api/v2/users/presences/purecloud/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source","description":"","operationId":"getUsersPresencesPurecloudBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresencesPurecloudBulk"}},"/api/v2/users/presences/{sourceId}/bulk":{"get":{"tags":["Presence"],"summary":"Get bulk user presences for a single presence source","description":"","operationId":"getUsersPresenceBulk","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"The requested presence source ID.","required":true,"type":"string"},{"name":"id","in":"query","description":"A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UcUserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be queried at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUsersPresenceBulk"}},"/api/v2/users/presences/bulk":{"put":{"tags":["Presence"],"summary":"Update bulk user Presences","description":"","operationId":"putUsersPresencesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/MutableUserPresence"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 50 user presences can be updated at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","endpoint.does.not.support.on.queue":"The endpoint does not support updating to the ON_QUEUE presence"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:userPresence:edit"]},"x-purecloud-method-name":"putUsersPresencesBulk"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"getPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresencedefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)","description":"","operationId":"putPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresencedefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead","description":"","operationId":"deletePresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:delete"]},"x-purecloud-method-name":"deletePresencedefinition"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted query can be TRUE, FALSE or ALL","required":false,"type":"string","default":"false"},{"name":"localeCode","in":"query","description":"The locale code to fetch for each presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresencedefinitions"}},"/api/v2/presence/definitions/{definitionId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","description":"","operationId":"getPresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","description":"","operationId":"putPresenceDefinition","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Definition","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresenceDefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","description":"","operationId":"deletePresenceDefinition","produces":["application/json"],"parameters":[{"name":"definitionId","in":"path","description":"Presence Definition ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence Definition successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.organizationpresencenotfound":"The presence definition does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:presenceDefinition:delete","presence:presenceDefinition:edit"]},"x-purecloud-method-name":"deletePresenceDefinition"}},"/api/v2/presence/definitions":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Definitions","description":"","operationId":"getPresenceDefinitions","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"},{"name":"divisionId","in":"query","description":"One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string","enum":["ALL","he","fr","en_US","da","de","it","cs","es","fi","ar","ja","ko","nl","no","pl","pt_BR","pt_PT","ru","sv","th","tr","uk","zh_CN","zh_TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinitionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:view"]},"x-purecloud-method-name":"getPresenceDefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresenceDefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationpresence.localevaluesinvalid":"Invalid locale value","presenceservice.organizationpresence.musthaveatleastonelocalelabeldefined":"At least one locale label must be defined","presenceservice.organizationpresence.systempresencecannotbenull":"A valid system presence must be provided","presenceservice.organizationpresence.invaliddivisionid":"Invalid divisionId provided","presenceservice.organizationpresence.toomanyorganizationpresences":"Too many presence definitions. Please delete a definition and try again"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresenceDefinitions"}},"/api/v2/presence/settings":{"get":{"tags":["Presence"],"summary":"Get the presence settings","description":"","operationId":"getPresenceSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:view"]},"x-purecloud-method-name":"getPresenceSettings"},"put":{"tags":["Presence"],"summary":"Update the presence settings","description":"","operationId":"putPresenceSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Presence Settings","required":true,"schema":{"$ref":"#/definitions/PresenceSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationconfiguration.invalidrestoretimemilliseconds":"Restore time value out of bounds","presenceservice.organizationconfiguration.restorepresenceconfigurationnotprovided":"A restore configuration object must be provided"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:settings:edit"]},"x-purecloud-method-name":"putPresenceSettings"}},"/api/v2/presence/sources/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Source","description":"","operationId":"getPresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSource"},"put":{"tags":["Presence"],"summary":"Update a Presence Source","description":"","operationId":"putPresenceSource","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated Presence Source","required":true,"schema":{"$ref":"#/definitions/Source"}},{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.sourcenotfound":"The source was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.systemsourcescannotbeupdated":"A source of type 'system' cannot be updated","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:edit"]},"x-purecloud-method-name":"putPresenceSource"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Source","description":"","operationId":"deletePresenceSource","produces":["application/json"],"parameters":[{"name":"sourceId","in":"path","description":"Presence Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"Presence source successfully deactivated."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.systemsourcescannotbedeleted":"A source of type 'system' cannot be deleted"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["presence:source:delete","presence:source:edit"]},"x-purecloud-method-name":"deletePresenceSource"}},"/api/v2/presence/sources":{"get":{"tags":["Presence"],"summary":"Get a list of Presence Sources","description":"","operationId":"getPresenceSources","produces":["application/json"],"parameters":[{"name":"deactivated","in":"query","description":"Deactivated query can be TRUE or FALSE","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SourceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:view"]},"x-purecloud-method-name":"getPresenceSources"},"post":{"tags":["Presence"],"summary":"Create a Presence Source","description":"","operationId":"postPresenceSources","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Source to create","required":true,"schema":{"$ref":"#/definitions/Source"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Source"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","presenceservice.source.descriptiontoolong":"Description exceeded max character count","presenceservice.source.nametoolong":"Name exceeded max character count","presenceservice.source.toomanyactivesources":"Max number of active sources reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:source:add"]},"x-purecloud-method-name":"postPresenceSources"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SystemPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getSystempresences"}},"/api/v2/users/{userId}/presences/purecloud":{"get":{"tags":["Presence"],"summary":"Get a user's Genesys Cloud presence.","description":"Get the default Genesys Cloud user presence source PURECLOUD","operationId":"getUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresencesPurecloud"},"patch":{"tags":["Presence"],"summary":"Patch a Genesys Cloud user's presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresencesPurecloud"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.","operationId":"getUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresence"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presence.not.authorized.update.other.user.presence":"Not authorized to update another user's presence","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","presence.not.authorized.update.on.queue":"Not authorized to update presence to ON_QUEUE","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresence"}},"/api/v2/presence/users/{userId}/primarysource":{"get":{"tags":["Presence"],"summary":"Get a user's Primary Presence Source","description":"","operationId":"getPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:view"]},"x-purecloud-method-name":"getPresenceUserPrimarysource"},"put":{"tags":["Presence"],"summary":"Update a user's Primary Presence Source","description":"","operationId":"putPresenceUserPrimarysource","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Primary Source","required":true,"schema":{"$ref":"#/definitions/UserPrimarySource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPrimarySource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:userPrimarySource:edit"]},"x-purecloud-method-name":"putPresenceUserPrimarysource"}},"/api/v2/processautomation/triggers/topics/{topicName}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of all organization Triggers on given topic using provided event body","description":"","operationId":"postProcessautomationTriggersTopicTest","produces":["application/json"],"parameters":[{"name":"topicName","in":"path","description":"topicName","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeEventResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggersTopicTest"}},"/api/v2/processautomation/triggers/topics":{"get":{"tags":["Process Automation"],"summary":"Get topics available for organization","description":"","operationId":"getProcessautomationTriggersTopics","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggersTopics"}},"/api/v2/processautomation/triggers/{triggerId}":{"get":{"tags":["Process Automation"],"summary":"Retrieve a single Trigger matching id","description":"","operationId":"getProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTrigger"},"put":{"tags":["Process Automation"],"summary":"Update a Trigger","description":"","operationId":"putProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)","required":true,"schema":{"$ref":"#/definitions/UpdateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit"]},"x-purecloud-method-name":"putProcessautomationTrigger"},"delete":{"tags":["Process Automation"],"summary":"Delete a Trigger","description":"","operationId":"deleteProcessautomationTrigger","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:delete"]},"x-purecloud-method-name":"deleteProcessautomationTrigger"}},"/api/v2/processautomation/triggers/{triggerId}/test":{"post":{"tags":["Process Automation"],"summary":"Test the matching of a Trigger based on provided event body","description":"","operationId":"postProcessautomationTriggerTest","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"},{"in":"body","name":"body","description":"eventBody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestModeResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:test"]},"x-purecloud-method-name":"postProcessautomationTriggerTest"}},"/api/v2/processautomation/triggers":{"get":{"tags":["Process Automation"],"summary":"Retrieves all triggers, optionally filtered by query parameters.","description":"","operationId":"getProcessautomationTriggers","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"topicName","in":"query","description":"Topic name(s). Separated by commas","required":false,"type":"string"},{"name":"enabled","in":"query","description":"Boolean indicating desired enabled state of triggers","required":false,"type":"boolean"},{"name":"hasDelayBy","in":"query","description":"Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TriggerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation","process-automation:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:edit","processautomation:trigger:view"]},"x-purecloud-method-name":"getProcessautomationTriggers"},"post":{"tags":["Process Automation"],"summary":"Create a Trigger","description":"","operationId":"postProcessautomationTriggers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create a Trigger.","required":true,"schema":{"$ref":"#/definitions/CreateTriggerRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trigger"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["process-automation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["processautomation:trigger:add"]},"x-purecloud-method-name":"postProcessautomationTriggers"}},"/api/v2/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users","operationId":"getQualityAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents requested","required":false,"type":"string"},{"name":"formContextId","in":"query","description":"shared id between form versions","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityAgentsActivity"}},"/api/v2/recording/batchrequests/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status and results for a batch request job, only the user that submitted the job may retrieve results","description":"","operationId":"getRecordingBatchrequest","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobStatusResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","batch.download.permission.denied":"Only user that initiated the job can request results","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","batch.download.job.not.found":"The requested job is unknown"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"getRecordingBatchrequest"}},"/api/v2/recording/batchrequests":{"post":{"tags":["Recording"],"summary":"Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.","description":"","operationId":"postRecordingBatchrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job submission criteria","required":true,"schema":{"$ref":"#/definitions/BatchDownloadJobSubmission"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobSubmissionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.too.many.items":"Too many items requested, max 100 allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","batch.download.bad.request":"Request list is required and must not be empty","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"postRecordingBatchrequests"}},"/api/v2/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id. Requires either calibrator id or conversation id","description":"","operationId":"getQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","quality.calibration.view.permission.check.failed":"calibration view permission check failed","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibration"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":true,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.already.exists":"evaluation already exists","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.update.permission.check.failed":"calibration update permission check failed","quality.calibration.scoring.index.conversation.mismatch":"calibration scoring index did not match the expected value.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:edit"]},"x-purecloud-method-name":"putQualityCalibration"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.calibration.delete.permission.check.failed":"calibration delete permission check failed"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:delete"]},"x-purecloud-method-name":"deleteQualityCalibration"}},"/api/v2/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.","operationId":"getQualityCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postQualityCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":true,"schema":{"$ref":"#/definitions/CalibrationCreate"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.no.evaluation.form.or.context.id":"evaluation form or context id missing","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.calibration.create.error.no.evaluators":"Failed to create calibration because the specified evaluators do not exist.","quality.evaluation.agent.doesnt.have.participate.permission":"Agent does not have evaluation participate permission","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.form.context.doesnt.exist":"Evaluation form context doesn't exist","quality.calibration.scoring.index.evaluator.must.match.calibrator.or.expert.evaluator":"scoring index evaluator must be a calibrator or expert evaluator","qm.calibration.create.error.no.agent":"Failed to create calibration because the conversation has no agent user","constraint.validation":"%s","quality.calibration.existing.evaluation.not.finished":"Existing evaluation is not finished for calibration","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","quality.calibration.no.existing.evaluation.for.evaluationid":"no evaluation found for existing evaluation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.calibration.contextid.doesnt.match.evaluation.contextid":"Calibration contextId doesn't match the evaluation contextId","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.conversation.doesnt.exist":"unable to find specified conversation","qm.calibration.create.error.no.conversation":"Failed to create calibration because the specified conversation does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.calibration.create.permission.check.failed":"Calibration create permission check failed","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:add"]},"x-purecloud-method-name":"postQualityCalibrations"}},"/api/v2/quality/conversations/audits/query/{transactionId}/results":{"get":{"tags":["Quality"],"summary":"Get results of audit query","description":"","operationId":"getQualityConversationsAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionIdResults"}},"/api/v2/quality/conversations/audits/query":{"post":{"tags":["Quality"],"summary":"Create audit query execution","description":"","operationId":"postQualityConversationsAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QMAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"postQualityConversationsAuditsQuery"}},"/api/v2/quality/conversations/audits/query/{transactionId}":{"get":{"tags":["Quality"],"summary":"Get status of audit query execution","description":"","operationId":"getQualityConversationsAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"Query execution completed.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/QualityAuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:interactionDetails:view"]},"x-purecloud-method-name":"getQualityConversationsAuditsQueryTransactionId"}},"/api/v2/recordings/deletionprotection":{"post":{"tags":["Recording"],"summary":"Get a list of conversations with protected recordings","description":"","operationId":"postRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"conversationIds","required":true,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.id.not.uuid":"Request needs recording conversation ID not UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings:readonly"]}],"x-purecloud-method-name":"postRecordingsDeletionprotection"},"put":{"tags":["Recording"],"summary":"Apply or revoke recording protection for conversations","description":"","operationId":"putRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"name":"protect","in":"query","description":"Check for apply, uncheck for revoke (each action requires the respective permission)","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.empty.payload":"Recording payload was empty.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:deletionProtection:apply","recording:deletionProtection:revoke"]},"x-purecloud-method-name":"putRecordingsDeletionprotection"}},"/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, assignee, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view","quality:evaluation:assign","quality:evaluation:release"]},"x-purecloud-method-name":"getQualityConversationEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.","operationId":"putQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm, assignee, evaluator","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","quality.evaluation.cannot.change.evaluation.form":"Cannot change evaluation form","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.cannot.change.evaluationid":"Cannot change evaluationId","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have participate permission.","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.invalid.state.non.pending.to.pending":"Invalid state, non pending to pending","quality.evaluation.agent.doesnt.exist":"Agent doesn't exist","quality.evaluation.cannot.have.different.assignee.and.evaluator":"Evaluation has an invalid combination of evaluator & assignee ids","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.no.answers.for.state":"No answers were found for state.","quality.evaluation.cannot.change.conversation":"Cannot change conversation","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.assignee.not.provided":"Evaluation has missing assignee user","quality.evaluation.cannot.assign.released.evaluation":"Evaluation cannot be assigned in completed & released state.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.calibration.and.release.date.both.set":"Calibration and release date both set","quality.evaluation.cannot.change.calibration":"Cannot change calibration","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.evaluation.required.answers.for.state":"Answers are required for state","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.too.old.to.score":"Evaluation is too old to score"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","quality.evaluation.update.permission.check.failed":"Missing evaluation update permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.cannot.change.assignee":"User has insufficient permissions to update assignee","quality.evaluation.assignee.permission.check.failed":"Assignee has insufficient permissions","quality.evaluation.cannot.update.private.comments":"User has insufficient permissions to update private comments"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.no.answer.for.state":"No answers for state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:edit","quality:evaluation:editScore","quality:evaluation:editAgentSignoff"]},"x-purecloud-method-name":"putQualityConversationEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.delete.permission.check.failed":"Failed evaluation deletion permission check","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:delete"]},"x-purecloud-method-name":"deleteQualityConversationEvaluation"}},"/api/v2/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postQualityConversationEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/EvaluationCreateBody"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have required permission to participate","constraint.validation":"%s","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.answers.for.pending.state":"Evaluation answers for pending state.","quality.evaluation.agent.doesnt.exist":"Agent user does not exist","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.already.exists":"An evaluation for this conversation already exists","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.evaluation.for.pending.state":"Answers required for pending state","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.evaluation.no.answers.for.finished.state":"No answers for finished state","quality.evaluation.create.limit.exceeded.for.agent":"Evaluation creation limit exceeded for agent","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","qm.evaluation.create.error.no.evaluator":"Submitted evaluation missing evaluator","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.conversation.doesnt.exist":"Quality conversation does not exist.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.form.not.published":"Evaluation form is not published"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","quality.evaluation.create.permission.check.failed":"Failed evaluation creation permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:add"]},"x-purecloud-method-name":"postQualityConversationEvaluations"}},"/api/v2/quality/conversations/{conversationId}/surveys":{"get":{"tags":["Quality"],"summary":"Get the surveys for a conversation","description":"","operationId":"getQualityConversationSurveys","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Survey"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Query conversation was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualityConversationSurveys"}},"/api/v2/quality/evaluations/aggregates/query/me":{"post":{"tags":["Quality"],"summary":"Query for evaluation aggregates for the current user","description":"","operationId":"postQualityEvaluationsAggregatesQueryMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQueryMe"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postQualityEvaluationsAggregatesQueryMe"}},"/api/v2/quality/forms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityFormsEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsEvaluation"}},"/api/v2/quality/forms/evaluations/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormsEvaluationVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationVersions"}},"/api/v2/quality/forms/evaluations/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest published evaluation form versions by context ids","description":"","operationId":"getQualityFormsEvaluationsBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid evaluation form context ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EvaluationFormResponse"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.no.ids.bulk.fetch":"You must specify at least 1 id","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","evaluation.too.many.ids.bulk.fetch":"You may only specify 100 or less ids","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationsBulkContexts"}},"/api/v2/quality/forms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.\nIn addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.","operationId":"getQualityFormsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluations"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityFormsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","evaluation.form.invalid":"Evaluation form is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.too.many.questions":"Evaluation form has too many questions","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityFormsEvaluations"}},"/api/v2/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.","operationId":"getQualityEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"NOTE: Does not work when querying evaluations","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"NOTE: Does not work when querying evaluations","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"assigneeUserId","in":"query","description":"assignee user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"formContextId","in":"query","description":"shared id between form versions","required":false,"type":"string"},{"name":"evaluationState","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"the maximum number of results to return","required":false,"type":"integer","format":"int32"},{"name":"sortOrder","in":"query","description":"NOTE: Does not work when conversationId is supplied.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.query.invalid.user":"User does not exist","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation":"Quality query needs one agent, evaluator, or assignee, or conversation.","quality.query.spec.one.of.agent.or.evaluator.or.assignee.or.conversation.or.team":"Quality query needs one agent, evaluator, assignee, conversation, agent team.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.backend.service.timeout":"Backend service timeout","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluationsQuery"}},"/api/v2/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postQualityEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":true,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","general.bad.request":"Request is badly formed.","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualityEvaluationsScoring"}},"/api/v2/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getQualityEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"},{"name":"agentTeamId","in":"query","description":"team id of agents to be considered","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qmevaluatoractivity.search.too.many.results":"Too many results in evaluator activity query; user needs to enter more characters for name search","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","qmevaluatoractivity.pagenum.too.big":"Page number too large in evaluator activity query","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","qmevaluatoractivity.pagenum.too.small":"Page number too small in evaluator activity query; cannot be < 1"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluatorsActivity"}},"/api/v2/orphanrecordings/{orphanId}/media":{"get":{"tags":["Recording"],"summary":"Gets the media of a single orphan recording","description":"A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.","operationId":"getOrphanrecordingMedia","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"202":{"description":"Accepted - Transcoding orphan media"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordingMedia"}},"/api/v2/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecording"},"put":{"tags":["Recording"],"summary":"Updates an orphan recording to a regular recording with retention values","description":"If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.","operationId":"putOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrphanUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.orphan.retention.data.invalid":"The provided dates in the payload were invalid.","recording.orphan.unknown.conversation":"The provided conversation in the payload doesn't exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","recording.recording.analytics.retention.violation":"The provided delete date exceeds the limit imposed by the analytics retention settings.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.orphan.edit.permission.check.failed":"Requesting user lacks permission to perform this api operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:edit"]},"x-purecloud-method-name":"putOrphanrecording"},"delete":{"tags":["Recording"],"summary":"Deletes a single orphan recording","description":"","operationId":"deleteOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:delete"]},"x-purecloud-method-name":"deleteOrphanrecording"}},"/api/v2/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"hasConversation","in":"query","description":"Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.","required":false,"type":"boolean","default":false},{"name":"media","in":"query","description":"Filter resulting orphans based on their media type","required":false,"type":"string","enum":["Call","Screen"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.view.permission.check.failed":"Failed to verify recording view permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordings"}},"/api/v2/quality/publishedforms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of an evaluation form.","description":"","operationId":"getQualityPublishedformsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluation"}},"/api/v2/quality/publishedforms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluations"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.config.evaluator.no.permission":"One or more assignees do not have the required permissions","quality.evaluation.evaluator.doesnt.exist":"One or more assignees do not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsEvaluations"}},"/api/v2/quality/publishedforms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of a survey form.","description":"","operationId":"getQualityPublishedformsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurvey"}},"/api/v2/quality/publishedforms/surveys":{"get":{"tags":["Quality"],"summary":"Get the published survey forms.","description":"","operationId":"getQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestEnabledPerContext","in":"query","description":"onlyLatestEnabledPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurveys"},"post":{"tags":["Quality"],"summary":"Publish a survey form.","description":"","operationId":"postQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsSurveys"}},"/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}":{"get":{"tags":["Recording"],"summary":"Get metadata for a specific recording. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadataRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.recording.not.found":"Recording with recordingId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadataRecordingId"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording. Valid values:EML,NONE","required":false,"type":"string","default":"EML","enum":["EML","NONE"]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording. Valid values:ZIP,NONE ","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording. Valid values:ZIP,NONE","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"]},{"name":"download","in":"query","description":"requesting a download format of the recording. Valid values:true,false","required":false,"type":"boolean","default":false,"enum":["true","false"]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"202":{"description":"Success - recording is transcoding","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"The conversation query was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecording"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","operationId":"putConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}},{"name":"clearExport","in":"query","description":"Whether to clear the pending export for the recording","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.not.archivable":"Recording has been deleted or is still uploading","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Recording request contains invalid JSON","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","recording.recording.edit.retention.permission.check.failed":"Failed to verify recording edit retention permission.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recording.restore.permission.check.failed":"improper permissions found when attempting to restore recordings"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.not.archivable":"Recording is not achievable","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putConversationRecording"}},"/api/v2/conversations/{conversationId}/recordingmetadata":{"get":{"tags":["Recording"],"summary":"Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.","description":"","operationId":"getConversationRecordingmetadata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RecordingMetadata"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Request forbidden due to recording view permissions check failing.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Request forbidden due to recording segment view permissions check failing."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"Conversation with specified conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordingmetadata"}},"/api/v2/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.","required":false,"type":"integer","default":5000,"format":"int32"},{"name":"formatId","in":"query","description":"The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"mediaFormats","in":"query","description":"All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"202":{"description":"Success - recording is transcoding"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"The recording:recordingSegment:view permission is required."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"A conversation for the provided conversationId was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getConversationRecordings"}},"/api/v2/recordings/retention/query":{"get":{"tags":["Recording"],"summary":"Query for recording retention data","description":"","operationId":"getRecordingsRetentionQuery","produces":["application/json"],"parameters":[{"name":"retentionThresholdDays","in":"query","description":"Fetch retention data for recordings retained for more days than the provided value.","required":true,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 500.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingRetentionCursorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getRecordingsRetentionQuery"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","recording.annotation.view.permission.check.failed":"Failed to verify view annotation permission","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.annotation.not.found":"The recording annotation was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotation"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.update.permission.check.failed":"Failed to verify recording update permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.recordingsegment.view.permission.check.failed":"Failed to verify recording segment view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:edit","recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"putConversationRecordingAnnotation"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","recording.annotation.cant.delete.for.another.user":"Can't delete a recording annotation for another user.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","recording.annotation.delete.permission.check.failed":"Failed to verify recording delete permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:delete"]},"x-purecloud-method-name":"deleteConversationRecordingAnnotation"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.description.too.long":"Annotation description too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.invalid.json":"Request contains invalid JSON.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:add"]},"x-purecloud-method-name":"postConversationRecordingAnnotations"}},"/api/v2/recording/jobs/{jobId}/failedrecordings":{"get":{"tags":["Recording"],"summary":"Get IDs of recordings that the bulk job failed for","description":"","operationId":"getRecordingJobFailedrecordings","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size. Maximum is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FailedRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobFailedrecordings"}},"/api/v2/recording/jobs/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status of the job associated with the job id.","description":"","operationId":"getRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJob"},"put":{"tags":["Recording"],"summary":"Execute the recording bulk job.","description":"A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","operationId":"putRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ExecuteRecordingJobsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:edit","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putRecordingJob"},"delete":{"tags":["Recording"],"summary":"Delete the recording bulk job","description":"","operationId":"deleteRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:delete"]},"x-purecloud-method-name":"deleteRecordingJob"}},"/api/v2/recording/jobs":{"get":{"tags":["Recording"],"summary":"Get the status of all jobs within the user's organization","description":"","operationId":"getRecordingJobs","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"userId","enum":["userId","dateCreated"]},{"name":"state","in":"query","description":"Filter by state","required":false,"type":"string","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"]},{"name":"showOnlyMyJobs","in":"query","description":"Show only my jobs","required":false,"type":"boolean"},{"name":"jobType","in":"query","description":"Job Type (Can be left empty for both)","required":false,"type":"string","enum":["ARCHIVE","DELETE","EXPORT"]},{"name":"includeTotal","in":"query","description":"If false, cursor will be used to locate the page instead of pageNumber.","required":false,"type":"boolean"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobs"},"post":{"tags":["Recording"],"summary":"Create a recording bulk job.","description":"Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.","operationId":"postRecordingJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RecordingJobsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for actionAge and screen recording parameters"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:add"]},"x-purecloud-method-name":"postRecordingJobs"}},"/api/v2/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getRecordingSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting recording settings","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view","recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"getRecordingSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putRecordingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Recording settings","required":true,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","recording.org.settings.request.invalid":"invalid recording setting","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"putRecordingSettings"}},"/api/v2/recording/uploads/reports/{reportId}":{"get":{"tags":["Recording"],"summary":"Get the status of a recording upload status report","description":"","operationId":"getRecordingUploadsReport","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"reportId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:view"]},"x-purecloud-method-name":"getRecordingUploadsReport"}},"/api/v2/recording/uploads/reports":{"post":{"tags":["Recording"],"summary":"Creates a recording upload status report","description":"","operationId":"postRecordingUploadsReports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Report parameters","required":true,"schema":{"$ref":"#/definitions/RecordingUploadReportRequest"}}],"responses":{"202":{"description":"Accepted - preparing report.","schema":{"$ref":"#/definitions/RecordingUploadReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:uploadReport:add"]},"x-purecloud-method-name":"postRecordingUploadsReports"}},"/api/v2/recordings/screensessions/metadata":{"post":{"tags":["Recording"],"summary":"Provide meta-data a screen recording.","description":"","operationId":"postRecordingsScreensessionsMetadata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ScreenRecordingMetaDataRequest","required":true,"schema":{"$ref":"#/definitions/ScreenRecordingMetaDataRequest"}}],"responses":{"204":{"description":"Meta-data supplied to screen recording."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsMetadata"}},"/api/v2/recordings/screensessions":{"get":{"tags":["Recording"],"summary":"Retrieves a paged listing of screen recording sessions","description":"Coming soon: This API is deprecated and will be replaced by /api/v2/recordings/screensessions/details","operationId":"getRecordingsScreensessions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingSessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessions"}},"/api/v2/recordings/screensessions/details":{"get":{"tags":["Recording"],"summary":"Retrieves an object containing the total number of concurrent active screen recordings","description":"","operationId":"getRecordingsScreensessionsDetails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingActiveSessions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessionsDetails"}},"/api/v2/recordings/screensessions/{recordingSessionId}":{"patch":{"tags":["Recording"],"summary":"Update a screen recording session","description":"","operationId":"patchRecordingsScreensession","produces":["application/json"],"parameters":[{"name":"recordingSessionId","in":"path","description":"Screen recording session ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingSessionRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","qm.screen.recording.state.required":"Can only update a screen recording session's state to stopped.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.stop.permission.check.failed":"Failed to check required stop permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:stop"]},"x-purecloud-method-name":"patchRecordingsScreensession"}},"/api/v2/recordings/screensessions/acknowledge":{"post":{"tags":["Recording"],"summary":"Acknowledge a screen recording.","description":"","operationId":"postRecordingsScreensessionsAcknowledge","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AcknowledgeScreenRecordingRequest","required":true,"schema":{"$ref":"#/definitions/AcknowledgeScreenRecordingRequest"}}],"responses":{"204":{"description":"Recording acknowledged"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postRecordingsScreensessionsAcknowledge"}},"/api/v2/quality/forms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get a survey form","description":"","operationId":"getQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.not.found":"Survey formId not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurvey"},"put":{"tags":["Quality"],"summary":"Update a survey form.","description":"","operationId":"putQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:edit"]},"x-purecloud-method-name":"putQualityFormsSurvey"},"delete":{"tags":["Quality"],"summary":"Delete a survey form.","description":"","operationId":"deleteQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.cannot.be.deleted":"Cannot delete survey because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsSurvey"},"patch":{"tags":["Quality"],"summary":"Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.","description":"","operationId":"patchQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:disable"]},"x-purecloud-method-name":"patchQualityFormsSurvey"}},"/api/v2/quality/forms/surveys/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific survey.","description":"","operationId":"getQualityFormsSurveyVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveyVersions"}},"/api/v2/quality/forms/surveys/bulk":{"get":{"tags":["Quality"],"summary":"Retrieve a list of survey forms by their ids","description":"","operationId":"getQualityFormsSurveysBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma-delimited list of valid survey form ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulk"}},"/api/v2/quality/forms/surveys/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest form versions by context ids","description":"","operationId":"getQualityFormsSurveysBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"published","in":"query","description":"If true, the latest published version will be included. If false, only the unpublished version will be included.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulkContexts"}},"/api/v2/quality/forms/surveys":{"get":{"tags":["Quality"],"summary":"Get the list of survey forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding survey form.","description":"","operationId":"getQualityFormsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveys"},"post":{"tags":["Quality"],"summary":"Create a survey form.","description":"","operationId":"postQualityFormsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"composer.answer.option.value.too.large":"Answer option value is too large","composer.question.too.many.answer.options":"Question has too many answer options'","bad.request":"The request could not be understood by the server due to malformed syntax.","composer.question.group.name.too.long":"Question group name is too long","composer.form.name.too.long":"Survey form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","composer.help.text.too.long":"Help text is too long","composer.answer.option.text.too.long":"Answer option text is too long","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","survey.form.invalid":"Survey form is not valid","composer.form.too.many.questions":"Survey form has too many questions","composer.explanation.prompt.text.too.long":"Explanation prompt text is too long","composer.question.text.too.long":"Question text is too long","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.name.conflict":"Survey form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityFormsSurveys"}},"/api/v2/quality/surveys/{surveyId}":{"get":{"tags":["Quality"],"summary":"Get a survey for a conversation","description":"","operationId":"getQualitySurvey","produces":["application/json"],"parameters":[{"name":"surveyId","in":"path","description":"surveyId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Survey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.view.permission.check.failed":"Failed to check required view permission.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualitySurvey"}},"/api/v2/quality/surveys/scoring":{"post":{"tags":["Quality"],"summary":"Score survey","description":"","operationId":"postQualitySurveysScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"surveyAndScoringSet","required":true,"schema":{"$ref":"#/definitions/SurveyFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualitySurveysScoring"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForm"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityForm"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityForm"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormVersions"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.","description":"","operationId":"getQualityForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions","required":false,"type":"string","enum":["publishHistory"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForms"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","composer.form.name.too.long":"Evaluation form name is too long","invalid.property":"Value [%s] is not a valid property for object [%s]","composer.form.too.many.questions":"Evaluation form has too many questions","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityForms"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedform","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Requested formId not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedform"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedforms"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.already.published":"Evaluation has already been published."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedforms"}},"/api/v2/alerting/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an alert","description":"","operationId":"getAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingAlert"},"put":{"tags":["Alerting"],"summary":"Update an alert read status","description":"","operationId":"putAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertingUnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an alert","description":"","operationId":"deleteAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingAlert"},"patch":{"tags":["Alerting"],"summary":"Allows an entity to mute/snooze an alert or update the unread status of the alert.","description":"Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.","operationId":"patchAlertingAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AlertRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlert"}},"/api/v2/alerting/alerts/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk alert updates","description":"","operationId":"patchAlertingAlertsBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonAlertBulkUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"patchAlertingAlertsBulk"}},"/api/v2/alerting/alerts/query":{"post":{"tags":["Alerting"],"summary":"Gets a paged list of alerts. The max page size is 50","description":"","operationId":"postAlertingAlertsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetAlertQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlertListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"postAlertingAlertsQuery"}},"/api/v2/alerting/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get a rule.","description":"","operationId":"getAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingRule"},"put":{"tags":["Alerting"],"summary":"Update a rule","description":"","operationId":"putAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"},{"in":"body","name":"body","description":"rule to be updated","required":true,"schema":{"$ref":"#/definitions/ModifiableRuleProperties"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingRule"},"delete":{"tags":["Alerting"],"summary":"Delete a rule.","description":"","operationId":"deleteAlertingRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule Id","required":true,"type":"string"}],"responses":{"204":{"description":"Rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingRule"}},"/api/v2/alerting/rules/bulk":{"patch":{"tags":["Alerting"],"summary":"Bulk update of notification lists","description":"","operationId":"patchAlertingRulesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkUpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"patchAlertingRulesBulk"}},"/api/v2/alerting/rules/bulk/remove":{"post":{"tags":["Alerting"],"summary":"Bulk remove rules","description":"","operationId":"postAlertingRulesBulkRemove","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CommonRuleBulkDeleteRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"postAlertingRulesBulkRemove"}},"/api/v2/alerting/rules/query":{"post":{"tags":["Alerting"],"summary":"Get a paged list of rules. The max size of the page is 50 items.","description":"","operationId":"postAlertingRulesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GetRulesQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"postAlertingRulesQuery"}},"/api/v2/alerting/rules":{"post":{"tags":["Alerting"],"summary":"Create a Rule.","description":"","operationId":"postAlertingRules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"rule to be created","required":true,"schema":{"$ref":"#/definitions/CommonRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonRule"}},"201":{"description":"Rule created.","schema":{"$ref":"#/definitions/CommonRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingRules"}},"/api/v2/responsemanagement/libraries/bulk":{"post":{"tags":["Response Management"],"summary":"Get response libraries.","description":"","operationId":"postResponsemanagementLibrariesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"LibraryIDs (max allowed 50)","required":true,"schema":{"$ref":"#/definitions/LibraryBatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.exceeds.maximum.library.batch.size":"Exceeds maximum batch size limit.","rms.missing.field":"Missing Field.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"postResponsemanagementLibrariesBulk"}},"/api/v2/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getResponsemanagementLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"messagingTemplateFilter","in":"query","description":"Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel","required":false,"type":"string","enum":["whatsapp"]},{"name":"libraryPrefix","in":"query","description":"Returns a list of libraries that contain the prefix provided","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postResponsemanagementLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:add"]},"x-purecloud-method-name":"postResponsemanagementLibraries"}},"/api/v2/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.library.not.found":"The response library could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:view"]},"x-purecloud-method-name":"getResponsemanagementLibrary"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:edit"]},"x-purecloud-method-name":"putResponsemanagementLibrary"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:library:delete"]},"x-purecloud-method-name":"deleteResponsemanagementLibrary"}},"/api/v2/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsemanagementResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","rms.field.unexpected.value":"One or more fields in the payload contained unexpected values."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.internal.server.error":"The request failed due to an internal server error.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"postResponsemanagementResponsesQuery"}},"/api/v2/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","rms.response.not.found":"The response could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponse"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:edit"]},"x-purecloud-method-name":"putResponsemanagementResponse"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponse"}},"/api/v2/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponsemanagementResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:view"]},"x-purecloud-method-name":"getResponsemanagementResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponsemanagementResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.not.a.user":"Unable to find user","rms.exceeds.asset.maximum.file.size":"Response asset file size exceeds limit.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","rms.exceeds.maximum.mms.response.assets":"Too many response assets","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.precondition":"Response precondition not met."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responses:response:add"]},"x-purecloud-method-name":"postResponsemanagementResponses"}},"/api/v2/responsemanagement/responseassets/{responseAssetId}":{"get":{"tags":["Response Management"],"summary":"Get response asset information","description":"","operationId":"getResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseasset"},"put":{"tags":["Response Management"],"summary":"Update response asset","description":"","operationId":"putResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:edit"]},"x-purecloud-method-name":"putResponsemanagementResponseasset"},"delete":{"tags":["Response Management"],"summary":"Delete response asset","description":"","operationId":"deleteResponsemanagementResponseasset","produces":["application/json"],"parameters":[{"name":"responseAssetId","in":"path","description":"Asset Id","required":true,"type":"string"}],"responses":{"204":{"description":"Response asset is deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:delete"]},"x-purecloud-method-name":"deleteResponsemanagementResponseasset"}},"/api/v2/responsemanagement/responseassets/status/{statusId}":{"get":{"tags":["Response Management"],"summary":"Get response asset upload status","description":"","operationId":"getResponsemanagementResponseassetsStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"getResponsemanagementResponseassetsStatusStatusId"}},"/api/v2/responsemanagement/responseassets/uploads":{"post":{"tags":["Response Management"],"summary":"Creates pre-signed url for uploading response asset","description":"","operationId":"postResponsemanagementResponseassetsUploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateResponseAssetRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateResponseAssetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.content.md5":"Invalid Content","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["responseAssets:asset:add"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsUploads"}},"/api/v2/responsemanagement/responseassets/search":{"post":{"tags":["Response Management"],"summary":"Search response assets","description":"","operationId":"postResponsemanagementResponseassetsSearch","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user","division"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/ResponseAssetSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseAssetSearchResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["responseAssets:asset:view"]},"x-purecloud-method-name":"postResponsemanagementResponseassetsSearch"}},"/api/v2/routing/availablemediatypes":{"get":{"tags":["Routing"],"summary":"Get available media types","description":"","operationId":"getRoutingAvailablemediatypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableMediaTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingAvailablemediatypes"}},"/api/v2/routing/languages/{languageId}":{"get":{"tags":["Routing"],"summary":"Get a routing language","description":"","operationId":"getRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguage"},"delete":{"tags":["Routing"],"summary":"Delete a routing language","description":"","operationId":"deleteRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingLanguage"}},"/api/v2/routing/languages":{"get":{"tags":["Routing"],"summary":"Get the list of supported languages.","description":"","operationId":"getRoutingLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguages"},"post":{"tags":["Routing"],"summary":"Create Language","description":"","operationId":"postRoutingLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingLanguages"}},"/api/v2/routing/queues/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","description":"","operationId":"getRoutingQueuesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number [max value is 5]","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"Queue ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting paged listing of queue objects."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviews"}},"/api/v2/routing/queues/divisionviews/all":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.","description":"","operationId":"getRoutingQueuesDivisionviewsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 500]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviewsAll"}},"/api/v2/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueue"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/QueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","queue.ring.has.members":"One or more bullseye rings cannot be removed, due to having assigned members.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A referenced resource, such as a division, was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","invalid.media.subtype":"Invalid media subtype specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"putRoutingQueue"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"forceDelete","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field.","active.queue":"Queue contains active conversations."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:delete"]},"x-purecloud-method-name":"deleteRoutingQueue"}},"/api/v2/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of wrapup codes","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapUpCodeReference"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of wrapup codes.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified queue was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"postRoutingQueueWrapupcodes"}},"/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteRoutingQueueWrapupcode","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingQueueWrapupcode"}},"/api/v2/routing/queues/me":{"get":{"tags":["Routing"],"summary":"Get a paged listing of queues the user is a member of.","description":"","operationId":"getRoutingQueuesMe","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"joined","in":"query","description":"Filter by joined status.","required":false,"type":"boolean","enum":["true","false"]},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingQueuesMe"}},"/api/v2/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getRoutingQueues","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Include only queues with the given name (leading and trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Include only queues with the specified ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Include only queues in the specified division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"peerId","in":"query","description":"Include only queues with the specified peer ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"cannedResponseLibraryId","in":"query","description":"Include only queues explicitly associated with the specified canned response library ID","required":false,"type":"string"},{"name":"hasPeer","in":"query","description":"Include only queues with a peer ID","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting queue listing."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueues"},"post":{"tags":["Routing"],"summary":"Create a queue","description":"","operationId":"postRoutingQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/CreateQueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","invalid.phone.numbers":"Invalid phone numbers specified.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","queue.deleted":"Queue has been deleted.","constraint.validation":"%s","invalid.library.ids":"One or more specified canned response libraries are not found, and cannot be set","invalid.name":"Invalid queue name specified.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","queue.limit.exceeded":"Adding the requested queue would exceed the queue limit.","invalid.answering.machine.flow":"Specified answering machine outbound flow is not active.","invalid.whats.app.recipient.id":"The specified outbound WhatsApp recipient is not active, and cannot be set.","source.queue.not.found":"Source queue not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","invalid.type":"Invalid object type specified.","resource.not.found":"A resource (e.g., a skill) referenced in the queue configuration was not found.","invalid.open.messaging.recipient.id":"The specified outbound OpenMessaging recipient is not active, and cannot be set.","invalid.live.voice.flow":"Specified live voice in-queue flow is not active.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"A required ID was missing or invalid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A required resource (e.g., the source queue) was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:add"]},"x-purecloud-method-name":"postRoutingQueues"}},"/api/v2/routing/settings/transcription":{"get":{"tags":["Routing"],"summary":"Get Transcription Settings","description":"","operationId":"getRoutingSettingsTranscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Requested feature is forbidden","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:view"]},"x-purecloud-method-name":"getRoutingSettingsTranscription"},"put":{"tags":["Routing"],"summary":"Update Transcription Settings","description":"","operationId":"putRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"putRoutingSettingsTranscription"},"patch":{"tags":["Routing"],"summary":"Patch Transcription Settings","description":"","operationId":"patchRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsTranscription"}},"/api/v2/routing/settings/contactcenter":{"get":{"tags":["Routing"],"summary":"Get Contact Center Settings","description":"","operationId":"getRoutingSettingsContactcenter","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCenterSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettingsContactcenter"},"patch":{"tags":["Routing"],"summary":"Update Contact Center Settings","description":"","operationId":"patchRoutingSettingsContactcenter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact Center Settings","required":true,"schema":{"$ref":"#/definitions/ContactCenterSettings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsContactcenter"}},"/api/v2/routing/settings":{"get":{"tags":["Routing"],"summary":"Get an organization's routing settings","description":"","operationId":"getRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettings"},"put":{"tags":["Routing"],"summary":"Update an organization's routing settings","description":"","operationId":"putRoutingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/RoutingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"putRoutingSettings"},"delete":{"tags":["Routing"],"summary":"Delete an organization's routing settings","description":"","operationId":"deleteRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"deleteRoutingSettings"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkill"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingSkill"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing skills.","description":"","operationId":"getRoutingSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Filter for results that start with this value","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postRoutingSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingSkills"}},"/api/v2/routing/utilization/labels/{labelId}":{"get":{"tags":["Routing"],"summary":"Get details about this utilization label","description":"","operationId":"getRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabel"},"put":{"tags":["Routing"],"summary":"Update a utilization label","description":"","operationId":"putRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/UpdateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilizationLabel"},"delete":{"tags":["Routing"],"summary":"Delete a utilization label","description":"","operationId":"deleteRoutingUtilizationLabel","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Remove all label usages (if found) without warning","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Utilization label cannot be deleted due to its usage in max utilization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilizationLabel"}},"/api/v2/routing/utilization/labels/{labelId}/agents":{"get":{"tags":["Routing"],"summary":"Get list of agent ids associated with a utilization label","description":"","operationId":"getRoutingUtilizationLabelAgents","produces":["application/json"],"parameters":[{"name":"labelId","in":"path","description":"Utilization Label ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabelAgents"}},"/api/v2/routing/utilization/labels":{"get":{"tags":["Routing"],"summary":"Get list of utilization labels","description":"","operationId":"getRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order by name","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationLabels"},"post":{"tags":["Routing"],"summary":"Create a utilization label","description":"","operationId":"postRoutingUtilizationLabels","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UtilizationLabel","required":true,"schema":{"$ref":"#/definitions/CreateUtilizationLabelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationLabel"}},"201":{"description":"Utilization label created.","schema":{"$ref":"#/definitions/UtilizationLabel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.utilization.label":"Invalid utilization label request.","invalid.name":"Invalid utilization code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A utilization label with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"postRoutingUtilizationLabels"}},"/api/v2/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the organization-wide max utilization settings.","description":"","operationId":"getRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilization"},"put":{"tags":["Routing"],"summary":"Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.media.capacity":"Value too large or too small for media type.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilization"},"delete":{"tags":["Routing"],"summary":"Delete the organization-wide max utilization settings and revert to the system default.","description":"","operationId":"deleteRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilization"}},"/api/v2/routing/assessments/{assessmentId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessment.","description":"","operationId":"getRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessment.not.found":"Benefit Assessment not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessment"},"delete":{"tags":["Routing"],"summary":"Delete single benefit assessment.","description":"","operationId":"deleteRoutingAssessment","produces":["application/json"],"parameters":[{"name":"assessmentId","in":"path","description":"Benefit Assessment ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:delete"]},"x-purecloud-method-name":"deleteRoutingAssessment"}},"/api/v2/routing/assessments":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessments.","description":"","operationId":"getRoutingAssessments","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Queue ID(s) to filter assessments by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessments"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment.","description":"","operationId":"postRoutingAssessments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessment"}},"201":{"description":"Benefit Assessment created.","schema":{"$ref":"#/definitions/BenefitAssessment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:assessment:add","routing:queue:view"]},"x-purecloud-method-name":"postRoutingAssessments"}},"/api/v2/routing/assessments/jobs/{jobId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single benefit assessments job.","description":"","operationId":"getRoutingAssessmentsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Benefit Assessment Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"The benefit assessment job is finished.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"The benefit assessment job is created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","assessments.job.not.found":"Benefit Assessments Job not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJob"}},"/api/v2/routing/assessments/jobs":{"get":{"tags":["Routing"],"summary":"Retrieve all benefit assessment jobs.","description":"","operationId":"getRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"Division ID(s) to filter assessment jobs by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingAssessmentsJobs"},"post":{"tags":["Routing"],"summary":"Create a benefit assessment job.","description":"","operationId":"postRoutingAssessmentsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateBenefitAssessmentJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"202":{"description":"Benefit Assessment Job created.","schema":{"$ref":"#/definitions/BenefitAssessmentJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:assessment:add"]},"x-purecloud-method-name":"postRoutingAssessmentsJobs"}},"/api/v2/routing/conversations/{conversationId}":{"patch":{"tags":["Routing"],"summary":"Update attributes of an in-queue conversation","description":"Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.","operationId":"patchRoutingConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Attributes","required":true,"schema":{"$ref":"#/definitions/RoutingConversationAttributesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingConversationAttributesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A null or invalid attribute ID was specified.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","resource.not.found":"A specified skill or language does not exist."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified conversation does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:conversation:edit"]},"x-purecloud-method-name":"patchRoutingConversation"}},"/api/v2/routing/email/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomain"},"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomain"},"patch":{"tags":["Routing"],"summary":"Update domain settings","description":"","operationId":"patchRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomain"}},"/api/v2/routing/email/domains/{domainId}/validate":{"patch":{"tags":["Routing"],"summary":"Validate domain settings","description":"","operationId":"patchRoutingEmailDomainValidate","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomainValidate"}},"/api/v2/routing/email/domains/{domainId}/testconnection":{"post":{"tags":["Routing"],"summary":"Tests the custom SMTP server integration connection set on this domain","description":"The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","operationId":"postRoutingEmailDomainTestconnection","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TestMessage","required":false,"schema":{"$ref":"#/definitions/TestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainTestconnection"}},"/api/v2/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getRoutingEmailDomains","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeStatus","in":"query","description":"Exclude MX record data","required":false,"type":"boolean","default":false},{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","email.error.integration.host":"The specified integration has a bad host.","email.error.integration.connection":"Unable to connect with the specified integration.","postino.domain.exists":"The inbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomains"}},"/api/v2/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getRoutingEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailSetup"}},"/api/v2/routing/email/outbound/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomain"},"delete":{"tags":["Routing"],"summary":"Delete an outbound domain","description":"","operationId":"deleteRoutingEmailOutboundDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailOutboundDomain"}},"/api/v2/routing/email/outbound/domains/{domainId}/search":{"get":{"tags":["Routing"],"summary":"Search a domain across organizations","description":"","operationId":"getRoutingEmailOutboundDomainSearch","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainSearch"}},"/api/v2/routing/email/outbound/domains/{domainId}/activation":{"get":{"tags":["Routing"],"summary":"Get activation status (cname + dkim) of an outbound domain","description":"","operationId":"getRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomainActivation"},"put":{"tags":["Routing"],"summary":"Request an activation status (cname + dkim) update of an outbound domain","description":"","operationId":"putRoutingEmailOutboundDomainActivation","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailOutboundDomainActivation"}},"/api/v2/routing/email/outbound/domains":{"get":{"tags":["Routing"],"summary":"Get outbound domains","description":"","operationId":"getRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"name":"filter","in":"query","description":"Optional search filter","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailOutboundDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailOutboundDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomains"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoute"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailDomainRoute"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The inbound route delete request timed out.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.route.conflict":"The inbound route is a reply route in one or more other inbound routes."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomainRoute"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pattern","in":"query","description":"Filter routes by the route's pattern property","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.max.routes.exceeded":"The maximum number of routes for the domain has been exceeded.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.error.not.found":"The resource could not be found.","constraint.validation":"%s","postino.domain.exists":"The inbound domain already exists.","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","postino.error.invalid.signature.id":"The signature id is not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.flow.id":"The flow is not eligible for use here.","postino.route.pattern.exists":"A route already exists for this domain with the specified pattern.","postino.error.queue.required":"A queue id or flow id is required.","postino.route.not.found":"The route could not be found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.invalid.signature.type":"The signature type is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.signature.not.found":"The signature was not found.","postino.signature.body.not.found":"The signature body was not found.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainRoutes"}},"/api/v2/routing/email/outbound/domains/simulated":{"post":{"tags":["Routing"],"summary":"Create a simulated domain","description":"","operationId":"postRoutingEmailOutboundDomainsSimulated","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/OutboundDomain"}}],"responses":{"202":{"description":"Creation request was successful. Need to wait for creation to complete","schema":{"$ref":"#/definitions/EmailOutboundDomainResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.exists":"The outbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailOutboundDomainsSimulated"}},"/api/v2/routing/message/recipients/{recipientId}":{"get":{"tags":["Routing"],"summary":"Get a recipient","description":"","operationId":"getRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipient"},"put":{"tags":["Routing"],"summary":"Update a recipient","description":"","operationId":"putRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recipient","required":true,"schema":{"$ref":"#/definitions/RecipientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.flow":"The flow was invalid.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"putRoutingMessageRecipient"}},"/api/v2/routing/message/recipients":{"get":{"tags":["Routing"],"summary":"Get recipients","description":"","operationId":"getRoutingMessageRecipients","produces":["application/json"],"parameters":[{"name":"messengerType","in":"query","description":"Messenger Type","required":false,"type":"string","enum":["sms","facebook","twitter","line","whatsapp","open","instagram"]},{"name":"name","in":"query","description":"Recipient Name","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecipientListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipients"}},"/api/v2/routing/sms/addresses/{addressId}":{"get":{"tags":["Routing"],"summary":"Get an Address by Id for SMS","description":"","operationId":"getRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddress"},"delete":{"tags":["Routing"],"summary":"Delete an Address by Id for SMS","description":"","operationId":"deleteRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsAddress"}},"/api/v2/routing/sms/addresses":{"get":{"tags":["Routing"],"summary":"Get a list of Addresses for SMS","description":"","operationId":"getRoutingSmsAddresses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddressEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddresses"},"post":{"tags":["Routing"],"summary":"Provision an Address for SMS","description":"","operationId":"postRoutingSmsAddresses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsAddress","required":true,"schema":{"$ref":"#/definitions/SmsAddressProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.address":"The address you have provided cannot be validated. This may be due to spelling error or that the address is not available in a third-party data source for validation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsAddresses"}},"/api/v2/routing/sms/availablephonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of available phone numbers for SMS provisioning.","description":"This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.","operationId":"getRoutingSmsAvailablephonenumbers","produces":["application/json"],"parameters":[{"name":"countryCode","in":"query","description":"The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned","required":true,"type":"string"},{"name":"region","in":"query","description":"Region/province/state that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"city","in":"query","description":"City that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"areaCode","in":"query","description":"Area code that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Type of available phone numbers searched","required":true,"type":"string","enum":["local","mobile","tollfree"]},{"name":"pattern","in":"query","description":"A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.","required":false,"type":"string"},{"name":"addressRequirement","in":"query","description":"This indicates whether the phone number requires to have an Address registered.","required":false,"type":"string","enum":["none","any","local","foreign"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SMSAvailablePhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"getRoutingSmsAvailablephonenumbers"}},"/api/v2/routing/sms/phonenumbers/import":{"post":{"tags":["Routing"],"summary":"Imports a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbersImport","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberImport"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number imported is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"Bad request provisioning phone number for SMS","invalid.property":"Value [%s] is not a valid property for object [%s]","missing.required.field.value":"A required field was not provided or is blank.","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","compliance.not.configurable":"Compliance is not configurable for current phone type.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The phone number address is not in E.164 phone format.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:byoImport"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbersImport"}},"/api/v2/routing/sms/phonenumbers/{addressId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand response with additional information","required":false,"type":"string","enum":["compliance"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumber"},"put":{"tags":["Routing"],"summary":"Update a phone number provisioned for SMS.","description":"","operationId":"putRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumber"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - The phone number update is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Update operation not allowed for phone number of type shortcode.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:edit"]},"x-purecloud-method-name":"putRoutingSmsPhonenumber"},"delete":{"tags":["Routing"],"summary":"Delete a phone number provisioned for SMS.","description":"","operationId":"deleteRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted -The phone number delete is in progress."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Delete operation not allowed for phone number of type shortcode.","recipient.has.flow":"Phone number cannot be deleted with an existing flow associated to it. Remove associated flow before deleting phone number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsPhonenumber"}},"/api/v2/routing/sms/phonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of provisioned phone numbers.","description":"","operationId":"getRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Filter on phone number type","required":false,"type":"array","items":{"type":"string","enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"collectionFormat":"multi"},{"name":"phoneNumberStatus","in":"query","description":"Filter on phone number status","required":false,"type":"array","items":{"type":"string","enum":["active","invalid","initiated","porting","pending","pending-cancellation"]},"collectionFormat":"multi"},{"name":"countryCode","in":"query","description":"Filter on country code","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Optional field to sort results","required":false,"type":"string","enum":["phoneNumber","countryCode","country","dateCreated","dateModified","phoneNumberStatus","phoneNumberType","purchaseDate","supportsMms","supportsSms","supportsVoice"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"]},{"name":"language","in":"query","description":"A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations","required":false,"type":"string","default":"en-US","x-example":"en-US"},{"name":"integration.id","in":"query","description":"Filter on the Genesys Cloud integration id to which the phone number belongs to","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumbers"},"post":{"tags":["Routing"],"summary":"Provision a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number create is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phone.number.unavailable":"Phone number is unavailable.","bad.request":"The request could not be understood by the server due to malformed syntax.","requires.an.address":"The country associated with this phone number requires an address on file. To provision this number you must have an Address on your account.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","unexpected.country.code":"The country code does not match the expected country code for this address.","phone.number.duplicate":"Phone number has already been created.","unexpected.phone.number.type":"The phone number type does not match the expected type for this address.","requires.verified.identity.document":"This phone number requires a verified identity document, which is not supported.","requires.local.address":"Phone number associated with the country code requires a local address. To provision this number you must have an Address on your account which satisfies the local address requirements.","invalid.short.code.operation":"Phone number Provision operation not allowed for phone number of type shortcode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phone.number.requires.a.bundle":"This phone number cannot be provisioned without an identity document, which is not supported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbers"}},"/api/v2/routing/predictors/{predictorId}":{"get":{"tags":["Routing"],"summary":"Retrieve a single predictor.","description":"","operationId":"getRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view"]},"x-purecloud-method-name":"getRoutingPredictor"},"delete":{"tags":["Routing"],"summary":"Delete single predictor.","description":"","operationId":"deleteRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:delete","routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingPredictor"},"patch":{"tags":["Routing"],"summary":"Update single predictor.","description":"","operationId":"patchRoutingPredictor","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchPredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:edit","routing:queue:edit"]},"x-purecloud-method-name":"patchRoutingPredictor"}},"/api/v2/routing/predictors":{"get":{"tags":["Routing"],"summary":"Retrieve all predictors.","description":"","operationId":"getRoutingPredictors","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"Comma-separated list of queue Ids to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:predictor:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingPredictors"},"post":{"tags":["Routing"],"summary":"Create a predictor.","description":"","operationId":"postRoutingPredictors","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreatePredictorRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Predictor"}},"201":{"description":"Predictor created.","schema":{"$ref":"#/definitions/Predictor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","too.many.predictors":"Number of predictors exceeds the allowed limit.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"Unable to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictor:add","routing:queue:edit"]},"x-purecloud-method-name":"postRoutingPredictors"}},"/api/v2/routing/predictors/keyperformanceindicators":{"get":{"tags":["Routing"],"summary":"Get a list of Key Performance Indicators","description":"","operationId":"getRoutingPredictorsKeyperformanceindicators","produces":["application/json"],"parameters":[{"name":"kpiGroup","in":"query","description":"The Group of Key Performance Indicators to return","required":false,"type":"string","enum":["Standard","Custom"]},{"name":"expand","in":"query","description":"Parameter to request additional data to return in KPI payload","required":false,"type":"array","items":{"type":"string","enum":["queues"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/KeyPerformanceIndicator"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:keyPerformanceIndicator:view"]},"x-purecloud-method-name":"getRoutingPredictorsKeyperformanceindicators"}},"/api/v2/routing/predictors/{predictorId}/models/{modelId}/features":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Model Features.","description":"","operationId":"getRoutingPredictorModelFeatures","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"},{"name":"modelId","in":"path","description":"Model ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModelFeatureListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Predictor Model was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModelFeature:view"]},"x-purecloud-method-name":"getRoutingPredictorModelFeatures"}},"/api/v2/routing/predictors/{predictorId}/models":{"get":{"tags":["Routing"],"summary":"Retrieve Predictor Models and Top Features.","description":"","operationId":"getRoutingPredictorModels","produces":["application/json"],"parameters":[{"name":"predictorId","in":"path","description":"Predictor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PredictorModels"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"predictor.not.found":"Predictor not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:predictorModel:view"]},"x-purecloud-method-name":"getRoutingPredictorModels"}},"/api/v2/routing/queues/{queueId}/members/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete a queue member.","description":"","operationId":"deleteRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueMember"},"patch":{"tags":["Routing"],"summary":"Update the ring number OR joined status for a queue member.","description":"","operationId":"patchRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMember"}},"/api/v2/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get the members of this queue.","description":"","operationId":"getRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Filter by queue member name (contains-style search)","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language (contains-style search)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"memberBy","in":"query","description":"Filter by member type","required":false,"type":"string","enum":["user","group"]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean","enum":["true","false"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:edit","routing:queue:readonly","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueMembers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueMembers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMembers"}},"/api/v2/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.","description":"","operationId":"deleteRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.type":"Group-type queue members cannot be individually deleted.","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueUser"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.","description":"","operationId":"patchRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUser"}},"/api/v2/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.","description":"","operationId":"getRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max value is 100","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Note: results are sorted by name.","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueUsers"},"post":{"tags":["Routing"],"summary":"DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.","description":"","operationId":"postRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueUsers"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.","description":"","operationId":"patchRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListingV1"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUsers"}},"/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}":{"get":{"tags":["Routing"],"summary":"Get a Comparison Period.","description":"","operationId":"getRoutingQueueComparisonperiod","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"},{"name":"comparisonPeriodId","in":"path","description":"ComparisonPeriod id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriod"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"comparisonperiod.not.found":"Comparison Period not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiod"}},"/api/v2/routing/queues/{queueId}/comparisonperiods":{"get":{"tags":["Routing"],"summary":"Get list of comparison periods","description":"","operationId":"getRoutingQueueComparisonperiods","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ComparisonPeriodListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:comparisonPeriod:view","routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueComparisonperiods"}},"/api/v2/routing/skillgroups/{skillGroupId}/members/divisions":{"get":{"tags":["Routing"],"summary":"Get list of member divisions for this skill group.","description":"","operationId":"getRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberDivisionList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembersDivisions"},"post":{"tags":["Routing"],"summary":"Add or remove member divisions for this skill group.","description":"","operationId":"postRoutingSkillgroupMembersDivisions","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SkillGroupMemberDivisions"}}],"responses":{"204":{"description":"Success, skill group member division(s) were added and/or removed."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroupMembersDivisions"}},"/api/v2/routing/skillgroups/{skillGroupId}":{"get":{"tags":["Routing"],"summary":"Get skill group","description":"","operationId":"getRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroup"},"delete":{"tags":["Routing"],"summary":"Remove skill group definition","description":"","operationId":"deleteRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, skill group was removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:delete"]},"x-purecloud-method-name":"deleteRoutingSkillgroup"},"patch":{"tags":["Routing"],"summary":"Update skill group definition","description":"","operationId":"patchRoutingSkillgroup","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update skill groups","required":true,"schema":{"$ref":"#/definitions/SkillGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Provided request is not valid","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:edit"]},"x-purecloud-method-name":"patchRoutingSkillgroup"}},"/api/v2/routing/skillgroups/{skillGroupId}/members":{"get":{"tags":["Routing"],"summary":"Get skill group members","description":"","operationId":"getRoutingSkillgroupMembers","produces":["application/json"],"parameters":[{"name":"skillGroupId","in":"path","description":"Skill Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroupMembers"}},"/api/v2/routing/skillgroups":{"get":{"tags":["Routing"],"summary":"Get skill group listing","description":"","operationId":"getRoutingSkillgroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only skill group names whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getRoutingSkillgroups"},"post":{"tags":["Routing"],"summary":"Create a skill group","description":"","operationId":"postRoutingSkillgroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create skill group","required":true,"schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillGroupWithMemberDivisions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Skill Group with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skillGroup:add"]},"x-purecloud-method-name":"postRoutingSkillgroups"}},"/api/v2/routing/users/{userId}/utilization":{"get":{"tags":["Routing","Users"],"summary":"Get the user's max utilization settings. If not configured, the organization-wide default is returned.","description":"","operationId":"getRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentMaxUtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUserUtilization"},"put":{"tags":["Routing","Users"],"summary":"Update the user's max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/UtilizationRequest"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentMaxUtilizationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.utilization.tag":"Invalid utilization tag provided.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.media.capacity":"Maximum capacity must be between 1 and 50.","invalid.id":"A non-UUID value was specified for an ID field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUserUtilization"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's max utilization settings and revert to the organization-wide default.","description":"","operationId":"deleteRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The user was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Conflict updating user utilization. Another update took place at the same time. Please try again."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUserUtilization"}},"/api/v2/routing/wrapupcodes/divisionviews/{codeId}":{"get":{"tags":["Routing"],"summary":"Get a simplified wrap-up code.","description":"","operationId":"getRoutingWrapupcodesDivisionview","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionview"}},"/api/v2/routing/wrapupcodes/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).","description":"Specifying both name and ID parameters is not supported.","operationId":"getRoutingWrapupcodesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name (trailing asterisks allowed)","required":false,"type":"string"},{"name":"id","in":"query","description":"Wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeState","in":"query","description":"Wrapup code state(s) to include","required":false,"type":"string","enum":["Active","Deleted","ActiveAndDeleted"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","name.and.id.specified":"Both name and ID were specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:search"]},"x-purecloud-method-name":"getRoutingWrapupcodesDivisionviews"}},"/api/v2/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcode"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:edit"]},"x-purecloud-method-name":"putRoutingWrapupcode"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.id":"A non-UUID value was specified for an ID field."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:delete"]},"x-purecloud-method-name":"deleteRoutingWrapupcode"}},"/api/v2/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getRoutingWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Wrapup code's name ('Sort by' param is ignored unless this field is provided)","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by wrapup code ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Filter by division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postRoutingWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"A non-UUID value was specified for an ID field.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You do not have the required permission for this operation.","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A referenced resource, such as a division, was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:add"]},"x-purecloud-method-name":"postRoutingWrapupcodes"}},"/api/v2/scim/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimResourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetype"}},"/api/v2/scim/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimResourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetypes"}},"/api/v2/scim/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimSchema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchema"}},"/api/v2/scim/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimSchemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchemas"}},"/api/v2/scim/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimGroups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroups"}},"/api/v2/scim/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroup"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimGroup"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimGroup","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimGroup"}},"/api/v2/scim/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimServiceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimServiceproviderconfig"}},"/api/v2/scim/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUsers"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimUsers","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimUsers"}},"/api/v2/scim/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"A conflict occurred when getting a SCIM user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The SCIM user was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUser"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimUser"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Version does not match current version."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimUser"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimUser","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimUser"}},"/api/v2/scim/v2/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimV2Resourcetype","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetype"}},"/api/v2/scim/v2/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimV2Resourcetypes","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetypes"}},"/api/v2/scim/v2/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimV2Schema","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schema"}},"/api/v2/scim/v2/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimV2Schemas","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schemas"}},"/api/v2/scim/v2/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimV2Groups","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":true,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Groups"}},"/api/v2/scim/v2/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Group"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimV2Group"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimV2Group","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","org.disabled":"Unable to modify group due to the organization being disabled.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimV2Group"}},"/api/v2/scim/v2/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimV2Serviceproviderconfig","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Serviceproviderconfig"}},"/api/v2/scim/v2/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Users"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimV2Users","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"postScimV2Users"}},"/api/v2/scim/v2/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi"},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"Conflict with existing user ID."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2User"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"putScimV2User"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimV2User"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimV2User","consumes":["application/scim+json","application/json"],"produces":["application/scim+json","application/json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign","telephony:extension:assign"]},"x-purecloud-method-name":"patchScimV2User"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using the q64 value returned from a previous search.","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","images","addressVerificationDetails"]},"collectionFormat":"multi"},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search resources.","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","user.not.in.organization":"User is not in organization.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","jid.not.found":"Unable to determine the JID for user."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearch"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest resources using the q64 value returned from a previous suggest query.","description":"","operationId":"getSearchSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","images","addressVerificationDetails"]},"collectionFormat":"multi"},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getSearchSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest resources.","description":"","operationId":"postSearchSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postSearchSuggest"}},"/api/v2/analytics/conversations/transcripts/query":{"post":{"tags":["Search","Analytics"],"summary":"Search resources.","description":"","operationId":"postAnalyticsConversationsTranscriptsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptConversationDetailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsTranscriptsQuery"}},"/api/v2/speechandtextanalytics/categories":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech and Text Analytics categories","description":"","operationId":"getSpeechandtextanalyticsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number for the listing","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"The category name filter applied to the listing","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"The sort order for the listing","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"sortBy","in":"query","description":"The field to sort by for the listing","required":false,"type":"string","default":"name","enum":["name","description"]},{"name":"ids","in":"query","description":"Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoriesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsCategories"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics category","description":"","operationId":"postSpeechandtextanalyticsCategories","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The category to create","required":true,"schema":{"$ref":"#/definitions/CategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/CategoryRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.criteria.depth.limit.exceeded":"Maximum level criteria limit exceeded","category.criteria.limit.exceeded":"Maximum criteria item limit exceeded","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","category.name.limit.exceeded":"Maximum category name character limit exceeded","constraint.validation":"%s","category.limit.exceeded":"Maximum categories limit exceeded","bad.criteria.logic":"Bad criteria logic","category.description.limit.exceeded":"Maximum category description character limit exceeded","category.term.character.limit.exceeded":"Maximum term character limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.criteria":"Wrong criteria structure","category.term.word.limit.exceeded":"Maximum term word limit exceeded","invalid.value":"Invalid data type","topic.not.found":"Given topic does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.conflict":"A category with the same name already exists in this organization"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsCategories"}},"/api/v2/speechandtextanalytics/categories/{categoryId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics Category by ID","description":"","operationId":"getSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"The requested category could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsCategory"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update a Speech & Text Analytics category by ID","description":"","operationId":"putSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated category","required":true,"schema":{"$ref":"#/definitions/CategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.criteria.depth.limit.exceeded":"Maximum level criteria limit exceeded","category.criteria.limit.exceeded":"Maximum criteria item limit exceeded","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","category.name.limit.exceeded":"Maximum category name character limit exceeded","constraint.validation":"%s","bad.criteria.logic":"Bad criteria logic","category.description.limit.exceeded":"Maximum category description character limit exceeded","category.term.character.limit.exceeded":"Maximum term character limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bad.criteria":"Wrong criteria structure","category.term.word.limit.exceeded":"Maximum term word limit exceeded","invalid.value":"Invalid data type","topic.not.found":"Given topic does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"The requested category could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.conflict":"A category with the same name already exists in this organization"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsCategory"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics category by ID","description":"","operationId":"deleteSpeechandtextanalyticsCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"The id of the category","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:category:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsCategory"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech and Text Analytics for a specific conversation","description":"","operationId":"getSpeechandtextanalyticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving Speech and Text Analytics.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Speech and Text Analytics Not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversation"}},"/api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics dictionary feedback by id","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics dictionary feedback by id","description":"","operationId":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dictionary.term.not.found":"The requested dictionary term could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.update.not.allowed":"The term cannot be updated","dialect.update.not.allowed":"The dialect of term cannot be updated"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics DictionaryFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId","produces":["application/json"],"parameters":[{"name":"dictionaryFeedbackId","in":"path","description":"The Id of the Dictionary Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId"}},"/api/v2/speechandtextanalytics/dictionaryfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics dictionary feedbacks","description":"","operationId":"getSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"},{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":500,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DictionaryFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsDictionaryfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics DictionaryFeedback","description":"","operationId":"postSpeechandtextanalyticsDictionaryfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The DictionaryFeedback to create","required":true,"schema":{"$ref":"#/definitions/DictionaryFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DictionaryFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.length.exceeded":"30 characters in a term limit exceeded","example.phrases.maximum.count.exceeded":"There must be least 3 and no more than 20 example phrases","example.phrases.contains.duplicate.phrase":"There should be no duplication phrases in the listed example phrases","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","example.phrase.minimum.words.required":"The example phrase should contain minimum 3 words & maximum 20 words","example.phrases.should.contain.term":"The term must appear in the example phrases listed","example.phrase.length.required":"The example phrase must be at least 3 characters long","constraint.validation":"%s","example.phrase.length.exceeded":"40 characters in a phrase limit exceeded","example.phrase.maximum.words.exceeded":"The example phrase should contain minimum 3 words & maximum 20 words","invalid.boost.value":"The boost value should range from 1.0 to 10.0","sounds.like.length.exceeded":"30 characters in a sounds like limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","sounds.like.contains.duplicate.value":"The sounds like contains duplicate entries","example.phrases.minimum.count.required":"There must be least 3 and no more than 20 example phrases","sounds.like.maximum.count.exceeded":"The maximum number of sounds like has been reached","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"term.limit.exceeded":"500 term quota exceeded for dialect in this Org","term.already.exists":"The term for the dialect already exists in this Org"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:dictionaryterm:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsDictionaryfeedback"}},"/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}":{"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics SentimentFeedback by Id","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId","produces":["application/json"],"parameters":[{"name":"sentimentFeedbackId","in":"path","description":"The Id of the SentimentFeedback","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId"}},"/api/v2/speechandtextanalytics/sentimentfeedback":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics SentimentFeedback","description":"","operationId":"getSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","x-example":"en-US"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SentimentFeedbackEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentfeedback"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create a Speech & Text Analytics SentimentFeedback","description":"","operationId":"postSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The SentimentFeedback to create","required":true,"schema":{"$ref":"#/definitions/SentimentFeedback"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/SentimentFeedback"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrase.logograph.length.required":"The phrase should contain minimum 1 char & maximum 40 chars","bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phrase.maximum.words.exceeded":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","invalid.feedbackValue":"The feedbackValue & initialValue cannot be same","phrase.length.exceeded":"500 characters in a phrase limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","phrase.minimum.words.required":"The phrase does not contain a minimum of 1 word that provide sufficient context, or contains too many words beyond 20 and is too specific.","phrase.logograph.length.exceeded":"The phrase should contain minimum 1 char & maximum 40 chars","invalid.dialect":"The dialect is not supported","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"feedback.limit.exceeded":"2000 feedback quota exceeded in this Org","phrase.already.exists":"Feedback with same phrase for the dialect already exists in this Org."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsSentimentfeedback"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete All Speech & Text Analytics SentimentFeedback","description":"","operationId":"deleteSpeechandtextanalyticsSentimentfeedback","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"No Content"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:feedback:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsSentimentfeedback"}},"/api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get transcription engine settings of a program","description":"","operationId":"getSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramTranscriptionengines"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update transcription engine settings of a program","description":"","operationId":"putSpeechandtextanalyticsProgramTranscriptionengines","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"Program transcription engine setting","required":true,"schema":{"$ref":"#/definitions/TranscriptionEnginesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramTranscriptionEngines"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"transcriptionengine.limit.exceeded":"Exceeded maximum number of transcription engines quota","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dialect.duplicate":"Duplicated dialects","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Invalid Value"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramTranscriptionengines"}},"/api/v2/speechandtextanalytics/programs/transcriptionengines/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get supported dialects for each transcription engine","description":"","operationId":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SupportedDialectsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsTranscriptionenginesDialects"}},"/api/v2/speechandtextanalytics/sentiment/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics sentiment supported dialects","description":"","operationId":"getSpeechandtextanalyticsSentimentDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsSentimentDialects"}},"/api/v2/speechandtextanalytics/settings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech And Text Analytics Settings","description":"","operationId":"getSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"settings.not.found":"The organization does not have SpeechAndTextAnalytics settings","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSettings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update Speech And Text Analytics Settings","description":"","operationId":"putSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsSettings"},"patch":{"tags":["Speech & Text Analytics"],"summary":"Patch Speech And Text Analytics Settings","description":"","operationId":"patchSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"patchSpeechandtextanalyticsSettings"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/categories":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of detected Speech and Text Analytics categories of conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCategories","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"The id of the conversation","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number for the listing","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationCategoriesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested conversation could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCategories"}},"/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics general program job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsGeneralJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsGeneralJob"}},"/api/v2/speechandtextanalytics/programs/general/jobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics general program job","description":"","operationId":"postSpeechandtextanalyticsProgramsGeneralJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The general programs job to create","required":true,"schema":{"$ref":"#/definitions/GeneralProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"500 topics quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.program.job.already.running":"A General Program Job is already running"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsGeneralJobs"}},"/api/v2/speechandtextanalytics/topics/general":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the Speech & Text Analytics general topics for a given dialect","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneral","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralTopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneral"}},"/api/v2/speechandtextanalytics/programs/{programId}/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech & Text Analytics program mappings to queues and flows by id","description":"","operationId":"getSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramMappings"},"put":{"tags":["Speech & Text Analytics"],"summary":"Set Speech & Text Analytics program mappings to queues and flows","description":"","operationId":"putSpeechandtextanalyticsProgramMappings","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to set mappings for","required":true,"schema":{"$ref":"#/definitions/ProgramMappingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramMappings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.limit.exceeded":"500 flows limit exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","program.mappings.limit.exceeded":"20000 program mappings limit exceeded","constraint.validation":"%s","queues.limit.exceeded":"500 queues limit exceeded","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Queue / Flow with id {id} is already mapped to another program"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgramMappings"}},"/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish programs job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsPublishjob"}},"/api/v2/speechandtextanalytics/programs/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish programs job","description":"","operationId":"postSpeechandtextanalyticsProgramsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish programs job to create","required":true,"schema":{"$ref":"#/definitions/ProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","programs.limit.exceeded":"Limit of 10 programs to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","program.not.provided":"At least one Program Id should be provided","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsPublishjobs"}},"/api/v2/speechandtextanalytics/programs/{programId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics program by id","description":"","operationId":"getSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgram"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics program","description":"","operationId":"putSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to update","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgram"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics program by id","description":"","operationId":"deleteSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.","required":false,"type":"boolean","default":false,"enum":["true","false"]}],"responses":{"204":{"description":"The program was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","deleting.default.program.is.forbidden":"Default program deletion is not allowed"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsProgram"}},"/api/v2/speechandtextanalytics/programs/mappings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs mappings to queues and flows","description":"","operationId":"getSpeechandtextanalyticsProgramsMappings","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsMappingsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsMappings"}},"/api/v2/speechandtextanalytics/programs":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs","description":"","operationId":"getSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Program state. Defaults to Latest","required":false,"type":"string","enum":["Latest","Published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsPrograms"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics program","description":"","operationId":"postSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The program to create","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsPrograms"}},"/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish topics job by id","description":"","operationId":"getSpeechandtextanalyticsTopicsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish topics job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsPublishjob"}},"/api/v2/speechandtextanalytics/topics/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish topics job","description":"","operationId":"postSpeechandtextanalyticsTopicsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish topics job to create","required":true,"schema":{"$ref":"#/definitions/TopicJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"Limit of 50 topics to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","topic.not.provided":"At least one Topic Id should be provided","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopicsPublishjobs"}},"/api/v2/speechandtextanalytics/topics/{topicId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics topic by id","description":"","operationId":"getSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopic"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics topic","description":"","operationId":"putSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"},{"in":"body","name":"body","description":"The topic to update","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Wrong request structure","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","updating.dialect.is.forbidden":"Updating dialect is forbidden","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsTopic"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics topic by id","description":"","operationId":"deleteSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"204":{"description":"The topic was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"deleting.topic.used.in.category.is.forbidden":"The topic cannot be deleted. There are categories associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsTopic"}},"/api/v2/speechandtextanalytics/topics/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get list of supported Speech & Text Analytics topics dialects","description":"","operationId":"getSpeechandtextanalyticsTopicsDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsDialects"}},"/api/v2/speechandtextanalytics/topics":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics topics","description":"","operationId":"getSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing. The max that will be returned is 500.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"state","in":"query","description":"Topic state. Defaults to latest","required":false,"type":"string","enum":["latest","published"]},{"name":"name","in":"query","description":"Case insensitive partial name to filter by","required":false,"type":"string"},{"name":"ids","in":"query","description":"Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dialects","in":"query","description":"Comma separated dialect strings to filter by. Maximum of 15 dialects allowed.","required":false,"type":"array","items":{"type":"string","enum":["en-US","es-US","en-AU","en-GB","en-ZA","es-ES","en-IN","fr-FR","fr-CA","it-IT","de-DE","pt-BR","pl-PL","pt-PT","nl-NL","ko-KR"]},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort results by. Defaults to name","required":false,"type":"string","enum":["name"]},{"name":"sortOrder","in":"query","description":"Sort order. Defaults to asc","required":false,"type":"string","enum":["asc","desc"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopics"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics topic","description":"","operationId":"postSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The topic to create","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopics"}},"/api/v2/speechandtextanalytics/topics/general/status":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of general topics from the org and the system with their current status","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneralStatus","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedGeneralTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.supported.above.500.topics":"Out-of-the-box topics status api is not allowed over 500 topics"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneralStatus"}},"/api/v2/speechandtextanalytics/programs/unpublished":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics unpublished programs","description":"","operationId":"getSpeechandtextanalyticsProgramsUnpublished","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnpublishedProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsUnpublished"}},"/api/v2/speechandtextanalytics/transcripts/search":{"post":{"tags":["Search","Speech & Text Analytics"],"summary":"Search resources.","description":"","operationId":"postSpeechandtextanalyticsTranscriptsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly","speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","recording:recording:view"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTranscriptsSearch"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the pre-signed S3 URL for the transcript of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturl","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrl"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript url.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view","speechAndTextAnalytics:data:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturl"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturls","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrls"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript urls.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recordingSegment:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturls"}},"/api/v2/teams/{teamId}/members":{"get":{"tags":["Teams"],"summary":"Get team membership","description":"","operationId":"getTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeamMembers"},"post":{"tags":["Teams"],"summary":"Add team members","description":"","operationId":"postTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TeamMembers","required":true,"schema":{"$ref":"#/definitions/TeamMembers"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamMemberAddListingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"postTeamMembers"},"delete":{"tags":["Teams"],"summary":"Delete team members","description":"","operationId":"deleteTeamMembers","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of member ids to remove","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team members are removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","max.user.ids":"Only 25 members can be deleted at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"deleteTeamMembers"}},"/api/v2/teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get team","description":"","operationId":"getTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeam"},"delete":{"tags":["Teams"],"summary":"Delete team","description":"","operationId":"deleteTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, team was deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a team with that teamId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:delete"]},"x-purecloud-method-name":"deleteTeam"},"patch":{"tags":["Teams"],"summary":"Update team","description":"","operationId":"patchTeam","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"Team ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:edit"]},"x-purecloud-method-name":"patchTeam"}},"/api/v2/teams":{"get":{"tags":["Teams"],"summary":"Get Team listing","description":"","operationId":"getTeams","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Return only teams whose names start with this value (case-insensitive matching)","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the next item in the complete list of teams","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous item in the complete list of teams","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand the name on each user","required":false,"type":"string","enum":["entities.division"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"getTeams"},"post":{"tags":["Teams"],"summary":"Create a team","description":"","operationId":"postTeams","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Team","required":true,"schema":{"$ref":"#/definitions/Team"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Team"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","group.name.in.use":"Team with specified name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:add"]},"x-purecloud-method-name":"postTeams"}},"/api/v2/teams/search":{"post":{"tags":["Teams","Search"],"summary":"Search resources.","description":"","operationId":"postTeamsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TeamSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TeamsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:view"]},"x-purecloud-method-name":"postTeamsSearch"}},"/api/v2/telephony/mediaregions":{"get":{"tags":["Telephony"],"summary":"Retrieve the list of AWS regions media can stream through.","description":"","operationId":"getTelephonyMediaregions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaRegions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyMediaregions"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-purecloud-method-name":"deleteStationAssociateduser"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStation","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified station resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStation"}},"/api/v2/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"userSelectable","in":"query","description":"True for stations that the user can select otherwise false","required":false,"type":"string"},{"name":"webRtcUserId","in":"query","description":"Filter for the webRtc station of the webRtcUserId","required":false,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of stationIds","required":false,"type":"string"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Collaborate organizations do not have permission to work with stations","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting station listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting station listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStations"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}/headers":{"get":{"tags":["Telephony"],"summary":"Get SIP headers.","description":"Get parsed SIP headers. Returns specific headers if key query parameters are added.","operationId":"getTelephonySipmessagesConversationHeaders","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"},{"name":"keys","in":"query","description":"comma-separated list of header identifiers to query. e.g. ruri,to,from","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callheader"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversationHeaders"}},"/api/v2/telephony/sipmessages/conversations/{conversationId}":{"get":{"tags":["Telephony"],"summary":"Get a SIP message.","description":"Get the raw form of the SIP message","operationId":"getTelephonySipmessagesConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Callmessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySipmessagesConversation"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postTelephonyProvidersEdgesAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Address","required":true,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgesAddressvalidation"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesCertificateauthorities"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthority"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Certificate authority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesCertificateauthority"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesCertificateauthority"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticPing"},"post":{"tags":["Telephony Providers Edge"],"summary":"Ping Request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticPing"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticTracepath"},"post":{"tags":["Telephony Providers Edge"],"summary":"Tracepath request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticTracepath"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticNslookup"},"post":{"tags":["Telephony Providers Edge"],"summary":"Nslookup request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticNslookup"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticRoute"},"post":{"tags":["Telephony Providers Edge"],"summary":"Route request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticRoute"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postTelephonyProvidersEdgeReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Parameters for the edge reboot","required":false,"schema":{"$ref":"#/definitions/EdgeRebootParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeReboot"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["site"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdge"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","fingerprint.too.early":"Fingerprint sent before awaiting fingerprint verification","cant.modify.edge.group":"Edge group cannot be modified when edge is in service.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.required":"The site field is missing a value.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","incorrect.fingerprint":"The provided edge fingerprint was not correct.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","editing.managed.property.not.allowed":"Editing managed properties is not allowed.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to modify a managed edge."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdge"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdge"}},"/api/v2/telephony/providers/edges/{edgeId}/statuscode":{"post":{"tags":["Telephony Providers Edge"],"summary":"Take an Edge in or out of service","description":"","operationId":"postTelephonyProvidersEdgeStatuscode","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge Service State","required":false,"schema":{"$ref":"#/definitions/EdgeServiceStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The active Edge(s) assigned to a Site must all be assigned to the same Edge Group.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified edgeId not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeStatuscode"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Software update request","required":true,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgeSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"deleteTelephonyProvidersEdgeSoftwareupdate"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDtoEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareversions"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getTelephonyProvidersEdgesTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesTimezones"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postTelephonyProvidersEdgeUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"edge.offline":"Cannot unpair an edge that is offline.","site.has.enabled.connections":"Cannot remove a site from an edge that has enabled site connection.","conflict":"The Edge must have an inactive state to complete this operation."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeUnpair"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getTelephonyProvidersEdgesEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgeversionreport"}},"/api/v2/telephony/providers/edges/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLogicalinterfaces"}},"/api/v2/telephony/providers/edges/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get physical interfaces for edges.","description":"Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhysicalinterfaces"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"showCloudMedia","in":"query","description":"True to show the cloud media devices in the result.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting edge listing."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error while getting edge listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge.","description":"","operationId":"postTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","duplicate.edge.name":"The edge name is already in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdges"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterface"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Information was missing or malformed in the request","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Logical interface cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLogicalinterface"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgeLogicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogicalinterfaces"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getTelephonyProvidersEdgePhysicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterface"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getTelephonyProvidersEdgePhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterfaces"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDidpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesDidpool"}},"/api/v2/telephony/providers/edges/didpools/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of unassigned and/or assigned numbers in a set of DID Pools.","description":"","operationId":"getTelephonyProvidersEdgesDidpoolsDids","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"The type of numbers to return.","required":true,"type":"string","enum":["ASSIGNED_AND_UNASSIGNED","UNASSIGNED"]},{"name":"id","in":"query","description":"Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"numberMatch","in":"query","description":"A number to filter the results by.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpoolsDids"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesDidpools"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDid"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getTelephonyProvidersEdgesDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"},{"name":"owner.id","in":"query","description":"Filter by the owner of a phone number","required":false,"type":"string"},{"name":"didPool.id","in":"query","description":"Filter by the DID Pool assignment","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting DID listings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDids"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["phoneTrunkBases","edgeTrunkBaseAssignment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroup"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to update managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroup"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesEdgegroup"}},"/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets the edge trunk base associated with the edge group","description":"","operationId":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the edge trunk base associated with the edge group","description":"","operationId":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeTrunkBase","required":true,"schema":{"$ref":"#/definitions/EdgeTrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge groups not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An edge group with this name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesEdgegroups"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:edit"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtensionpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an extension pool with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:delete"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesExtensionpool"}},"/api/v2/telephony/providers/edges/extensionpools/divisionviews":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a pageable list of basic extension pool objects filterable by query parameters.","description":"This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the Extension Pools to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the Extension Pools to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:search"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpoolsDivisionviews"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"number","in":"query","description":"Deprecated, filtering by number not supported","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:extensionPool:add"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesExtensionpools"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtension"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getTelephonyProvidersEdgesExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:extensionPool:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensions"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesLinebasesetting","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesetting"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getTelephonyProvidersEdgesLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesettings"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getTelephonyProvidersEdgesLine","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLine"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getTelephonyProvidersEdgesLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated. The edgeGroup value is deprecated.","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLines"}},"/api/v2/telephony/providers/edges/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getTelephonyProvidersEdgesLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinesTemplate"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getTelephonyProvidersEdgeLogsJob","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the Edge logs job by given Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogsJob"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Log upload request","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job. Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find resource by given id(s).","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobUpload"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed. The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobs"}},"/api/v2/telephony/providers/edges/{edgeId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge metrics.","description":"","operationId":"getTelephonyProvidersEdgeMetrics","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find edge metrics by given id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeMetrics"}},"/api/v2/telephony/providers/edges/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of edges.","description":"","operationId":"getTelephonyProvidersEdgesMetrics","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EdgeMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMetrics"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplansClassifications"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplan","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","general.resource.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplan"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site. Only fetches the first 200 records.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans. A user can update maximum 200 number plans at a time.","description":"","operationId":"putTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of number plans","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"number.plan.in.use":"The number plan is in use by one or more outbound route.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.number.plan.name":"Number Plan names must be unique.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteNumberplans"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"Filter by externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroutes"}},"/api/v2/telephony/providers/edges/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id.","general.resource.not.found":"Unable to find a Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.expand.properties":"Server error, unable to expand base setting properties.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id","general.resource.not.found":"Unable to find a phone with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone base were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhonebasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Phone template cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhonebasesetting"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","lines"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Organization type is invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Phone base not found.","general.resource.not.found":"Phone base not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error getting phone base settings."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtc user is required.","base.settings.required":"A base setting is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonebasesettings"}},"/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getTelephonyProvidersEdgesPhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonesTemplate"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Request is badly formed.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the phone with that Id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error find phone with that Id."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhone"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","webrtc.user.required":"A webRtcUser is required.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to update Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the phone were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhone"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhone"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.","description":"","operationId":"getTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["name","status.operationalStatus","secondaryStatus.operationalStatus"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.id","required":false,"type":"string"},{"name":"lines.defaultForUser.id","in":"query","description":"Filter by lines.defaultForUser.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"lines.id","in":"query","description":"Filter by lines.id","required":false,"type":"string"},{"name":"lines.name","in":"query","description":"Filter by lines.name","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the Phone to filter by, comma-separated","required":false,"type":"string"},{"name":"status.operationalStatus","in":"query","description":"The primary status to filter by","required":false,"type":"string"},{"name":"secondaryStatus.operationalStatus","in":"query","description":"The secondary status to filter by","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser","lines.defaultForUser"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","lines.required":"A phone cannot be created without a line.","invalid.property":"Value [%s] is not a valid property for object [%s]","base.settings.required":"A base setting must be assigned to create a phone.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","unknown":"Unspecified error posting phone instance."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhones"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postTelephonyProvidersEdgesPhoneReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhoneReboot"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postTelephonyProvidersEdgesPhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phones","required":true,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/expired":{"get":{"tags":["Telephony Providers Edge"],"summary":"List of edges more than 4 edge versions behind the latest software.","description":"","operationId":"getTelephonyProvidersEdgesExpired","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExpiredEdgeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","internal:edge:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExpired"}},"/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get site connections for a site.","description":"","operationId":"getTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteSiteconnections"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update site connections for a site.","description":"","operationId":"putTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/SiteConnections"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteSiteconnections"},"patch":{"tags":["Telephony Providers Edge"],"summary":"Disable site connections for a site.","description":"","operationId":"patchTelephonyProvidersEdgesSiteSiteconnections","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/DisableSiteConnectionsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteConnections"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"General Bad Request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Site resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"patchTelephonyProvidersEdgesSiteSiteconnections"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSite"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"The request could not be understood by the server due to malformed syntax.","managed.property.not.allowed":"Not allowed to update managed property","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"NEEDED"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the site were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSite"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","managed.property.not.allowed":"Not allowed to delete a managed site."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.referenced.by.another":"The site is referenced by another resource.","general.conflict":"The site is being referenced or is set as the default site."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSite"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["edges","location","primarySites","secondarySites"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","referenced.key.does.not.exist":"Unable to find entity that matches the key.","duplicate.value":"At least one of the values in the request were a duplicate.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSites"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an outbound route","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Dependent entities exist."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSiteOutboundroute"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound route","description":"","operationId":"postTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"An outbound route with this name already exists.","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","address.classification.type.does.not.exist\t":"The address classification does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteOutboundroutes"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the trunk metrics.","description":"","operationId":"getTelephonyProvidersEdgesTrunkMetrics","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the trunk metrics with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkMetrics"}},"/api/v2/telephony/providers/edges/trunks/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of trunks.","description":"","operationId":"getTelephonyProvidersEdgesTrunksMetrics","produces":["application/json"],"parameters":[{"name":"trunkIds","in":"query","description":"Comma separated list of Trunk Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TrunkMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunksMetrics"}},"/api/v2/telephony/providers/edges/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to find the trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","validation.error":"Error validating the data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesTrunkbasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"delete.referenced.entity":"The trunk is being referenced.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to delete trunk base settings with that id.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesTrunkbasesetting"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the TrunkBase to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Trunk base settings not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","trunk.metabase.required":"A metabase is required for this function.","duplicate.value":"A trunk with that name already exists.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesTrunkbasesettings"}},"/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getTelephonyProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view","telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkswithrecording"}},"/api/v2/telephony/providers/edges/{edgeId}/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks for the given Edge.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgeTrunks","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.resource.not.found":"Specified edgeId not found.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeTrunks"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getTelephonyProvidersEdgesTrunk","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Trunk ID not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunk"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgesTrunks","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Available Trunk resources not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/{edgeId}/setuppackage":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.","description":"","operationId":"getTelephonyProvidersEdgeSetuppackage","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VmPairingInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeSetuppackage"}},"/api/v2/telephony/siptraces":{"get":{"tags":["Telephony"],"summary":"Fetch SIP metadata","description":"Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","operationId":"getTelephonySiptraces","produces":["application/json"],"parameters":[{"name":"callId","in":"query","description":"unique identification of the placed call","required":false,"type":"string"},{"name":"toUser","in":"query","description":"User to who the call was placed","required":false,"type":"string"},{"name":"fromUser","in":"query","description":"user who placed the call","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"Unique identification of the conversation","required":false,"type":"string"},{"name":"dateStart","in":"query","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"dateEnd","in":"query","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptraces"}},"/api/v2/telephony/siptraces/download":{"post":{"tags":["Telephony"],"summary":"Request a download of a pcap file to S3","description":"","operationId":"postTelephonySiptracesDownload","produces":["application/json"],"parameters":[{"in":"body","name":"SIPSearchPublicRequest","required":true,"schema":{"$ref":"#/definitions/SIPSearchPublicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipDownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:add"]},"x-purecloud-method-name":"postTelephonySiptracesDownload"}},"/api/v2/telephony/siptraces/download/{downloadId}":{"get":{"tags":["Telephony"],"summary":"Get signed S3 URL for a pcap download","description":"","operationId":"getTelephonySiptracesDownloadDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"unique id for the downloaded file in S3","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"202":{"description":"Request to download pcap file has been accepted","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptracesDownloadDownloadId"}},"/api/v2/infrastructureascode/accelerators/{acceleratorId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get information about an accelerator","description":"Get the complete metadata specification for an accelerator, including requirements and parameters.","operationId":"getInfrastructureascodeAccelerator","produces":["application/json"],"parameters":[{"name":"acceleratorId","in":"path","description":"Accelerator ID","required":true,"type":"string"},{"name":"preferredLanguage","in":"query","description":"Preferred Language","required":false,"type":"string","default":"en-US","enum":["ar","cs","da","de","en-US","es","fi","fr","it","iw","ko","ja","nl","no","pl","pt-BR","pt-PT","sv","th","tr","zh-CN","zh-TW"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorSpecification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerator"}},"/api/v2/infrastructureascode/accelerators":{"get":{"tags":["Infrastructure as Code"],"summary":"Get a list of available accelerators","description":"Search for accelerators that can be run.","operationId":"getInfrastructureascodeAccelerators","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"name","in":"query","description":"Filter by name","required":false,"type":"string"},{"name":"description","in":"query","description":"Filter by description","required":false,"type":"string"},{"name":"origin","in":"query","description":"Filter by origin","required":false,"type":"string","enum":["community","partner","genesys"]},{"name":"type","in":"query","description":"Filter by type","required":false,"type":"string","enum":["module","accelerator","blueprint"]},{"name":"classification","in":"query","description":"Filter by classification","required":false,"type":"string"},{"name":"tags","in":"query","description":"Filter by tags","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AcceleratorList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:accelerator:view"]},"x-purecloud-method-name":"getInfrastructureascodeAccelerators"}},"/api/v2/infrastructureascode/jobs/{jobId}":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job status and results","description":"Get the execution status of a submitted job, optionally including results and error details.","operationId":"getInfrastructureascodeJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"name":"details","in":"query","description":"Include details of execution, including job results or error information","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"202":{"description":"Job in progress.","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["infrastructureascode:job:view"]},"x-purecloud-method-name":"getInfrastructureascodeJob"}},"/api/v2/infrastructureascode/jobs":{"get":{"tags":["Infrastructure as Code"],"summary":"Get job history","description":"Get a history of submitted jobs, optionally including error messages.","operationId":"getInfrastructureascodeJobs","produces":["application/json"],"parameters":[{"name":"maxResults","in":"query","description":"Number of jobs to show","required":false,"type":"integer","default":1,"format":"int32"},{"name":"includeErrors","in":"query","description":"Include error messages","required":false,"type":"boolean","default":false},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"dateSubmitted","enum":["id","dateSubmitted","submittedBy","acceleratorId","status"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc","enum":["asc","desc"]},{"name":"acceleratorId","in":"query","description":"Find only jobs associated with this accelerator","required":false,"type":"string"},{"name":"submittedBy","in":"query","description":"Find only jobs submitted by this user","required":false,"type":"string"},{"name":"status","in":"query","description":"Find only jobs in this state","required":false,"type":"string","enum":["Created","Queued","Running","Complete","Failed","Incomplete"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode","infrastructureascode:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:job:view"]},"x-purecloud-method-name":"getInfrastructureascodeJobs"},"post":{"tags":["Infrastructure as Code"],"summary":"Create a Job","description":"Create and submit a job for remote execution or see job planning results.","operationId":"postInfrastructureascodeJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/AcceleratorInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"202":{"description":"Job submitted for execution.","schema":{"$ref":"#/definitions/InfrastructureascodeJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["infrastructureascode"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["infrastructureascode:job:add"]},"x-purecloud-method-name":"postInfrastructureascodeJobs"}},"/api/v2/textbots/botflows/sessions/{sessionId}/turns":{"post":{"tags":["Textbots"],"summary":"Issue a bot flow turn event","description":"Send a turn event to an executing bot flow and produce the next action to take.","operationId":"postTextbotsBotflowsSessionTurns","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions'","required":true,"type":"string"},{"in":"body","name":"turnRequest","required":true,"schema":{"$ref":"#/definitions/TextBotFlowTurnRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextBotFlowTurnResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.already.closed":"The bot session is closed","mismatched.turn.id":"The turn provided is not expected","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","too.many.queued.user.input.events":"Too many queued user input events have been submitted","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","unexpected.input.event":"An unexpected input event has been submitted","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","flow.blocked":"Flow ID %s has been temporarily blocked.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:botFlowSession:execute"]},"x-purecloud-method-name":"postTextbotsBotflowsSessionTurns"}},"/api/v2/textbots/botflows/sessions":{"post":{"tags":["Textbots"],"summary":"Create an execution instance of a bot flow definition.","description":"The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.","operationId":"postTextbotsBotflowsSessions","produces":["application/json"],"parameters":[{"in":"body","name":"launchRequest","required":true,"schema":{"$ref":"#/definitions/TextBotFlowLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextBotFlowLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","flow.version.not.published":"The flow version is not published","invalid.input.variables":"One or more of your input variables are invalid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","flow.blocked":"Flow ID %s has been temporarily blocked.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:botFlowSession:execute"]},"x-purecloud-method-name":"postTextbotsBotflowsSessions"}},"/api/v2/textbots/bots/execute":{"post":{"tags":["Textbots"],"summary":"Send an intent to a bot to start a dialog/interact with it via text","description":"This will either start a bot with the given id or relay a communication to an existing bot session.","operationId":"postTextbotsBotsExecute","produces":["application/json"],"parameters":[{"in":"body","name":"postTextRequest","required":true,"schema":{"$ref":"#/definitions/PostTextRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PostTextResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.invalid.bot.product":"The bot product type is unrecognized","bots.invalid.bot.argument":"An argument passed on to the bot was declared invalid by the bot service","bad.request":"The request could not be understood by the server due to malformed syntax.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","invalid.property":"Value [%s] is not a valid property for object [%s]","bots.bot.circuit.open":"The bot service is non responsive and we're in a back-off state until the service is restored.","bots.invalid.bot.vendor":"The bot vendor type is unrecognized","constraint.validation":"%s","bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.bot.session.closed":"The bot session is already closed and cannot be reused","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","bots.unsupported.language":"The language code is unsupported or not recognized","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","bots.invalid.bot.session.outcome":"The bot outcome is not recognized","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:session:execute"]},"x-purecloud-method-name":"postTextbotsBotsExecute"}},"/api/v2/textbots/bots/search":{"get":{"tags":["Textbots"],"summary":"Find bots using the currently configured friendly name or ID.","description":"The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100","operationId":"getTextbotsBotsSearch","produces":["application/json"],"parameters":[{"name":"botType","in":"query","description":"Bot types","required":false,"type":"array","items":{"type":"string","enum":["GenesysBotConnector","GenesysDialogEngine","AmazonLex","GoogleDialogFlowES","GoogleDialogFlowCX","NuanceDlg","GenesysBotFlow"]},"collectionFormat":"multi"},{"name":"botName","in":"query","description":"Bot name","required":false,"type":"string"},{"name":"botId","in":"query","description":"Bot IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"The maximum results to return","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotSearchResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getTextbotsBotsSearch"}},"/api/v2/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getTimezones"}},"/api/v2/tokens/timeout":{"get":{"tags":["Tokens"],"summary":"Get the current Idle Token Timeout Value","description":"","operationId":"getTokensTimeout","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdleTokenTimeout"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getTokensTimeout"},"put":{"tags":["Tokens"],"summary":"Update or Enable/Disable the Idle Token Timeout","description":"","operationId":"putTokensTimeout","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/IdleTokenTimeout"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdleTokenTimeout"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"token.timeout.exceeded":"When HIPAA is not enabled timeout must be between 300 and 28800 seconds","token.timeout.exceeded.hipaa":"When HIPAA is enabled timeout must be between 300 and 900 seconds","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","max.idle.token.timeout.exceeded":"When HIPAA is disabled timeout must be between 5 minutes and 8 hours.","invalid.property":"Value [%s] is not a valid property for object [%s]","max.idle.hipaa.token.timeout.exceeded":"When HIPAA is enabled timeout must be 15 minutes or less","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putTokensTimeout"}},"/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}":{"get":{"tags":["Integrations"],"summary":"UC integration client application configuration.","description":"This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.","operationId":"getIntegrationsUnifiedcommunicationsClientapp","produces":["application/json"],"parameters":[{"name":"ucIntegrationId","in":"path","description":"3rd Party Service Type","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedCommunicationsIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not available","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Integration could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsUnifiedcommunicationsClientapp"}},"/api/v2/integrations/unifiedcommunications/clientapps":{"get":{"tags":["Integrations"],"summary":"List UC integration client application configurations.","description":"This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.","operationId":"getIntegrationsUnifiedcommunicationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnifiedCommunicationsIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not enabled for your organization","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsUnifiedcommunicationsClientapps"}},"/api/v2/integrations/clientapps/unifiedcommunications":{"get":{"tags":["Integrations"],"summary":"UC integration client application configuration.","description":"Deprecated: Please use GET /integrations/unifiedcommunications/clientapps instead. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.","operationId":"getIntegrationsClientappsUnifiedcommunications","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UCIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","integrations.forbidden":"This product is not enabled for your organization","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:unifiedCommunications:view"]},"x-purecloud-method-name":"getIntegrationsClientappsUnifiedcommunications"}},"/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences":{"put":{"tags":["Integrations"],"summary":"Bulk integration presence ingestion","description":"This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.","operationId":"putIntegrationsUnifiedcommunicationThirdpartypresences","produces":["application/json"],"parameters":[{"name":"ucIntegrationId","in":"path","description":"UC Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UCThirdPartyPresence"}}}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.user.presences":"Only 25 user presences can be updated at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","no.user.presences":"No users matched integration presence lookup.","integration.not.found":"Integration ID not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:presence:edit"]},"x-purecloud-method-name":"putIntegrationsUnifiedcommunicationThirdpartypresences"}},"/api/v2/usage/query":{"post":{"tags":["Usage"],"summary":"Query organization API Usage - ","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postUsageQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageOrganizationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:organization:view"]},"x-purecloud-method-name":"postUsageQuery"}},"/api/v2/usage/query/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getUsageQueryExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:organization:view"]},"x-purecloud-method-name":"getUsageQueryExecutionIdResults"}},"/api/v2/usage/simplesearch":{"post":{"tags":["Usage"],"summary":"Search organization API Usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results","operationId":"postUsageSimplesearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SimpleSearch","required":true,"schema":{"$ref":"#/definitions/ApiUsageSimpleSearch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:simpleSearch:view"]},"x-purecloud-method-name":"postUsageSimplesearch"}},"/api/v2/usage/simplesearch/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage search. Number of records to be returned is limited to 20,000 results.","description":"","operationId":"getUsageSimplesearchExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the search execution","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The max number of entities to be returned per request. Maximum page size of 1000","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.response.size.reached":"The results data is greater than the 5MB limit. Try again with a smaller date interval or include more filters.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","query.error":"There was a problem running the query"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view","usage:simpleSearch:view"]},"x-purecloud-method-name":"getUsageSimplesearchExecutionIdResults"}},"/api/v2/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]},{"name":"async","in":"query","description":"When set to true, api will return 202 response until the recording is ready for download","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Recording is queued for transcoding","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingMedia"}},"/api/v2/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecording"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":true,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"putUserrecording"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"deleteUserrecording"}},"/api/v2/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getUserrecordingsSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingsSummary"}},"/api/v2/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You are not permitted to get a list of user recordings.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordings"}},"/api/v2/users/{userId}/externalid":{"post":{"tags":["Users"],"summary":"Create mapping between external identifier and user. Limit 100 per entity.","description":"Authority Name and External key are case sensitive.","operationId":"postUserExternalid","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/UserExternalIdentifier"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserExternalIdentifier"}}},"201":{"description":"External Identifier Created","schema":{"type":"array","items":{"$ref":"#/definitions/UserExternalIdentifier"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"The external identifier already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"postUserExternalid"}},"/api/v2/users/me/password":{"post":{"tags":["Users"],"summary":"Change your password","description":"","operationId":"postUsersMePassword","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangeMyPasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"password.compromised":"The new password is a compromised, frequently used password","password.too.young":"The new password cannot be changed yet","bad.request":"The request could not be understood by the server due to malformed syntax.","password.empty":"The new password cannot be empty","password.not.enough.digits":"The new password does not have enough numbers","password.not.enough.specials":"The new password does not have enough special characters","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.old.password":"The old password is incorrect.","constraint.validation":"%s","invalid.new.password":"The new password does not meet policy requirements.","invalid.password":"The new password does not meet policy requirements or the old password is incorrect.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","password.not.enough.letters":"The new password does not have enough letters","password.not.enough.lowercase":"The new password does not have enough lower case letters","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","password.reused":"The new password has been used too recently","password.not.enough.uppercase":"The new password does not have enough upper case letters","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","password.too.short":"The new password is too short"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"postUsersMePassword"}},"/api/v2/users/me":{"get":{"tags":["Users"],"summary":"Get current user details.","description":"This request is not valid when using the Client Credentials OAuth grant.","operationId":"getUsersMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","date","geolocationsettings","organization","presencedefinitions","divisionedpresencedefinitions","locationdefinitions","orgauthorization","orgproducts","favorites","superiors","directreports","adjacents","routingskills","routinglanguages","fieldconfigs","token","trustors","logCapture"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested userID could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getUsersMe"}},"/api/v2/users/{userId}/password":{"post":{"tags":["Users"],"summary":"Change a users password","description":"","operationId":"postUserPassword","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangePasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"password.compromised":"The new password is a compromised, frequently used password","password.too.young":"The new password cannot be changed yet","bad.request":"The request could not be understood by the server due to malformed syntax.","password.empty":"The new password cannot be empty","password.not.enough.digits":"The new password does not have enough numbers","password.not.enough.specials":"The new password does not have enough special characters","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.new.password":"The new password does not meet policy requirements","invalid.password":"The new password does not meet policy requirements","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","password.not.enough.letters":"The new password does not have enough letters","password.not.enough.lowercase":"The new password does not have enough lower case letters","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","password.reused":"The new password has been used too recently","password.not.enough.uppercase":"The new password does not have enough upper case letters","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","password.too.short":"The new password is too short"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:setPassword"]},"x-purecloud-method-name":"postUserPassword"}},"/api/v2/users/{userId}/profileskills":{"get":{"tags":["Users"],"summary":"List profile skills for a user","description":"","operationId":"getUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:view"]},"x-purecloud-method-name":"getUserProfileskills"},"put":{"tags":["Users"],"summary":"Update profile skills for a user","description":"","operationId":"putUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skills","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:edit"]},"x-purecloud-method-name":"putUserProfileskills"}},"/api/v2/users/{userId}/queues/{queueId}":{"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueue"}},"/api/v2/users/{userId}/queues":{"get":{"tags":["Routing","Users"],"summary":"Get queues for user","description":"","operationId":"getUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"joined","in":"query","description":"Is joined to the queue","required":false,"type":"boolean","default":true},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"getUserQueues"},"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueues"}},"/api/v2/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},{"name":"state","in":"query","description":"Search for a user with this state","required":false,"type":"string","default":"active","enum":["active","deleted"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUser"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Conflict deleting specified userId."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId. ","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete","directory:organization:admin"]},"x-purecloud-method-name":"deleteUser"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UpdateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The version supplied does not match the current version of the user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","insufficient.permissions":"Insufficient permissions to update a user","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:organization:admin"]},"x-purecloud-method-name":"patchUser"}},"/api/v2/users/{userId}/invite":{"post":{"tags":["Users"],"summary":"Send an activation email to the user","description":"","operationId":"postUserInvite","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Resend the invitation even if one is already outstanding","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Invitation Sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","insufficient.permissions":"Insufficient permissions for sending an activation email.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin","directory:userPassword:edit"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Users","Routing"],"summary":"Remove routing language from user","description":"","operationId":"deleteUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"}],"responses":{"204":{"description":"Language removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Routing language was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"deleteUserRoutinglanguage"},"patch":{"tags":["Users","Routing"],"summary":"Update routing language proficiency or state.","description":"","operationId":"patchUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguage"}},"/api/v2/users/{userId}/routinglanguages":{"get":{"tags":["Users","Routing"],"summary":"List routing language for user","description":"","operationId":"getUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutinglanguages"},"post":{"tags":["Users","Routing"],"summary":"Add routing language to user","description":"","operationId":"postUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguagePost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict adding route language to user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postUserRoutinglanguages"}},"/api/v2/users/{userId}/routinglanguages/bulk":{"patch":{"tags":["Users","Routing"],"summary":"Add bulk routing language to user. Max limit 50 languages","description":"","operationId":"patchUserRoutinglanguagesBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguagePost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguagesBulk"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Users","Routing"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskill"},"delete":{"tags":["Users","Routing"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Resource not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"deleteUserRoutingskill"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Users","Routing"],"summary":"List routing skills for user","description":"","operationId":"getUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingskills"},"post":{"tags":["Users","Routing"],"summary":"Add routing skill to user","description":"","operationId":"postUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkillPost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Error adding route skill to user, bad request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict found adding route skill to user."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"postUserRoutingskills"}},"/api/v2/users/{userId}/routingskills/bulk":{"put":{"tags":["Users","Routing"],"summary":"Replace all routing skills assigned to a user","description":"","operationId":"putUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflicts found replacing routing skills for user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"One or more route skill(s) not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskillsBulk"},"patch":{"tags":["Users","Routing"],"summary":"Bulk add routing skills to user","description":"","operationId":"patchUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"patchUserRoutingskillsBulk"}},"/api/v2/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":true,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"An invalid routing status transition was attempted.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserRoutingstatus"}},"/api/v2/users/{userId}/skillgroups":{"get":{"tags":["Routing","Users"],"summary":"Get skill groups for a user","description":"","operationId":"getUserSkillgroups","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"after","in":"query","description":"The cursor that points to the next page","required":false,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the previous page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skillGroup:view"]},"x-purecloud-method-name":"getUserSkillgroups"}},"/api/v2/users/{userId}/state":{"get":{"tags":["Users"],"summary":"Get user state information.","description":"","operationId":"getUserState","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserState"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userStateChange:view"]},"x-purecloud-method-name":"getUserState"},"put":{"tags":["Users"],"summary":"Update user state information.","description":"","operationId":"putUserState","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UserState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserState"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Bad user request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"putUserState"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserStation"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to create a tab configuration due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"edgeconfiguser.userdoesnotexist":"The requested user was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"deleteUserStationAssociatedstation"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.stationalreadyhasdefaultuser":"Station is already associated","general.conflict":"2 or more users attempted to set the station as their default at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"putUserStationDefaultstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"deleteUserStationDefaultstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","userservice.station.notfound":"Station is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.station.providerlocationmissing":"The location of the station could not be found","userservice.stationalreadyassociated":"Station is already associated","general.conflict":"2 or more users attempted to associate with the station at the same time.","userservice.station.nothomed":"The station is incorrectly or not assigned"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserStationAssociatedstationStationId"}},"/api/v2/users/{userId}/trustors":{"get":{"tags":["Users"],"summary":"List the organizations that have authorized/trusted the user.","description":"","operationId":"getUserTrustors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getUserTrustors"}},"/api/v2/users/bulk":{"patch":{"tags":["Users"],"summary":"Update bulk acd autoanswer on users. Max 50 users can be updated at a time.","description":"","operationId":"patchUsersBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PatchUser"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max user ids":"Only 50 users can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","max.directory.users":"Only 50 users can be requested at a time","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:organization:admin"]},"x-purecloud-method-name":"patchUsersBulk"}},"/api/v2/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin"]},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","default":"active","enum":["active","inactive","deleted","any"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested user(s) could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.password":"The user was created successfully but the provided password does not meet the password policy requirements","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.set.password":"The user was created successfully but password configuration failed","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUsers"}},"/api/v2/users/search":{"get":{"tags":["Users","Search"],"summary":"Search users using the q64 value returned from a previous search","description":"","operationId":"getUsersSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"integrationPresenceSource","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"getUsersSearch"},"post":{"tags":["Users","Search"],"summary":"Search users","description":"","operationId":"postUsersSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postUsersSearch"}},"/api/v2/users/search/teams/assign":{"post":{"tags":["Users","Search"],"summary":"Search users assigned to teams","description":"","operationId":"postUsersSearchTeamsAssign","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["groups:team:assign"]},"x-purecloud-method-name":"postUsersSearchTeamsAssign"}},"/api/v2/voicemail/groups/{groupId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailGroupMessages","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"Not authorized to access voicemail messages","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMessages"}},"/api/v2/voicemail/queues/{queueId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailQueueMessages","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["voicemail:acdvoicemail:view"]},"x-purecloud-method-name":"getVoicemailQueueMessages"}},"/api/v2/voicemail/me/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMeMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMessages"}},"/api/v2/voicemail/groups/{groupId}/policy":{"get":{"tags":["Voicemail"],"summary":"Get a group's voicemail policy","description":"","operationId":"getVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.groupnotfound":"The voicemail policy was not found","general.resource.not.found":"The voicemail policy was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"getVoicemailGroupPolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a group's voicemail policy","description":"","operationId":"patchVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The group's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"patchVoicemailGroupPolicy"}},"/api/v2/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMailbox"}},"/api/v2/voicemail/me/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMeMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMailbox"}},"/api/v2/voicemail/groups/{groupId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the group's mailbox information","description":"","operationId":"getVoicemailGroupMailbox","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMailbox"}},"/api/v2/voicemail/me/policy":{"get":{"tags":["Voicemail"],"summary":"Get the current user's voicemail policy","description":"","operationId":"getVoicemailMePolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMePolicy"},"patch":{"tags":["Voicemail"],"summary":"Update the current user's voicemail policy","description":"","operationId":"patchVoicemailMePolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMePolicy"}},"/api/v2/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get a voicemail message","description":"","operationId":"getVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessage"},"put":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"putVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","constraint.validation":"%s","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"putVoicemailMessage"},"delete":{"tags":["Voicemail"],"summary":"Delete a voicemail message.","description":"A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.","operationId":"deleteVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessage"},"patch":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"patchVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","constraint.validation":"%s","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.toomanyrequests":"Too many requests have been made in the given time","voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMessage"}},"/api/v2/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this voicemail message","description":"","operationId":"getVoicemailMessageMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessageMedia"}},"/api/v2/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMessages","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"An optional comma separated list of VoicemailMessage ids","required":false,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access a voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessages"},"post":{"tags":["Voicemail"],"summary":"Copy a voicemail message to a user or group","description":"","operationId":"postVoicemailMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CopyVoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","voicemail.copy.missing.voicemail.message.id":"The request requires a voicemailMessageId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","voicemail.copy.missing.target":"The request requires a userId or groupId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.copy.group.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the group because they do not have voicemail enabled","voicemail.copy.user.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the user because they do not have voicemail enabled"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"postVoicemailMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteVoicemailMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessages"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailPolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getVoicemailPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailPolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.alerttimeouttoolarge":"AlertTimeoutTooLarge","voicemailservice.orgvoicemailconfig.maxpinlengthtoosmall":"MaxPinLengthTooSmall","voicemailservice.orgvoicemailconfig.iterationstoolarge":"IterationsTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaysmissing":"UserVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypemissing":"GroupVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimegreaterthanmax":"MinRecordingTimeGreaterThanMax","voicemailservice.orgvoicemailconfig.organizationnotfound":"OrganizationNotFound","voicemailservice.orgvoicemailconfig.saltlengthtoolarge":"SaltLengthTooLarge","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaysmissing":"GroupVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoolarge":"GroupVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypemissing":"UserVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypeunknown":"QueueVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoosmall":"GroupVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthtoosmall":"MinPinLengthTooSmall","voicemailservice.orgvoicemailconfig.maxrecordingtimetoolarge":"MaxRecordingTimeTooLarge","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoolarge":"QueueVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypeunknown":"UserVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.alerttimeouttoosmall":"AlertTimeoutTooSmall","voicemailservice.orgvoicemailconfig.iterationstoosmall":"IterationsTooSmall","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoolarge":"UserVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.invalidalgorithm":"InvalidAlgorithm","voicemailservice.orgvoicemailconfig.keylengthtoosmall":"KeyLengthTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoosmall":"QueueVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypemissing":"QueueVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimetoosmall":"MinRecordingTimeTooSmall","voicemailservice.orgvoicemailconfig.hipaaenabledorganizationcannotsendemailnotifications":"HipaaEnabledOrganizationCannotSendEmailNotifications","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaysmissing":"QueueVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypeunknown":"GroupVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoosmall":"UserVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.keylengthtoolarge":"KeyLengthTooLarge","voicemailservice.orgvoicemailconfig.saltlengthtoosmall":"SaltLengthTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthgreaterthanmax":"MinPinLengthGreaterThanMax"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.unabletoverifyorganizationhipaaenabledflag":"UnableToVerifyOrganizationHipaaEnabledFlag"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailPolicy"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.user.usernotfound":"The specified voicemail user not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailUserpolicy"},"put":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"putVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailUserpolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailUserpolicy"}},"/api/v2/voicemail/search":{"get":{"tags":["Voicemail","Search"],"summary":"Search voicemails using the q64 value returned from a previous search","description":"","operationId":"getVoicemailSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailSearch"},"post":{"tags":["Voicemail","Search"],"summary":"Search voicemails","description":"","operationId":"postVoicemailSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/VoicemailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"postVoicemailSearch"}},"/api/v2/flows/jobs":{"post":{"tags":["Architect"],"summary":"Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.","description":"","operationId":"postFlowsJobs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RegisterArchitectJobResponse"}},"202":{"description":"Architect Job registered.","schema":{"$ref":"#/definitions/RegisterArchitectJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:job:create"]},"x-purecloud-method-name":"postFlowsJobs"}},"/api/v2/flows/jobs/{jobId}":{"get":{"tags":["Architect"],"summary":"Fetch Architect Job Status","description":"","operationId":"getFlowsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ArchitectJobStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","general.bad.request":"Bad request","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a job with that jobId","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:job:view"]},"x-purecloud-method-name":"getFlowsJob"}},"/api/v2/architect/dependencytracking/consumedresources":{"get":{"tags":["Architect"],"summary":"Get resources that are consumed by a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumedresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consuming object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Consuming object version","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consuming object type. Only versioned types are allowed here.","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"resourceType","in":"query","description":"Types of consumed resources to show","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumedResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.dependency.object.version.not.specified":"A version was not specified for the dependency object.","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumedresources"}},"/api/v2/architect/dependencytracking/consumingresources":{"get":{"tags":["Architect"],"summary":"Get resources that consume a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumingresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consumed object ID","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consumed object type","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"resourceType","in":"query","description":"Types of consuming resources to show. Only versioned types are allowed here.","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumingResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumingresources"}},"/api/v2/architect/dependencytracking/deletedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that consume deleted resources","description":"","operationId":"getArchitectDependencytrackingDeletedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.filter":"An invalid filter was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingDeletedresourceconsumers"}},"/api/v2/architect/dependencytracking/build":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking build status for an organization","description":"","operationId":"getArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingBuild"},"post":{"tags":["Architect"],"summary":"Rebuild Dependency Tracking data for an organization","description":"Asynchronous. Notification topic: v2.architect.dependencytracking.build","operationId":"postArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - the rebuild has begun."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependencies.build.in.progress":"A build of dependency information is already in progress."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:rebuild"]},"x-purecloud-method-name":"postArchitectDependencytrackingBuild"}},"/api/v2/architect/dependencytracking/object":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingObject","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type","required":false,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},{"name":"consumedResources","in":"query","description":"Include resources this item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume this item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResourceRequest","in":"query","description":"Indicate that this is going to look up a consumed resource object","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObject"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","architect.dependency.object.not.versioned":"A version was provided for a non-versioned dependency object type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingObject"}},"/api/v2/architect/dependencytracking":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that have a given display name","description":"","operationId":"getArchitectDependencytracking","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Object name to search for","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResources","in":"query","description":"Include resources each result item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume each result item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the organization's data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.dependency.object.name.not.specified":"A name was not specified for the dependency object search.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytracking"}},"/api/v2/architect/dependencytracking/types/{typeId}":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking type.","description":"","operationId":"getArchitectDependencytrackingType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Type ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.type":"An invalid dependency type was specified.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.unavailable.type":"Dependency Tracking type is unavailable."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingType"}},"/api/v2/architect/dependencytracking/types":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking types.","description":"","operationId":"getArchitectDependencytrackingTypes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingTypes"}},"/api/v2/architect/emergencygroups/{emergencyGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a emergency group by ID","description":"","operationId":"getArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroup"},"put":{"tags":["Architect"],"summary":"Updates a emergency group by ID","description":"","operationId":"putArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the emergency group were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:edit"]},"x-purecloud-method-name":"putArchitectEmergencygroup"},"delete":{"tags":["Architect"],"summary":"Deletes a emergency group by ID","description":"","operationId":"deleteArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"could not find the requested emergency group","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:delete"]},"x-purecloud-method-name":"deleteArchitectEmergencygroup"}},"/api/v2/architect/emergencygroups/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic emergency group objects filterable by query parameters.","description":"This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getArchitectEmergencygroupsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the Emergency Groups to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:search"]},"x-purecloud-method-name":"getArchitectEmergencygroupsDivisionviews"}},"/api/v2/architect/emergencygroups":{"get":{"tags":["Architect"],"summary":"Get a list of emergency groups.","description":"","operationId":"getArchitectEmergencygroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroups"},"post":{"tags":["Architect"],"summary":"Creates a new emergency group","description":"","operationId":"postArchitectEmergencygroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:emergencyGroup:add"]},"x-purecloud-method-name":"postArchitectEmergencygroups"}},"/api/v2/flows/actions/unlock":{"post":{"tags":["Architect"],"summary":"Unlock flow","description":"Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.","operationId":"postFlowsActionsUnlock","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsUnlock"}},"/api/v2/flows/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsPublish","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"202":{"description":"Accepted - the publish has begun"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.auth.token.missing":"This operation cannot be performed without an authorization token.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.flow.cannot.publish.default":"Cannot publish default version of flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.publish.missing.dependencies":"Flow version cannot be published due to having one or more missing dependencies.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.flow.locked.by.user":"Flow is locked by another user.","architect.flow.cannot.checkin.missing.config":"Flow cannot be checked in because there is no saved configuration.","architect.operation.already.in.progress":"An operation is already in progress on the object.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.variable.missing":"Flow cannot be published because one or more variables are missing.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unknown error occurred.","architect.external.publish.error":"A backend service error occurred while publishing the flow.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock","architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsPublish"}},"/api/v2/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit","architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsCheckin"}},"/api/v2/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postFlowsActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.locked.by.user":"Flow is locked by another user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsCheckout"}},"/api/v2/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postFlowsActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.default.voicemail.flow.cannot.deactivate":"Cannot deactivate the default voicemail flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.default.flow.cannot.deactivate":"Cannot deactivate the default in-queue flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.deactivate.used.in.emergency.groups":"The flow cannot be deactivated because it's being used by one or more emergency groups.","architect.flow.cannot.deactivate.used.in.pe.action.maps":"The flow cannot be deactivated because it's being used by one or more predictive engagement action maps.","architect.flow.cannot.deactivate.used.in.queues":"The flow cannot be deactivated because it's being used by one or more queues.","architect.flow.cannot.deactivate.used.in.email.routes":"The flow cannot be deactivated because it's being used by one or more email routes.","architect.flow.cannot.deactivate.used.by.message.addresses":"The flow cannot be deactivated because it's being used by one or more message addresses.","architect.flow.cannot.deactivate.used.in.widgets":"The flow cannot be deactivated because it's being used by one or more widgets.","architect.flow.cannot.deactivate.used.in.ivr.configs":"The flow cannot be deactivated because it's being used by one or more IVR configurations.","architect.flow.cannot.deactivate.used.in.recording.policies":"The flow cannot be deactivated because it's being used by one or more recording policies.","architect.flow.cannot.deactivate.used.in.composer.scripts":"The flow cannot be deactivated because it's being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsDeactivate"}},"/api/v2/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postFlowsActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsRevert"}},"/api/v2/flows/executions/{flowExecutionId}":{"get":{"tags":["Architect"],"summary":"Get a flow execution's details. Flow execution details are available for several days after the flow is started.","description":"","operationId":"getFlowsExecution","produces":["application/json"],"parameters":[{"name":"flowExecutionId","in":"path","description":"flow execution ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowRuntimeExecution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Specifiec flow execution not found.","architect.execution.flow.not.found":"Could not find flow execution with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowExecution:view"]},"x-purecloud-method-name":"getFlowsExecution"}},"/api/v2/flows/executions":{"post":{"tags":["Architect"],"summary":"Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.","description":"The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.","operationId":"postFlowsExecutions","produces":["application/json"],"parameters":[{"in":"body","name":"flowLaunchRequest","required":true,"schema":{"$ref":"#/definitions/FlowExecutionLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flow.config.not.published":"Flow definition has not been published","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","flow.definition.missing":"Flow definition file cannot be loaded","architect.object.validate.failed":"Failed to validate object.","variable.value.not.allowed":"The variable value is not a legal value","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.var.not.marked.in.flow.def":"Input variable in the Variable Manifest List from the flow launch request object has not been marked as an Input to flow within the Architect flow definition","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","flow.invalid.state":"Flow definition is in an invalid state"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.not.found":"An item could not be found","not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Could not find flow execution with specified ID.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:launch"]},"x-purecloud-method-name":"postFlowsExecutions"}},"/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health":{"get":{"tags":["Architect"],"summary":"Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.","description":"","operationId":"getFlowVersionIntentHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"intentId","in":"path","description":"Intent ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":true,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealthIntent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionIntentHealth"}},"/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health":{"get":{"tags":["Architect"],"summary":"Get health metrics associated with a specific utterance of an intent.","description":"","operationId":"getFlowVersionIntentUtteranceHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"intentId","in":"path","description":"Intent ID.","required":true,"type":"string"},{"name":"utteranceId","in":"path","description":"Utterance ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":true,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealthUtterance"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionIntentUtteranceHealth"}},"/api/v2/flows/{flowId}/versions/{versionId}/health":{"get":{"tags":["Architect"],"summary":"Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.","description":"","operationId":"getFlowVersionHealth","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID.","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID.","required":true,"type":"string"},{"name":"language","in":"query","description":"Language to filter for","required":false,"type":"string","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowHealth"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionHealth"}},"/api/v2/flows/milestones/{milestoneId}":{"get":{"tags":["Architect"],"summary":"Get a flow milestone","description":"Returns a specified flow milestone","operationId":"getFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Specified flow milestone not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestone"},"put":{"tags":["Architect"],"summary":"Updates a flow milestone","description":"","operationId":"putFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:edit"]},"x-purecloud-method-name":"putFlowsMilestone"},"delete":{"tags":["Architect"],"summary":"Delete a flow milestone.","description":"","operationId":"deleteFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:delete"]},"x-purecloud-method-name":"deleteFlowsMilestone"}},"/api/v2/flows/milestones/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow milestone information objects filterable by query parameters.","description":"This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsMilestonesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:search"]},"x-purecloud-method-name":"getFlowsMilestonesDivisionviews"}},"/api/v2/flows/milestones":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow milestones, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.","operationId":"getFlowsMilestones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestones"},"post":{"tags":["Architect"],"summary":"Create a flow milestone","description":"","operationId":"postFlowsMilestones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.exceeded.max.amount":"Could not create flow milestone since the maximum number of milestones already exist.","architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:add"]},"x-purecloud-method-name":"postFlowsMilestones"}},"/api/v2/flows/outcomes/{flowOutcomeId}":{"get":{"tags":["Architect"],"summary":"Get a flow outcome","description":"Returns a specified flow outcome","operationId":"getFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Specified flow outcome not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcome"},"put":{"tags":["Architect"],"summary":"Updates a flow outcome","description":"Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}","operationId":"putFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find the specified flow outcome.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:edit"]},"x-purecloud-method-name":"putFlowsOutcome"}},"/api/v2/flows/outcomes/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow outcome information objects filterable by query parameters.","description":"This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsOutcomesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:search"]},"x-purecloud-method-name":"getFlowsOutcomesDivisionviews"}},"/api/v2/flows/outcomes":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow outcomes, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.","operationId":"getFlowsOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find resource with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcomes"},"post":{"tags":["Architect"],"summary":"Create a flow outcome","description":"Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}","operationId":"postFlowsOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.validate.failed":"Failed to validate flow outcome.","architect.flow.outcome.validate.failed.missing.name":"Failed to validate flow outcome due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.permission":"You are not authorized to perform the requested action.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","architect.flow.outcome.exceeded.max.amount":"Could not create flow outcome since the maximum number of outcomes already exist."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:add"]},"x-purecloud-method-name":"postFlowsOutcomes"}},"/api/v2/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow","description":"","operationId":"getFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","Inbound.Email.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound email flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","Outbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an outbound call flow.","Inbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound call flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","Inqueue.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inqueue call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey invite flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlow"},"put":{"tags":["Architect"],"summary":"Update flow","description":"","operationId":"putFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.system.flow.name.or.description.error":"System flow names and descriptions cannot be changed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"putFlow"},"delete":{"tags":["Architect"],"summary":"Delete flow","description":"","operationId":"deleteFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.default.flow.cannot.delete":"Cannot delete the default in-queue flow.","architect.flow.cannot.delete.user.does.not.have.lock":"Flow cannot be deleted because it is locked by another user.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.default.voicemail.flow.cannot.delete":"Cannot delete the default voicemail flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.pe.action.maps":"Flow cannot be deleted due to being used by one or more predictive engagement action maps.","architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.flow.cannot.delete.used.in.widgets":"Flow cannot be deleted due to being used by one or more widgets.","architect.flow.cannot.delete.used.by.message.addresses":"Flow cannot be deleted due to being used by one or more message addresses.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.cannot.delete.used.in.recording.policies":"Flow cannot be deleted due to being used by one or more recording policies.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts.","architect.flow.cannot.delete.used.in.emergency.groups":"Flow cannot be deleted due to being used by one or more emergency groups."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlow"}},"/api/v2/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow","description":"","operationId":"getFlowLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flow.no.config.available":"Flow has no saved or checked-in configuration."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowLatestconfiguration"}},"/api/v2/flows/{flowId}/history":{"post":{"tags":["Architect"],"summary":"Generate flow history","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowHistory","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"postFlowHistory"}},"/api/v2/flows/{flowId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated flow history","description":"","operationId":"getFlowHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowHistoryHistoryId"}},"/api/v2/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowVersion","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersion"}},"/api/v2/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowVersionConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionConfiguration"}},"/api/v2/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Include Deleted flows","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.data.missing":"Flow version data content is missing.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.flow.version.validate.failed.configuration.version":"Flow version object configuration version is missing or invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.flow.serialize.failed":"Could not serialize flow data.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowVersions"}},"/api/v2/flows/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow information objects filterable by query parameters.","description":"This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsDivisionviews","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","inqueueemail","inqueueshortmessage","speech","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flow:search"]},"x-purecloud-method-name":"getFlowsDivisionviews"}},"/api/v2/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","inqueueemail","inqueueshortmessage","speech","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"lockedByClientId","in":"query","description":"Locked by client ID","required":false,"type":"string"},{"name":"secure","in":"query","description":"Secure","required":false,"type":"string","enum":["any","checkedin","published"]},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}},{"name":"language","in":"query","description":"Language","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.cannot.create.unsupported.language.provided":"Failed to create flow. An unsupported language was specified.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.cannot.create.invalid.language.provided":"Failed to create flow. An invalid language was specified.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.digital.bot.flow.invalid.operation":"Cannot perform requested operation on a digital bot flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.system.flow.cannot.create":"Users cannot create system flows.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey flow.","architect.flow.cannot.create.not.user.creatable":"Failed to create flow. New instances of this flow type cannot be created."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.exceeded.max.amount":"Flow cannot be created because the maximum total number of flows has been reached.","architect.flow.cannot.create.type.max.exceeded":"Flow cannot be created because the maximum number of flows allowed for that type has been reached.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:add"]},"x-purecloud-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one flow could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlows"}},"/api/v2/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified IVR Config was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvr"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the IVR Config were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:edit"]},"x-purecloud-method-name":"putArchitectIvr"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Could not find the IVR config supplied","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Conflict occurred while deleting an IVR Config."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:delete"]},"x-purecloud-method-name":"deleteArchitectIvr"}},"/api/v2/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getArchitectIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"},{"name":"dnis","in":"query","description":"The phone number of the IVR to filter by.","required":false,"type":"string"},{"name":"scheduleGroup","in":"query","description":"The Schedule Group of the IVR to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postArchitectIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:add"]},"x-purecloud-method-name":"postArchitectIvrs"}},"/api/v2/architect/ivrs/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic ivr configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectIvrsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the IVR to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVRDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:callRoute:search"]},"x-purecloud-method-name":"getArchitectIvrsDivisionviews"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find resource with specified prompt.","not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResource"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPromptResource"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deleteArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResource"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio":{"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource audio","description":"","operationId":"deleteArchitectPromptResourceAudio","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Audio successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.audio.cannot.delete":"Failed to delete the audio for the resource.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResourceAudio"}},"/api/v2/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query parameters can be used for filtering.","operationId":"getArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource","description":"","operationId":"postArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAssetCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.prompt.resource.already.exists":"Prompt already has a resource with specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"postArchitectPromptResources"}},"/api/v2/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompt"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPrompt"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deleteArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"allResources","in":"query","description":"Whether or not to delete all the prompt resources","required":false,"type":"boolean"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.cannot.delete.used.in.queues":"Prompt cannot be deleted due to being used by one or more queue configuration(s).","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.prompt.has.resources":"Cannot delete prompt since it contains prompt resources."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompt"}},"/api/v2/architect/prompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectPromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptHistoryHistoryId"}},"/api/v2/architect/prompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate prompt history","description":"Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"postArchitectPromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"postArchitectPromptHistory"}},"/api/v2/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getArchitectPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unspecified error has occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postArchitectPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists.","architect.user.prompt.create.failed":"Failed to create user prompt.","architect.user.prompt.exceeded.max.amount":"Failed to create user prompt since maximum amount of user prompts has been reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:add"]},"x-purecloud-method-name":"postArchitectPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"deleteArchitectPrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one prompt could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompts"}},"/api/v2/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroup"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the schedule group were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:edit"]},"x-purecloud-method-name":"putArchitectSchedulegroup"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule group could not be completed because it is assigned to one or more IVRs or Sites."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:delete"]},"x-purecloud-method-name":"deleteArchitectSchedulegroup"}},"/api/v2/architect/schedulegroups/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic schedule group configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectSchedulegroupsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the schedule group to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the schedule group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:search"]},"x-purecloud-method-name":"getArchitectSchedulegroupsDivisionviews"}},"/api/v2/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getArchitectSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule Group to filter by.","required":false,"type":"string"},{"name":"scheduleIds","in":"query","description":"A comma-delimited list of Schedule IDs to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postArchitectSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","access.denied.to.field":"You are not authorized to view one or more of the referenced entities."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:scheduleGroup:add"]},"x-purecloud-method-name":"postArchitectSchedulegroups"}},"/api/v2/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleId was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedule"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"2 or more modifications of the schedule were made at the same time."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:edit"]},"x-purecloud-method-name":"putArchitectSchedule"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested schedule could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule could not be completed because it is assigned to one or more schedule groups."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:delete"]},"x-purecloud-method-name":"deleteArchitectSchedule"}},"/api/v2/architect/schedules/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic schedule configuration information objects filterable by query parameters.","description":"","operationId":"getArchitectSchedulesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"id","in":"query","description":"ID of the schedule group to filter by.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name of the schedule group to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:search"]},"x-purecloud-method-name":"getArchitectSchedulesDivisionviews"}},"/api/v2/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getArchitectSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule to filter by.","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"List of divisionIds on which to filter.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postArchitectSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"You are not authorized to perform the requested action.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:schedule:add"]},"x-purecloud-method-name":"postArchitectSchedules"}},"/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.not.found":"Could not find resource with specified language in specified system prompt.","architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResource"},"put":{"tags":["Architect"],"summary":"Updates a system prompt resource override.","description":"","operationId":"putArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.override.not.found":"Could not find resource override with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"putArchitectSystempromptResource"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.cannot.delete.default":"Cannot delete the default resource for the specified language as that would leave that language without a default resource."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectSystempromptResource"}},"/api/v2/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get system prompt resources.","description":"","operationId":"getArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","architect.system.prompt.resource.lang.missing":"A language was not specified in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.system.prompt.resource.cannot.create.non.default":"Cannot create a non-default resource for the specified language because a default resource for that language doesn't exist. A default must be created first.","architect.system.prompt.resource.override.already.exists":"The specified system prompt already has an override for the specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"postArchitectSystempromptResources"}},"/api/v2/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get a system prompt","description":"","operationId":"getArchitectSystemprompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompt"}},"/api/v2/architect/systemprompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate system prompt history","description":"Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}","operationId":"postArchitectSystempromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"postArchitectSystempromptHistory"}},"/api/v2/architect/systemprompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectSystempromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptHistoryHistoryId"}},"/api/v2/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts","description":"","operationId":"getArchitectSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"includeMediaUris","in":"query","description":"Include the media URIs for each resource","required":false,"type":"boolean","default":true},{"name":"includeResources","in":"query","description":"Include the resources for each system prompt","required":false,"type":"boolean","default":true},{"name":"language","in":"query","description":"Filter the resources down to the provided languages","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"206":{"description":"Partial Content - some of the information in the resources may be missing","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompts.max.page.size.exceeded":"A page size greater than the maximum (250) has been requested.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompts"}},"/api/v2/architect/dependencytracking/updatedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that depend on updated resources","description":"","operationId":"getArchitectDependencytrackingUpdatedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingUpdatedresourceconsumers"}},"/api/v2/webchat/deployments/{deploymentId}":{"get":{"tags":["WebChat"],"summary":"Get a WebChat deployment","description":"","operationId":"getWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployment"},"put":{"tags":["WebChat"],"summary":"Update a WebChat deployment","description":"","operationId":"putWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatDeployment"},"delete":{"tags":["WebChat"],"summary":"Delete a WebChat deployment","description":"","operationId":"deleteWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatDeployment"}},"/api/v2/webchat/deployments":{"get":{"tags":["WebChat"],"summary":"List WebChat deployments","description":"","operationId":"getWebchatDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployments"},"post":{"tags":["WebChat"],"summary":"Create WebChat deployment","description":"","operationId":"postWebchatDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Too many deployments being handled","maximum.deployments.exceeded":"No more than 25 deployments allowed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:create"]},"x-purecloud-method-name":"postWebchatDeployments"}},"/api/v2/webchat/settings":{"get":{"tags":["WebChat"],"summary":"Get WebChat deployment settings","description":"","operationId":"getWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatSettings"},"put":{"tags":["WebChat"],"summary":"Update WebChat deployment settings","description":"","operationId":"putWebchatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webChatSettings","required":true,"schema":{"$ref":"#/definitions/WebChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatSettings"},"delete":{"tags":["WebChat"],"summary":"Remove WebChat deployment settings","description":"","operationId":"deleteWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatSettings"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}":{"get":{"tags":["WebChat"],"summary":"Get a media request in the conversation","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"getWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"deprecated":true,"x-purecloud-method-name":"getWebchatGuestConversationMediarequest"},"patch":{"tags":["WebChat"],"summary":"Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED","description":"This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/","operationId":"patchWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"},{"in":"body","name":"body","description":"Request","required":true,"schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"deprecated":true,"x-purecloud-method-name":"patchWebchatGuestConversationMediarequest"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests":{"get":{"tags":["WebChat"],"summary":"Get all media requests to the guest in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequests","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequestEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequests"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation member","description":"","operationId":"getWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation member was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMember"},"delete":{"tags":["WebChat"],"summary":"Remove a member from a chat conversation","description":"","operationId":"deleteWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","chat.error.member.state":"The conversation member is in a state which does not permit this action."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"deleteWebchatGuestConversationMember"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages":{"post":{"tags":["WebChat"],"summary":"Send a message in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"The request body may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Error occurred due to invalid request.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation messages operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberMessages"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing":{"post":{"tags":["WebChat"],"summary":"Send a typing-indicator in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","chat.error.member.state":"The conversation member is in a state which does not permit this action.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.internal":"Internal chat error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation typing operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberTyping"}},"/api/v2/webchat/guest/conversations/{conversationId}/members":{"get":{"tags":["WebChat"],"summary":"Get the members of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMembers","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The number of entries to return per page, or omitted for the default.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number to return, or omitted for the first page.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeDisconnectedMembers","in":"query","description":"If true, the results will not contain members who have a DISCONNECTED state.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfoEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMembers"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation message","description":"","operationId":"getWebchatGuestConversationMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation message was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessage"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages":{"get":{"tags":["WebChat"],"summary":"Get the messages of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If available, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If available, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessages"}},"/api/v2/webdeployments/configurations/{configurationId}":{"delete":{"tags":["Web Deployments"],"summary":"Delete all versions of a configuration","description":"","operationId":"deleteWebdeploymentsConfiguration","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"204":{"description":"The configuration versions were deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","illegal.operation":"Unable to perform the requested operation"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.conflict":"Resource is used by another"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:delete"]},"x-purecloud-method-name":"deleteWebdeploymentsConfiguration"}},"/api/v2/webdeployments/configurations":{"get":{"tags":["Web Deployments"],"summary":"View configuration drafts","description":"","operationId":"getWebdeploymentsConfigurations","produces":["application/json"],"parameters":[{"name":"showOnlyPublished","in":"query","description":"Get only configuration drafts with published versions","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurations"},"post":{"tags":["Web Deployments"],"summary":"Create a configuration draft","description":"","operationId":"postWebdeploymentsConfigurations","produces":["application/json"],"parameters":[{"in":"body","name":"configurationVersion","required":true,"schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"201":{"description":"The configuration version draft was created successfully","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","resource.limit.exceeded":"The maximum number of resources has been exceeded","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:add"]},"x-purecloud-method-name":"postWebdeploymentsConfigurations"}},"/api/v2/webdeployments/configurations/{configurationId}/versions":{"get":{"tags":["Web Deployments"],"summary":"Get the versions of a configuration","description":"This returns the 50 most recent versions for this configuration","operationId":"getWebdeploymentsConfigurationVersions","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersions"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}":{"get":{"tags":["Web Deployments"],"summary":"Get a configuration version","description":"","operationId":"getWebdeploymentsConfigurationVersion","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"The version of the configuration to get","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersion"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/draft":{"get":{"tags":["Web Deployments"],"summary":"Get the configuration draft","description":"","operationId":"getWebdeploymentsConfigurationVersionsDraft","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:view"]},"x-purecloud-method-name":"getWebdeploymentsConfigurationVersionsDraft"},"put":{"tags":["Web Deployments"],"summary":"Update the configuration draft","description":"","operationId":"putWebdeploymentsConfigurationVersionsDraft","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"},{"in":"body","name":"configurationVersion","required":true,"schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:edit"]},"x-purecloud-method-name":"putWebdeploymentsConfigurationVersionsDraft"}},"/api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish":{"post":{"tags":["Web Deployments"],"summary":"Publish the configuration draft and create a new version","description":"","operationId":"postWebdeploymentsConfigurationVersionsDraftPublish","produces":["application/json"],"parameters":[{"name":"configurationId","in":"path","description":"The configuration version ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:configuration:edit","webDeployments:configuration:add"]},"x-purecloud-method-name":"postWebdeploymentsConfigurationVersionsDraftPublish"}},"/api/v2/webdeployments/deployments/{deploymentId}":{"get":{"tags":["Web Deployments"],"summary":"Get a deployment","description":"","operationId":"getWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected. ","required":false,"type":"array","items":{"type":"string","enum":["supportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:view"]},"x-purecloud-method-name":"getWebdeploymentsDeployment"},"put":{"tags":["Web Deployments"],"summary":"Update a deployment","description":"","operationId":"putWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"in":"body","name":"deployment","required":true,"schema":{"$ref":"#/definitions/WebDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","bad.flow.id":"The flow is not eligible for use here.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scp.id.not.found":"The Supported Content Profile ID is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:edit"]},"x-purecloud-method-name":"putWebdeploymentsDeployment"},"delete":{"tags":["Web Deployments"],"summary":"Delete a deployment","description":"","operationId":"deleteWebdeploymentsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"}],"responses":{"204":{"description":"The deployment was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","illegal.operation":"Unable to perform the requested operation"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:delete"]},"x-purecloud-method-name":"deleteWebdeploymentsDeployment"}},"/api/v2/webdeployments/deployments/{deploymentId}/configurations":{"get":{"tags":["Web Deployments"],"summary":"Get active configuration for a given deployment","description":"","operationId":"getWebdeploymentsDeploymentConfigurations","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The deployment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Get active configuration on a deployment","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value","required":false,"type":"array","items":{"type":"string","enum":["supportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeploymentActiveConfigurationOnDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-purecloud-method-name":"getWebdeploymentsDeploymentConfigurations"}},"/api/v2/webdeployments/token/revoke":{"delete":{"tags":["Web Deployments"],"summary":"Invalidate JWT","description":"","operationId":"deleteWebdeploymentsTokenRevoke","produces":["application/json"],"parameters":[{"name":"X-Journey-Session-Id","in":"header","description":"The Customer's journey sessionId.","required":false,"type":"string"},{"name":"X-Journey-Session-Type","in":"header","description":"The Customer's journey session type.","required":false,"type":"string"}],"responses":{"204":{"description":"Revoke any tokens associate with the JWT. \nIf the JWT is expired the refresh endpoint should be called to obtain a valid JWT and this endpoint called again."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The credentials have expired.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","parameters.missing":"The parameters were missing."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Webmessaging JWT":[]}],"x-purecloud-method-name":"deleteWebdeploymentsTokenRevoke"}},"/api/v2/webdeployments/deployments":{"get":{"tags":["Web Deployments"],"summary":"Get deployments","description":"","operationId":"getWebdeploymentsDeployments","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["Configuration","SupportedContent"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExpandableWebDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments","webdeployments:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:view"]},"x-purecloud-method-name":"getWebdeploymentsDeployments"},"post":{"tags":["Web Deployments"],"summary":"Create a deployment","description":"","operationId":"postWebdeploymentsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"deployment","required":true,"schema":{"$ref":"#/definitions/WebDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebDeployment"}},"201":{"description":"The deployment was created successfully","schema":{"$ref":"#/definitions/WebDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","resource.limit.exceeded":"The maximum number of resources has been exceeded","invalid.property":"Value [%s] is not a valid property for object [%s]","illegal.operation":"Unable to perform the requested operation","bad.flow.id":"The flow is not eligible for use here.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scp.id.not.found":"The Supported Content Profile ID is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["webdeployments"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["webDeployments:deployment:add"]},"x-purecloud-method-name":"postWebdeploymentsDeployments"}},"/api/v2/webmessaging/messages":{"get":{"tags":["WebMessaging"],"summary":"Get the messages for a web messaging session.","description":"","operationId":"getWebmessagingMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebMessagingMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","parameters.missing":"Parameters are missing","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"session.expired":"The session has expired.","session.not.found":"Session was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Webmessaging JWT":[]}],"x-purecloud-method-name":"getWebmessagingMessages"}},"/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an annotation.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).","operationId":"getCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"200":{"description":"Annotation retrieved","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotation"},"delete":{"tags":["Coaching"],"summary":"Delete an existing annotation","description":"You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment","operationId":"deleteCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"204":{"description":"Annotation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation delete permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:delete","coaching:privateAnnotation:delete"]},"x-purecloud-method-name":"deleteCoachingAppointmentAnnotation"},"patch":{"tags":["Coaching"],"summary":"Update an existing annotation.","description":"You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the annotation","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation edit permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:edit","coaching:privateAnnotation:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentAnnotation"}},"/api/v2/coaching/appointments/{appointmentId}/annotations":{"get":{"tags":["Coaching"],"summary":"Get a list of annotations.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).","operationId":"getCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Annotations retrieved","schema":{"$ref":"#/definitions/CoachingAnnotationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotations"},"post":{"tags":["Coaching"],"summary":"Create a new annotation.","description":"You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).","operationId":"postCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The annotation to add","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotationCreateRequest"}}],"responses":{"201":{"description":"Annotation created","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation add permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:add","coaching:privateAnnotation:add"]},"x-purecloud-method-name":"postCoachingAppointmentAnnotations"}},"/api/v2/coaching/appointments/{appointmentId}/conversations":{"post":{"tags":["Coaching"],"summary":"Add a conversation to an appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"postCoachingAppointmentConversations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddConversationRequest"}}],"responses":{"200":{"description":"Conversation Added","schema":{"$ref":"#/definitions/AddConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the permissions and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit","coaching:appointmentConversation:add"]},"x-purecloud-method-name":"postCoachingAppointmentConversations"}},"/api/v2/coaching/appointments/{appointmentId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an appointment","description":"Permission not required if you are the attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"200":{"description":"Retrieved appointment","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointment"},"delete":{"tags":["Coaching"],"summary":"Delete an existing appointment","description":"Permission not required if you are the creator of the appointment","operationId":"deleteCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"202":{"description":"Appointment delete request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"204":{"description":"Appointment deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User missing permissions: Not an appointment participant.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment delete permission and is not a creator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"There was a conflict deleting the appointment."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:delete"]},"x-purecloud-method-name":"deleteCoachingAppointment"},"patch":{"tags":["Coaching"],"summary":"Update an existing appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the appointment","required":true,"schema":{"$ref":"#/definitions/UpdateCoachingAppointmentRequest"}}],"responses":{"200":{"description":"Appointment updated","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment update request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","not.wfm.appointment":"Appointment was created without WFM schedule data; schedule cannot be added.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment edit permission and is not a creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another","appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit"]},"x-purecloud-method-name":"patchCoachingAppointment"}},"/api/v2/coaching/appointments/{appointmentId}/statuses":{"get":{"tags":["Coaching"],"summary":"Get the list of status changes for a coaching appointment.","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointmentStatuses","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Retrieved appointment statuses","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User does not have the appointment status: is not a participant","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status view permission and is not an attendee, creator or facilitator of the appointment","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:view"]},"x-purecloud-method-name":"getCoachingAppointmentStatuses"}},"/api/v2/coaching/appointments/{appointmentId}/status":{"patch":{"tags":["Coaching"],"summary":"Update the status of a coaching appointment","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"patchCoachingAppointmentStatus","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated status of the coaching appointment","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentStatusRequest"}}],"responses":{"200":{"description":"The status is posted successfully","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"Failed to validate the appointment status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions.not.appointment.participant":"User is not an appointment participant.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status edit permission and is not an attendee, creator or facilitator of the appointment","agent.cannot.change.status":"Agent cannot change the status of a facilitated appointment.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentStatus"}},"/api/v2/coaching/appointments/aggregates/query":{"post":{"tags":["Coaching"],"summary":"Retrieve aggregated appointment data","description":"","operationId":"postCoachingAppointmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentAggregateRequest"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/CoachingAppointmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"aggregate.too.many.users":"Too many users were included in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","aggregate.query.filter.missing.or.invalid":"The query must contain a filter with at least one clause and predicate","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"There was a problem with the request, see the message for details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"postCoachingAppointmentsAggregatesQuery"}},"/api/v2/coaching/appointments":{"get":{"tags":["Coaching"],"summary":"Get appointments for users and optional date range","description":"","operationId":"getCoachingAppointments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The user IDs for which to retrieve appointments","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"},{"name":"completionInterval","in":"query","description":"Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"]},{"name":"intervalCondition","in":"query","description":"Filter condition for interval","required":false,"type":"string","enum":["StartsIn","Overlaps"]}],"responses":{"200":{"description":"Get users coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"interval.query.param":"Start date of the interval cannot be greater than the end date","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","users.query.param":"User list cannot be empty or greater than 100 when querying for appointments","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","no.appointment.view.permission":"No permission to view appointments","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointments"},"post":{"tags":["Coaching"],"summary":"Create a new appointment","description":"","operationId":"postCoachingAppointments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The appointment to add","required":true,"schema":{"$ref":"#/definitions/CreateCoachingAppointmentRequest"}}],"responses":{"201":{"description":"Appointment created","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment create request accepted","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","validation.error":"Error validating the appointment.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:add"]},"x-purecloud-method-name":"postCoachingAppointments"}},"/api/v2/coaching/notifications/{notificationId}":{"get":{"tags":["Coaching"],"summary":"Get an existing notification","description":"Permission not required if you are the owner of the notification.","operationId":"getCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:notification:view"]},"x-purecloud-method-name":"getCoachingNotification"},"patch":{"tags":["Coaching"],"summary":"Update an existing notification.","description":"Can only update your own notifications.","operationId":"patchCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"in":"body","name":"body","description":"Change the read state of a notification","required":true,"schema":{"$ref":"#/definitions/CoachingNotification"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"The requested notification does not belong to this user.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-purecloud-method-name":"patchCoachingNotification"}},"/api/v2/coaching/notifications":{"get":{"tags":["Coaching"],"summary":"Retrieve the list of your notifications.","description":"","operationId":"getCoachingNotifications","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotificationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","pagination.bad.request":"The page size or page number could not be parsed."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingNotifications"}},"/api/v2/coaching/scheduleslots/query":{"post":{"tags":["Coaching"],"summary":"Get list of possible slots where a coaching appointment can be scheduled.","description":"","operationId":"postCoachingScheduleslotsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The slot search request","required":true,"schema":{"$ref":"#/definitions/CoachingSlotsRequest"}}],"responses":{"200":{"description":"Coaching slots retrieved","schema":{"$ref":"#/definitions/CoachingSlotsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","attendee.not.in.business.unit":"The attendee to be scheduled was not in a business unit, but a WFM schedule was provided","invalid.property":"Value [%s] is not a valid property for object [%s]","users.in.different.business.units":"Users to be scheduled were in different business units","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:scheduleSlot:view"]},"x-purecloud-method-name":"postCoachingScheduleslotsQuery"}},"/api/v2/coaching/appointments/me":{"get":{"tags":["Coaching"],"summary":"Get my appointments for a given date range","description":"","operationId":"getCoachingAppointmentsMe","produces":["application/json"],"parameters":[{"name":"interval","in":"query","description":"Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"},{"name":"completionInterval","in":"query","description":"Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"]},{"name":"intervalCondition","in":"query","description":"Filter condition for interval","required":false,"type":"string","enum":["StartsIn","Overlaps"]}],"responses":{"200":{"description":"Get my coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingAppointmentsMe"}},"/api/v2/users/development/activities/{activityId}":{"get":{"tags":["Users"],"summary":"Get a Development Activity","description":"Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.","operationId":"getUsersDevelopmentActivity","produces":["application/json"],"parameters":[{"name":"activityId","in":"path","description":"Specifies the activity ID, maps to either assignment or appointment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Specifies the activity type.","required":true,"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivity"}},"/api/v2/users/development/activities":{"get":{"tags":["Users"],"summary":"Get list of Development Activities","description":"Either moduleId or userId is required. Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivities","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment"]},"collectionFormat":"multi"},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"collectionFormat":"multi"},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivities"}},"/api/v2/users/development/activities/me":{"get":{"tags":["Users"],"summary":"Get list of Development Activities for current user","description":"Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivitiesMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment"]},"collectionFormat":"multi"},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"collectionFormat":"multi"},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-purecloud-method-name":"getUsersDevelopmentActivitiesMe"}},"/api/v2/users/development/activities/aggregates/query":{"post":{"tags":["Users"],"summary":"Retrieve aggregated development activity data","description":"Results are filtered based on the applicable permissions.","operationId":"postUsersDevelopmentActivitiesAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/DevelopmentActivityAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/DevelopmentActivityAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval parameter cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","development.aggregate.no.permission":"Invalid User Operation. User does not have permission to get development data","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.type.not.implemented.exception":"Predicate is not implemented"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"postUsersDevelopmentActivitiesAggregatesQuery"}},"/api/v2/learning/assessments/scoring":{"post":{"tags":["Learning"],"summary":"Score learning assessment for preview","description":"","operationId":"postLearningAssessmentsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Assessment form and answers to score","required":true,"schema":{"$ref":"#/definitions/LearningAssessmentScoringRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssessmentScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.answer.not.in.assessment.form":"Submitted answers contained reference to an answer which is not in the assessment form","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.text.answer.too.long":"Submitted answers contained a free text answer that was too long.","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.answer.not.provided":"A submitted answer was empty","quality.scoring.na.disabled.marked.na":"A question or question group was marked as NA when it is not NA enabled.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.scoring.question.not.in.assessment.form":"Submitted answers contained reference to a question which is not in the assessment form","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Request is badly formed.","quality.scoring.question.group.not.in.assessment.form":"Submitted answers contained reference to a question group which is not in the assessment form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view","learning:module:add","learning:module:edit"]},"x-purecloud-method-name":"postLearningAssessmentsScoring"}},"/api/v2/learning/assignments/aggregates/query":{"post":{"tags":["Learning"],"summary":"Retrieve aggregated assignment data","description":"","operationId":"postLearningAssignmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/LearningAssignmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval parameter cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.type.not.implemented.exception":"Predicate is not implemented"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"postLearningAssignmentsAggregatesQuery"}},"/api/v2/learning/assignments/{assignmentId}":{"get":{"tags":["Learning"],"summary":"Get Learning Assignment","description":"Permission not required if you are the assigned user of the learning assignment","operationId":"getLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response","required":false,"type":"array","items":{"type":"string","enum":["module","assessment","assessmentForm","module.coverArt","step","step.moduleStep"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","wem.learning.assignment.division.forbidden.action":"The operation failed as the action is forbidden","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","wem.learning.assignment.forbidden":"The operation failed as the action is forbidden","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"getLearningAssignment"},"delete":{"tags":["Learning"],"summary":"Delete a learning assignment","description":"","operationId":"deleteLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"204":{"description":"The learning assignment was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","lm.no.permission.delete.assignment":"The operation failed because the user does not have the right permissions","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.conflict.exception":"The assignment was assigned by a rule and cannot be deleted.","wem.learning.assignment.state.conflict.exception":"The assignment is in a state where it cannot be deleted."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:delete"]},"x-purecloud-method-name":"deleteLearningAssignment"},"patch":{"tags":["Learning"],"summary":"Update Learning Assignment","description":"","operationId":"patchLearningAssignment","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"in":"body","name":"body","description":"The Learning Assignment to be updated","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.answer.not.in.assessment.form":"Submitted answers contained reference to an answer which is not in the assessment form","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.text.answer.too.long":"Submitted answers contained a free text answer that was too long.","invalid.property":"Value [%s] is not a valid property for object [%s]","quality.scoring.answer.not.provided":"A submitted answer was empty","quality.scoring.na.disabled.marked.na":"A question or question group was marked as NA when it is not NA enabled.","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","quality.scoring.question.not.in.assessment.form":"Submitted answers contained reference to a question which is not in the assessment form","constraint.validation":"%s","wem.learning.input.validation.error":"There was an error parsing argument","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","quality.scoring.question.group.not.in.assessment.form":"Submitted answers contained reference to a question group which is not in the assessment form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","lm.update.state.error":"Cannot update an assignment belonging to another user.","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"The operation failed as the state to be updated conflicts","wem.learning.module.type.exception":"The operation failed as it conflicts with the module type"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-purecloud-method-name":"patchLearningAssignment"}},"/api/v2/learning/assignments":{"get":{"tags":["Learning"],"summary":"List of Learning module Assignments","description":"Either moduleId or user value is required","operationId":"getLearningAssignments","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module. Fetch assignments for learning module ID","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"minPercentageScore","in":"query","description":"The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"maxPercentageScore","in":"query","description":"The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"sortBy","in":"query","description":"Specifies which field to sort the results by, default sort is by recommendedCompletionDate","required":false,"type":"string","enum":["RecommendedCompletionDate","DateModified"]},{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"types","in":"query","description":"Specifies the module types to filter by","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"states","in":"query","description":"Specifies the assignment states to filter by","required":false,"type":"array","items":{"type":"string","enum":["Assigned","InProgress","Completed","NotCompleted","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Specifies the expand option for returning additional information","required":false,"type":"array","items":{"type":"string","enum":["ModuleSummary"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentsDomainEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","lm.no.permission.view.assignment":"The operation failed because the user does not have the right permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view"]},"x-purecloud-method-name":"getLearningAssignments"},"post":{"tags":["Learning"],"summary":"Create Learning Assignment","description":"","operationId":"postLearningAssignments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Learning Assignment to be created","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","lm.no.permission.create.assignment":"The operation failed because the user does not have the right permissions"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.conflict.exception":"The operation failed as the assignment conflicts with the existing assignment","wem.learning.assignment.state.conflict.exception":"A rule-based assignment already exists in a state that prevents this action.","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignments"}},"/api/v2/learning/assignments/{assignmentId}/reschedule":{"patch":{"tags":["Learning"],"summary":"Reschedule Learning Assignment","description":"","operationId":"patchLearningAssignmentReschedule","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"in":"body","name":"body","description":"The Learning assignment reschedule model","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentReschedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","lm.reschedule.state.error":"Cannot reschedule an assignment belonging to another user.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"The assignment is in a state where it cannot be rescheduled.","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:reschedule"]},"x-purecloud-method-name":"patchLearningAssignmentReschedule"}},"/api/v2/learning/assignments/me":{"get":{"tags":["Learning"],"summary":"List of Learning Assignments assigned to current user","description":"","operationId":"getLearningAssignmentsMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module. Fetch assignments for learning module ID","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pass","in":"query","description":"Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"minPercentageScore","in":"query","description":"The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"maxPercentageScore","in":"query","description":"The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)","required":false,"type":"number","format":"float"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"]},{"name":"sortBy","in":"query","description":"Specifies which field to sort the results by, default sort is by recommendedCompletionDate","required":false,"type":"string","enum":["RecommendedCompletionDate","DateModified"]},{"name":"types","in":"query","description":"Specifies the module types to filter by","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"states","in":"query","description":"Specifies the assignment states to filter by","required":false,"type":"array","items":{"type":"string","enum":["Assigned","InProgress","Completed","NotCompleted","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Specifies the expand option for returning additional information","required":false,"type":"array","items":{"type":"string","enum":["ModuleSummary"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentsDomainEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","date.interval.param.too.big":"The range of the interval and completionInterval parameters cannot be more than 1 year","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-purecloud-method-name":"getLearningAssignmentsMe"}},"/api/v2/learning/assignments/{assignmentId}/reset":{"post":{"tags":["Learning"],"summary":"Reset Learning Assignment","description":"This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment","operationId":"postLearningAssignmentReset","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"200":{"description":"Reset version of assignment which can be taken again","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"lm.no.permission.reset.assignment":"The operation failed because the user does not have the right permissions","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:reset"]},"x-purecloud-method-name":"postLearningAssignmentReset"}},"/api/v2/learning/assignments/{assignmentId}/reassign":{"post":{"tags":["Learning"],"summary":"Reassign Learning Assignment","description":"This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module","operationId":"postLearningAssignmentReassign","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The Learning Assignment ID","required":true,"type":"string"}],"responses":{"200":{"description":"Reassigned version of assignment which can be taken again","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.assignment.schedule.conflict.exception":"There is a schedule conflict when performing this action.","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignmentReassign"}},"/api/v2/learning/assignments/bulkadd":{"post":{"tags":["Learning"],"summary":"Add multiple learning assignments","description":"","operationId":"postLearningAssignmentsBulkadd","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The learning assignments to be created","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/LearningAssignmentItem"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentBulkAddResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"None of the provided learning modules were found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:add"]},"x-purecloud-method-name":"postLearningAssignmentsBulkadd"}},"/api/v2/learning/assignments/bulkremove":{"post":{"tags":["Learning"],"summary":"Remove multiple Learning Assignments","description":"","operationId":"postLearningAssignmentsBulkremove","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The IDs of the learning assignments to be removed","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentBulkRemoveResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:delete"]},"x-purecloud-method-name":"postLearningAssignmentsBulkremove"}},"/api/v2/learning/assignments/{assignmentId}/steps/{stepId}":{"get":{"tags":["Learning"],"summary":"Get Learning Assignment Step","description":"Permission not required if you are the assigned user of the learning assignment","operationId":"getLearningAssignmentStep","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"name":"stepId","in":"path","description":"The ID of Learning Assignment Step","required":true,"type":"string"},{"name":"shareableContentObjectId","in":"query","description":"The ID of SCO to load","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response","required":false,"type":"array","items":{"type":"string","enum":["moduleStep"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentStep"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","wem.learning.assignment.forbidden":"The operation failed as the action is forbidden","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:viewOwn"]},"x-purecloud-method-name":"getLearningAssignmentStep"},"patch":{"tags":["Learning"],"summary":"Update Learning Assignment Step","description":"Permission not required if you are the assigned user of the learning assignment","operationId":"patchLearningAssignmentStep","produces":["application/json"],"parameters":[{"name":"assignmentId","in":"path","description":"The ID of Learning Assignment","required":true,"type":"string"},{"name":"stepId","in":"path","description":"The ID of Learning Assignment Step","required":true,"type":"string"},{"in":"body","name":"body","description":"The Learning Assignment Step to be updated","required":false,"schema":{"$ref":"#/definitions/LearningAssignmentStep"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentStep"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:editOwn"]},"x-purecloud-method-name":"patchLearningAssignmentStep"}},"/api/v2/learning/rules/query":{"post":{"tags":["Learning"],"summary":"Get users for learning module rule","description":"This will get the users who matches the given rule.","operationId":"postLearningRulesQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":true,"type":"integer","default":50,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":true,"type":"integer","default":1,"format":"int32"},{"in":"body","name":"body","description":"The learning module rule to fetch users","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentUserQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignmentUserListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when retrieving users","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.rule.part.exceeded":"There are too many values in rule parts","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:view"]},"x-purecloud-method-name":"postLearningRulesQuery"}},"/api/v2/learning/modules/{moduleId}":{"get":{"tags":["Learning"],"summary":"Get a learning module","description":"","operationId":"getLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["assessmentForm","coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModule"},"put":{"tags":["Learning"],"summary":"Update a learning module","description":"This will update the name, description, completion time in days and inform steps for a learning module","operationId":"putLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module to be updated","required":true,"schema":{"$ref":"#/definitions/LearningModuleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error in the input argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when updating learning module","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot update Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:edit"]},"x-purecloud-method-name":"putLearningModule"},"delete":{"tags":["Learning"],"summary":"Delete a learning module","description":"This will delete a learning module if it is unpublished or it will delete a published and archived learning module","operationId":"deleteLearningModule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"}],"responses":{"204":{"description":"The learning module was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","wem.learning.server.too.busy":"The operation failed because the service is too busy","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wem.learning.forbidden.action":"The operation failed since the action is forbidden"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"TThe operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:delete"]},"x-purecloud-method-name":"deleteLearningModule"}},"/api/v2/learning/modules/{moduleId}/preview":{"get":{"tags":["Learning"],"summary":"Get a learning module preview","description":"","operationId":"getLearningModulePreview","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulePreviewGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:preview"]},"x-purecloud-method-name":"getLearningModulePreview"},"put":{"tags":["Learning"],"summary":"Update a learning module preview","description":"This will update a learning module preview","operationId":"putLearningModulePreview","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module to be updated","required":true,"schema":{"$ref":"#/definitions/LearningModulePreviewUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulePreviewUpdateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error in the input argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when updating learning module","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot update Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:preview"]},"x-purecloud-method-name":"putLearningModulePreview"}},"/api/v2/learning/modules/{moduleId}/jobs/{jobId}":{"get":{"tags":["Learning"],"summary":"Get a specific Learning Module job status","description":"","operationId":"getLearningModuleJob","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the learning module job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.bad.request":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.job.not.found":"The operation failed because the specified learning job is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModuleJob"}},"/api/v2/learning/modules/{moduleId}/versions/{versionId}":{"get":{"tags":["Learning"],"summary":"Get specific version of a published module","description":"","operationId":"getLearningModuleVersion","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"name":"versionId","in":"path","description":"The version of learning module","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["assessmentForm","coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModuleVersion"}},"/api/v2/learning/modules/coverart/{coverArtId}":{"get":{"tags":["Learning"],"summary":"Get a specific Learning Module cover art using ID","description":"","operationId":"getLearningModulesCoverartCoverArtId","produces":["application/json"],"parameters":[{"name":"coverArtId","in":"path","description":"Key identifier for the cover art","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleCoverArtResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.cover.art.not.found":"The operation failed because the specified learning module cover art is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:coverart:view"]},"x-purecloud-method-name":"getLearningModulesCoverartCoverArtId"}},"/api/v2/learning/modules":{"get":{"tags":["Learning"],"summary":"Get all learning modules of an organization","description":"","operationId":"getLearningModules","produces":["application/json"],"parameters":[{"name":"isArchived","in":"query","description":"Archive status","required":false,"type":"boolean","default":false},{"name":"types","in":"query","description":"Specifies the module types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External"]},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","createddate","percentpassed","averagescore"]},{"name":"searchTerm","in":"query","description":"Search Term (searchable by name)","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["rule","summaryData"]},"collectionFormat":"multi"},{"name":"isPublished","in":"query","description":"Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"statuses","in":"query","description":"Specifies the module statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Unpublished","Published","Archived"]},"collectionFormat":"multi"},{"name":"externalIds","in":"query","description":"Specifies the module external IDs to filter by. Only one ID is allowed","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:view"]},"x-purecloud-method-name":"getLearningModules"},"post":{"tags":["Learning"],"summary":"Create a new learning module","description":"This will create a new unpublished learning module with the specified fields.","operationId":"postLearningModules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The learning module to be created","required":true,"schema":{"$ref":"#/definitions/LearningModuleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.too.many.modules":"The max number of modules per organization has been reached","wem.learning.private.api.http.exception":"There was an error when creating learning module","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot create Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:add"]},"x-purecloud-method-name":"postLearningModules"}},"/api/v2/learning/modules/{moduleId}/publish":{"post":{"tags":["Learning"],"summary":"Publish a Learning module","description":"","operationId":"postLearningModulePublish","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":false,"schema":{"$ref":"#/definitions/LearningModulePublishRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModulePublishResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","wem.learning.input.validation.error":"There was an error parsing argument","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wem.learning.private.api.http.exception":"There was an error when publishing learning module","wem.learning.informsteps.empty.error":"Cannot publish Learning Module as no inform steps provided","wem.learning.bad.request":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.informsteps.access.denied":"Cannot publish Learning Module as the user has no access to inform steps","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wem.learning.builtin.forbidden.action":"The operation failed for built in courses since the action is forbidden","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:publish"]},"x-purecloud-method-name":"postLearningModulePublish"}},"/api/v2/learning/modules/{moduleId}/jobs":{"post":{"tags":["Learning"],"summary":"Starts a specified operation on learning module","description":"This will initiate operation specified in the request body for a learning module","operationId":"postLearningModuleJobs","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module job request","required":true,"schema":{"$ref":"#/definitions/LearningModuleJobRequest"}}],"responses":{"202":{"description":"Start a specific Learning Module job","schema":{"$ref":"#/definitions/LearningModuleJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wem.learning.bad.request":"There was an error parsing argument","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since learning module not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.job.already.exists":"The operation failed since a job already exists for the module","wem.learning.module.type.exception":"The operation failed as it conflicts with the module type","wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:module:add"]},"x-purecloud-method-name":"postLearningModuleJobs"}},"/api/v2/learning/modules/assignments":{"get":{"tags":["Learning"],"summary":"Get all learning modules of an organization including assignments for a specific user","description":"","operationId":"getLearningModulesAssignments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The IDs of the users to include","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"searchTerm","in":"query","description":"Search Term (searches by name and description)","required":false,"type":"string"},{"name":"overdue","in":"query","description":"Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned.","required":false,"type":"string","default":"Any","enum":["True","False","Any"]},{"name":"assignmentStates","in":"query","description":"Specifies the assignment states to return.","required":false,"type":"array","items":{"type":"string","enum":["NotAssigned","Assigned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"Fields to expand in response(case insensitive)","required":false,"type":"array","items":{"type":"string","enum":["coverArt"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedLearningModuleDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","no.user.ids.specified":"You must specify at least one userId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:module:view","learning:assignment:view"]},"x-purecloud-method-name":"getLearningModulesAssignments"}},"/api/v2/learning/modules/{moduleId}/users/{userId}/assignments":{"patch":{"tags":["Learning"],"summary":"Update an external assignment for a specific user","description":"","operationId":"patchLearningModuleUserAssignments","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"Key identifier for the module","required":true,"type":"string"},{"name":"userId","in":"path","description":"Key identifier for the user","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning request for updating the assignment","required":true,"schema":{"$ref":"#/definitions/LearningAssignmentExternalUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningAssignment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.not.found":"The operation failed as the learning assignment is not found","not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed as the learning module is not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.state.conflict.exception":"A rule-based assignment already exists in a state that prevents this action.","wem.learning.module.type.exception":"Cannot perform update on assignment with module of type External"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["learning:externalAssignment:edit"]},"x-purecloud-method-name":"patchLearningModuleUserAssignments"}},"/api/v2/learning/modules/{moduleId}/rule":{"get":{"tags":["Learning"],"summary":"Get a learning module rule","description":"","operationId":"getLearningModuleRule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since corresponding learning module was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:view"]},"x-purecloud-method-name":"getLearningModuleRule"},"put":{"tags":["Learning"],"summary":"Update a learning module rule","description":"This will update a learning module rule with the specified fields.","operationId":"putLearningModuleRule","produces":["application/json"],"parameters":[{"name":"moduleId","in":"path","description":"The ID of the learning module","required":true,"type":"string"},{"in":"body","name":"body","description":"The learning module rule to be updated","required":true,"schema":{"$ref":"#/definitions/LearningModuleRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningModuleRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wem.learning.argument.exception":"There was an error parsing argument","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.module.not.found":"The operation failed since corresponding learning module was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.module.archived.error":"The operation failed because the module is already archived"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:rule:edit"]},"x-purecloud-method-name":"putLearningModuleRule"}},"/api/v2/learning/scheduleslots/query":{"post":{"tags":["Learning"],"summary":"Get list of possible slots where a learning activity can be scheduled.","description":"","operationId":"postLearningScheduleslotsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The slot search request","required":true,"schema":{"$ref":"#/definitions/LearningScheduleSlotsQueryRequest"}}],"responses":{"200":{"description":"Learning slots retrieved","schema":{"$ref":"#/definitions/LearningScheduleSlotsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wem.learning.forbidden.action":"There was an error as the action was forbidden","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.assignment.schedule.conflict.exception":"The operation failed because of a conflict"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:scheduleSlot:view"]},"x-purecloud-method-name":"postLearningScheduleslotsQuery"}},"/api/v2/learning/scorm/{scormId}":{"get":{"tags":["Learning"],"summary":"Get Learning SCORM Result","description":"","operationId":"getLearningScormScormId","produces":["application/json"],"parameters":[{"name":"scormId","in":"path","description":"The ID of the SCORM package","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LearningScormResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","wem.learning.scorm.not.found":"The learning SCORM package was not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:scorm:view"]},"x-purecloud-method-name":"getLearningScormScormId"}},"/api/v2/learning/scorm":{"post":{"tags":["Learning"],"summary":"Create a SCORM package upload request","description":"","operationId":"postLearningScorm","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The SCORM package to be uploaded","required":false,"schema":{"$ref":"#/definitions/LearningScormUploadRequest"}}],"responses":{"201":{"description":"SCORM package upload request created","schema":{"$ref":"#/definitions/LearningScormUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["learning"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:scorm:add"]},"x-purecloud-method-name":"postLearningScorm"}},"/api/v2/widgets/deployments/{deploymentId}":{"get":{"tags":["Widgets"],"summary":"Get a Widget deployment","description":"","operationId":"getWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployment"},"put":{"tags":["Widgets"],"summary":"Update a Widget deployment","description":"","operationId":"putWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:edit","webchat:deployment:update"]},"x-purecloud-method-name":"putWidgetsDeployment"},"delete":{"tags":["Widgets"],"summary":"Delete a Widget deployment","description":"","operationId":"deleteWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:delete","webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWidgetsDeployment"}},"/api/v2/widgets/deployments":{"get":{"tags":["Widgets"],"summary":"List Widget deployments","description":"","operationId":"getWidgetsDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployments"},"post":{"tags":["Widgets"],"summary":"Create Widget deployment","description":"","operationId":"postWidgetsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Conflict caused by too many deployments","maximum.deployments.exceeded":"No more than 10 deployments allowed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:add","webchat:deployment:create"]},"x-purecloud-method-name":"postWidgetsDeployments"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes","description":"","operationId":"getWorkforcemanagementManagementunitActivitycodes","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityCodeContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitActivitycodes"}},"/api/v2/workforcemanagement/timeoffrequests/estimate":{"post":{"tags":["Workforce Management"],"summary":"Estimates available time off for current user","description":"","operationId":"postWorkforcemanagementTimeoffrequestsEstimate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/EstimateAvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimateAvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequestsEstimate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity code","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycode"},"delete":{"tags":["Workforce Management"],"summary":"Deletes an activity code","description":"","operationId":"deleteWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The activity code was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitActivitycode"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity code","description":"","operationId":"patchWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","wfm.ids.may.not.be.blank":"One or more secondary presence IDs was passed in as a blank value","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.primary.secondary.presences":"The request contains one or more primary secondary presences","wfm.too.many.secondary.presences":"The request contains too many secondary presences","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.secondary.presences.inactive.or.not.found":"One or more secondary presences are inactive or do not exist","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivitycode"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCodeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycodes"},"post":{"tags":["Workforce Management"],"summary":"Create a new activity code","description":"","operationId":"postWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.primary.secondary.presences":"The request contains one or more primary secondary presences","wfm.too.many.secondary.presences":"The request contains too many secondary presences","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more secondary presence IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.secondary.presences.inactive.or.not.found":"One or more secondary presences are inactive or do not exist","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivitycodes"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Get intraday planning groups for the given date","description":"","operationId":"getWorkforcemanagementBusinessunitIntradayPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"date","in":"query","description":"yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntradayPlanningGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitIntradayPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday":{"post":{"tags":["Workforce Management"],"summary":"Get intraday data for the given date for the requested planningGroupIds","description":"","operationId":"postWorkforcemanagementBusinessunitIntraday","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/IntradayPlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncIntradayResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitIntraday"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for importing a short term forecast","description":"Once the upload is complete, call the /import route to start the short term forecast import process","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportForecastUploadResponse"}},"201":{"description":"The upload url for import was successfully created","schema":{"$ref":"#/definitions/ImportForecastUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import":{"post":{"tags":["Workforce Management"],"summary":"Starts importing the uploaded short term forecast","description":"Call after uploading the forecast data to the url supplied by the /import/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImport","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportForecastResponse"}},"202":{"description":"The forecast import is processing","schema":{"$ref":"#/definitions/ImportForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsImport"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast generation results","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts":{"get":{"tags":["Workforce Management"],"summary":"Get short term forecasts","description":"Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecasts","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecastListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecasts"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/GenerateBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was successfully generated","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}":{"get":{"tags":["Workforce Management"],"summary":"Get a short term forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the forecast","required":false,"type":"array","items":{"type":"string","enum":["planningGroups","generationResults"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecast"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecast"},"delete":{"tags":["Workforce Management"],"summary":"Delete a short term forecast","description":"Must not be tied to any schedules","operationId":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"204":{"description":"The forecast was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast planning group snapshot","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ForecastPlanningGroupsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a short term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastData","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumber","in":"query","description":"The week number to fetch (for multi-week forecasts)","required":false,"type":"integer","format":"int32"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastData"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement":{"get":{"tags":["Workforce Management"],"summary":"Get the staffing requirement by planning group for a forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumbers","in":"query","description":"The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastStaffingRequirementsResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingRequirement:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a long term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LongTermForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast to copy","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/CopyBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was created","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get business unit","description":"Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).","operationId":"getWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the business unit","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.timeZone","settings.startDayOfWeek","settings.shortTermForecasting","settings.scheduling"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","learning","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:staffingGroup:add","wfm:staffingGroup:delete","wfm:staffingGroup:edit","wfm:staffingGroup:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view","coaching:appointment:add","coaching:appointment:edit","learning:assignment:add","learning:assignment:reschedule"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete business unit","description":"A business unit cannot be deleted if it contains one or more management units","operationId":"deleteWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The business unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunit"},"patch":{"tags":["Workforce Management"],"summary":"Update business unit","description":"","operationId":"patchWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunit"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get all authorized management units in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitManagementunits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"feature","in":"query","description":"If specified, the list of management units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of management units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunitManagementunits"}},"/api/v2/workforcemanagement/businessunits":{"get":{"tags":["Workforce Management"],"summary":"Get business units","description":"","operationId":"getWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"name":"feature","in":"query","description":"If specified, the list of business units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of business units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunits"},"post":{"tags":["Workforce Management"],"summary":"Add a new business unit","description":"It may take a minute or two for a new business unit to be available for api operations","operationId":"postWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"201":{"description":"The business unit was successfully created","schema":{"$ref":"#/definitions/BusinessUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunits"}},"/api/v2/workforcemanagement/businessunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get business units across divisions","description":"","operationId":"getWorkforcemanagementBusinessunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return business units in all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitsDivisionviews"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get management unit","description":"settings.shortTermForecasting is deprecated and now lives on the business unit","operationId":"getWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.adherence","settings.timeOff","settings.scheduling","settings.shortTermForecasting","settings.shiftTrading"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:shrinkage:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:staffingGroup:add","wfm:staffingGroup:delete","wfm:staffingGroup:edit","wfm:staffingGroup:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete management unit","description":"","operationId":"deleteWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The management unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunit"},"patch":{"tags":["Workforce Management"],"summary":"Update the requested management unit","description":"","operationId":"patchWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/move":{"post":{"tags":["Workforce Management"],"summary":"Move the requested management unit to a new business unit","description":"Returns status 200 if the management unit is already in the requested business unit","operationId":"postWorkforcemanagementManagementunitMove","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"202":{"description":"The management unit is being moved","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.validation.business.unit.not.found":"Business unit not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitMove"}},"/api/v2/workforcemanagement/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get management units","description":"","operationId":"getWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"expand","in":"query","description":"Deprecated, expand settings on the single MU route","required":false,"type":"string","enum":["details"]},{"name":"feature","in":"query","description":"If specified, the list of management units for which the user is authorized to use the requested feature will be returned","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","AgentWorkPlanBid","AlternativeShift","Coaching","Learning","ActivityCodes","ActivityPlans","Agents","BuActivityCodes","BusinessUnits","ContinuousForecast","HistoricalAdherence","HistoricalShrinkage","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","StaffingGroups","TimeOffPlans","TimeOffRequests","TimeOffLimits","WorkPlanBids","WorkPlanBidGroups","WorkPlanRotations","WorkPlans"]},{"name":"divisionId","in":"query","description":"If specified, the list of management units belonging to the specified division will be returned","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementManagementunits"},"post":{"tags":["Workforce Management"],"summary":"Add a management unit","description":"It may take a minute or two for a new management unit to be available for api operations","operationId":"postWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateManagementUnitApiRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"201":{"description":"The management unit was successfully created","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.validation.business.unit.not.found":"Business unit not found","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:managementUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunits"}},"/api/v2/workforcemanagement/managementunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get management units across divisions","description":"","operationId":"getWorkforcemanagementManagementunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitsDivisionviews"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given agent","description":"","operationId":"getWorkforcemanagementManagementunitAgentShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgentShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Get data for agent in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitAgent","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"},{"name":"excludeCapabilities","in":"query","description":"Excludes all capabilities of the agent such as queues, languages, and skills","required":false,"type":"boolean"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["workPlanOverrides"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgent"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents":{"patch":{"tags":["Workforce Management"],"summary":"Update agent configurations","description":"","operationId":"patchWorkforcemanagementManagementunitAgents","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateMuAgentsRequest"}}],"responses":{"204":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested agents was not found in the management unit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitAgents"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users":{"get":{"tags":["Workforce Management"],"summary":"Get users in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:historicalAdherence:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:view","wfm:staffingGroup:view","wfm:timeOffRequest:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUsers"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a planning group","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes the planning group","description":"","operationId":"deleteWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The planning group was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitPlanninggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates the planning group","description":"","operationId":"patchWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more language, skill or queue IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitPlanninggroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets list of planning groups","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroupList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view","wfm:shortTermForecast:view","wfm:intraday:view","wfm:agent:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroups"},"post":{"tags":["Workforce Management"],"summary":"Adds a new planning group","description":"","operationId":"postWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"201":{"description":"The planning group was successfully created","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more language, skill or queue IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}":{"get":{"tags":["Workforce Management"],"summary":"Get a service goal template","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the service goal template","required":false,"type":"array","items":{"type":"string","enum":["impactOverride"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplate"},"delete":{"tags":["Workforce Management"],"summary":"Delete a service goal template","description":"","operationId":"deleteWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of the service goal template to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The service goal template was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitServicegoaltemplate"},"patch":{"tags":["Workforce Management"],"summary":"Updates a service goal template","description":"","operationId":"patchWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitServicegoaltemplate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates":{"get":{"tags":["Workforce Management"],"summary":"Gets list of service goal templates","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the service goal template","required":false,"type":"array","items":{"type":"string","enum":["impactOverride"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplateList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view","wfm:planningGroup:view","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplates"},"post":{"tags":["Workforce Management"],"summary":"Adds a new service goal template","description":"","operationId":"postWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"201":{"description":"The service goal template was successfully created","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitServicegoaltemplates"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users":{"get":{"tags":["Workforce Management"],"summary":"Gets list of users available for whom you can send direct shift trade requests","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesUsers"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched":{"get":{"tags":["Workforce Management"],"summary":"Gets a summary of all shift trades in the matched state","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesMatched","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeMatchesSummaryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesMatched"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of staffing groups","description":"","operationId":"getWorkforcemanagementBusinessunitStaffinggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific staffing groups","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitStaffinggroups"},"post":{"tags":["Workforce Management"],"summary":"Creates a new staffing group","description":"","operationId":"postWorkforcemanagementBusinessunitStaffinggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateStaffingGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"201":{"description":"The staffing group was successfully created","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitStaffinggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a staffing group","description":"","operationId":"getWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitStaffinggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a staffing group","description":"","operationId":"deleteWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The staffing group was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitStaffinggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates a staffing group","description":"","operationId":"patchWorkforcemanagementBusinessunitStaffinggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"staffingGroupId","in":"path","description":"The ID of the staffing group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateStaffingGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StaffingGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitStaffinggroup"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time off limit objects under management unit.","description":"Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.","operationId":"getWorkforcemanagementManagementunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view","wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeofflimits"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time off limit object under management unit.","description":"Only one limit object is allowed under management unit, so an attempt to create second object will fail.","operationId":"postWorkforcemanagementManagementunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"201":{"description":"The time off limit was successfully created","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeofflimits"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time off limit object","description":"Returns properties of time off limit object, but not daily values.","operationId":"getWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeofflimit"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time off limit object","description":"","operationId":"deleteWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit object to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time off limit object deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitTimeofflimit"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time off limit object.","description":"Updates time off limit object properties, but not daily values.","operationId":"patchWorkforcemanagementManagementunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The id of time off limit object to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeofflimit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values":{"put":{"tags":["Workforce Management"],"summary":"Sets daily values for a date range of time off limit object","description":"Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API","operationId":"putWorkforcemanagementManagementunitTimeofflimitValues","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time off limit object to set values for","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/SetTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffLimit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"putWorkforcemanagementManagementunitTimeofflimitValues"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves time off limit related values based on a given set of filters.","description":"","operationId":"postWorkforcemanagementManagementunitTimeofflimitsValuesQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeofflimitsValuesQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time off plan","description":"","operationId":"getWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeoffplan"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time off plan","description":"","operationId":"deleteWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time off plan was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitTimeoffplan"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time off plan","description":"","operationId":"patchWorkforcemanagementManagementunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time off plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeoffplan"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time off plans","description":"","operationId":"getWorkforcemanagementManagementunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlanListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitTimeoffplans"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time off plan","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffPlan"}},"201":{"description":"The time off plan was successfully created","schema":{"$ref":"#/definitions/TimeOffPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate":{"post":{"tags":["Workforce Management"],"summary":"Estimates available time off for an agent","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user for whom the time off request estimate is requested","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/EstimateAvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimateAvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves integration statuses for a list of time off requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffIntegrationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus":{"patch":{"tags":["Workforce Management"],"summary":"Set integration status for a time off request.","description":"","operationId":"patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/SetTimeOffIntegrationStatusRequest"}},{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of user to whom the time off request belongs.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Retrieves time off limit, allocated and waitlisted values according to specific time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the time off request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request, which dates and activityCodeId determine limit values to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:timeOffRequest:view","wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for a given user","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request","description":"","operationId":"patchWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user the requested time off request belongs to","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The id of the time off request to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AdminTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitUserTimeoffrequest"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests":{"post":{"tags":["Workforce Management"],"summary":"Create a new time off request","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAdminTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query":{"post":{"tags":["Workforce Management"],"summary":"Fetches time off requests matching the conditions specified in the request body","description":"Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/TimeOffRequestQueryBody"}},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves daily waitlist position for a list of time off requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryWaitlistPositionsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WaitlistPositionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query":{"post":{"tags":["Workforce Management"],"summary":"Gets staffing group associations for a list of user IDs","description":"","operationId":"postWorkforcemanagementBusinessunitStaffinggroupsQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryUserStaffingGroupListRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStaffingGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:staffingGroup:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitStaffinggroupsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search":{"post":{"tags":["Workforce Management"],"summary":"Searches for potential shift trade matches for the current agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/SearchShiftTradesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SearchShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given week","description":"","operationId":"getWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"evaluateMatches","in":"query","description":"Whether to evaluate the matches for violations","required":false,"type":"boolean","default":true},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekShifttrades"},"post":{"tags":["Workforce Management"],"summary":"Adds a shift trade","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk":{"post":{"tags":["Workforce Management"],"summary":"Updates the state of a batch of shift trades","description":"Admin functionality is not supported with \"mine\".","operationId":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BulkShiftTradeStateUpdateRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"202":{"description":"The shift trades are being updated. Results will come via notification","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}":{"patch":{"tags":["Workforce Management"],"summary":"Updates a shift trade. This route can only be called by the initiating agent","description":"","operationId":"patchWorkforcemanagementManagementunitWeekShifttrade","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/PatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWeekShifttrade"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match":{"post":{"tags":["Workforce Management"],"summary":"Matches a shift trade. This route can only be called by the receiving agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradeMatch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/MatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MatchShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradeMatch"}},"/api/v2/workforcemanagement/agents":{"post":{"tags":["Workforce Management"],"summary":"Move agents in and out of management unit","description":"","operationId":"postWorkforcemanagementAgents","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveAgentsRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/MoveAgentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.ids.may.not.be.blank":"One or more user IDs was passed in as a blank value","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found.","user.ids.not.found":"One of the requested resources in the request body was not found, please check the error details for more information"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"postWorkforcemanagementAgents"}},"/api/v2/workforcemanagement/agents/{agentId}/managementunit":{"get":{"tags":["Workforce Management"],"summary":"Get the management unit to which the agent belongs","description":"","operationId":"getWorkforcemanagementAgentManagementunit","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to look up","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentManagementUnitReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The requested agent is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","learning","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","coaching:appointment:add","coaching:appointment:edit","learning:assignment:add","learning:assignment:reschedule"]},"x-purecloud-method-name":"getWorkforcemanagementAgentManagementunit"}},"/api/v2/workforcemanagement/agents/me/managementunit":{"get":{"tags":["Workforce Management"],"summary":"Get the management unit to which the currently logged in agent belongs","description":"","operationId":"getWorkforcemanagementAgentsMeManagementunit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentManagementUnitReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The requested agent is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffLimit:add","wfm:timeOffLimit:delete","wfm:timeOffLimit:edit","wfm:timeOffLimit:view","wfm:timeOffPlan:add","wfm:timeOffPlan:delete","wfm:timeOffPlan:edit","wfm:timeOffPlan:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementAgentsMeManagementunit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate":{"post":{"tags":["Workforce Management"],"summary":"Validate Work Plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanValidate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanValidationRequest"}},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateWorkPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add","wfm:workPlan:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanValidate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan","description":"","operationId":"getWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to fetch","required":true,"type":"string"},{"name":"includeOnly","in":"query","description":"limit response to the specified fields","required":false,"type":"array","items":{"type":"string","enum":["agentCount","agents","optionalDays","shifts","shiftStartVariances"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view","wfm:workPlan:view","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplan"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplan"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to update work plan even if validation result is invalid","required":false,"type":"string","enum":["Ignore"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplan"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Get work plans","description":"\"expand=details\" is deprecated","operationId":"getWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Include to access additional data on the work plans","required":false,"type":"array","items":{"type":"string","enum":["agentCount","agents","optionalDays","shifts","shiftStartVariances","details"]},"collectionFormat":"multi"},{"name":"exclude","in":"query","description":"Exclude specific data on the work plans from the response","required":false,"type":"array","items":{"type":"string","enum":["shifts.activities"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplans"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to create work plan even if the validation result is invalid","required":false,"type":"string","enum":["Ignore"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlan"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Name not specified or there is already a work plan with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanCopy"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan rotation","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotation"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan rotation","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to be deleted","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan rotation was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplanrotation"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan rotation","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplanrotation"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations":{"get":{"tags":["Workforce Management"],"summary":"Get work plan rotations","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agents"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotations"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AddWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"201":{"description":"The work plan rotation was successfully created","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotations"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotationCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"Name not specified or there is already a work plan rotation with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotationCopy"}},"/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an adherence explanation operation. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceExplanationsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementAdherenceExplanationsJob"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations":{"post":{"tags":["Workforce Management"],"summary":"Add an adherence explanation for the requested user","description":"","operationId":"postWorkforcemanagementAgentAdherenceExplanations","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AddAdherenceExplanationAdminRequest"}}],"responses":{"202":{"description":"The adherence explanation is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:add"]},"x-purecloud-method-name":"postWorkforcemanagementAgentAdherenceExplanations"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}":{"get":{"tags":["Workforce Management"],"summary":"Get an adherence explanation","description":"","operationId":"getWorkforcemanagementAgentAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The explanation was not found. It either does not exist or may now only be accessible via query by date range","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"getWorkforcemanagementAgentAdherenceExplanation"},"patch":{"tags":["Workforce Management"],"summary":"Update an adherence explanation","description":"","operationId":"patchWorkforcemanagementAgentAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/UpdateAdherenceExplanationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"202":{"description":"The adherence explanation update is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementAgentAdherenceExplanation"}},"/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations for the given agent across a specified range","description":"","operationId":"postWorkforcemanagementAgentAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent to query","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsResponse"}},"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations across an entire business unit for the requested period","description":"","operationId":"postWorkforcemanagementBusinessunitAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsResponse"}},"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/BuQueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"The requested business unit was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adherenceExplanation:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/adherence/explanations":{"post":{"tags":["Workforce Management"],"summary":"Submit an adherence explanation for the current user","description":"","operationId":"postWorkforcemanagementAdherenceExplanations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AddAdherenceExplanationAgentRequest"}}],"responses":{"202":{"description":"The adherence explanation is processing","schema":{"$ref":"#/definitions/AdherenceExplanationAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceExplanations"}},"/api/v2/workforcemanagement/adherence/explanations/{explanationId}":{"get":{"tags":["Workforce Management"],"summary":"Get an adherence explanation for the current user","description":"","operationId":"getWorkforcemanagementAdherenceExplanation","produces":["application/json"],"parameters":[{"name":"explanationId","in":"path","description":"The ID of the explanation to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdherenceExplanationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The explanation was not found. It either does not exist or may now only be accessible via query by date range","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAdherenceExplanation"}},"/api/v2/workforcemanagement/adherence/explanations/query":{"post":{"tags":["Workforce Management"],"summary":"Query adherence explanations for the current user","description":"","operationId":"postWorkforcemanagementAdherenceExplanationsQuery","produces":["application/json"],"parameters":[{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AgentQueryAdherenceExplanationsRequest"}}],"responses":{"202":{"description":"The adherence explanation query is processing","schema":{"$ref":"#/definitions/QueryAdherenceExplanationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentAdherenceExplanation:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceExplanationsQuery"}},"/api/v2/workforcemanagement/adherence/historical/bulk":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report in bulk","description":"","operationId":"postWorkforcemanagementAdherenceHistoricalBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.fields":"One or more required fields are missing from the request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.only.authorized.for.team.access.some.divisions":"You are only authorized to call this route for specific teams for some of the required divisions","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistoricalBulk"}},"/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceHistoricalBulkJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job to get","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementAdherenceHistoricalBulkJob"}},"/api/v2/workforcemanagement/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Deprecated. Use bulk routes instead (/adherence/historical/bulk)","description":"","operationId":"postWorkforcemanagementAdherenceHistorical","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForUsers"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistorical"}},"/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of a historical adherence request operation. Only the user who started the operation can query the status","description":"Job details are only retained if the initial request returned a 202 ACCEPTED response","operationId":"getWorkforcemanagementAdherenceHistoricalJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"Successful Operation","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entitynotfound":"The requested entity was not found.","job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherenceHistoricalJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementManagementunitHistoricaladherencequery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitHistoricaladherencequery"}},"/api/v2/workforcemanagement/teams/{teamId}/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Request a teams historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementTeamAdherenceHistorical","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"The ID of the team","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForTeams"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","wfm.unauthorized.for.any.team.members":"You are not authorized for any members of the team","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementTeamAdherenceHistorical"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of user schedule adherence records for the requested management unit","description":"","operationId":"getWorkforcemanagementManagementunitAdherence","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleAdherenceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"The management unit ID must be a valid UUID","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAdherence"}},"/api/v2/workforcemanagement/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of UserScheduleAdherence records for the requested users","description":"","operationId":"getWorkforcemanagementAdherence","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.id":"All requested user IDs must be valid UUIDs","no.user.ids.specified":"You must specify at least one userId","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fail":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherence"}},"/api/v2/workforcemanagement/agents/me/possibleworkshifts":{"post":{"tags":["Workforce Management"],"summary":"Get agent possible work shifts for requested time frame","description":"","operationId":"postWorkforcemanagementAgentsMePossibleworkshifts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AgentPossibleWorkShiftsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentPossibleWorkShiftsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentPossibleWorkShifts:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentsMePossibleworkshifts"}},"/api/v2/workforcemanagement/calendar/url/ics":{"get":{"tags":["Workforce Management"],"summary":"Get existing calendar link for the current user","description":"","operationId":"getWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"Calendar ICS not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync","wfm:agentSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementCalendarUrlIcs"},"post":{"tags":["Workforce Management"],"summary":"Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned","description":"","operationId":"postWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize default activity code names in the ics-formatted calendar","required":false,"type":"string","default":"en-US","x-example":"en-US"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"201":{"description":"","schema":{"$ref":"#/definitions/CalendarUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync","wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementCalendarUrlIcs"},"delete":{"tags":["Workforce Management"],"summary":"Disable generated calendar link for the current user","description":"","operationId":"deleteWorkforcemanagementCalendarUrlIcs","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:agentSchedule:sync"]},"x-purecloud-method-name":"deleteWorkforcemanagementCalendarUrlIcs"}},"/api/v2/workforcemanagement/timeofflimits/available/query":{"post":{"tags":["Workforce Management"],"summary":"Queries available time off for the current user","description":"","operationId":"postWorkforcemanagementTimeofflimitsAvailableQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AvailableTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTimeOffResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeofflimitsAvailableQuery"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions":{"get":{"tags":["Workforce Management"],"summary":"Get the daily waitlist positions of a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequestWaitlistpositions","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WaitlistPositionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequestWaitlistpositions"}},"/api/v2/workforcemanagement/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequests"},"post":{"tags":["Workforce Management"],"summary":"Create a time off request for the current user","description":"","operationId":"postWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAgentTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequests"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request for the current user","description":"","operationId":"patchWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"The ID of the time off request","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementTimeoffrequest"}},"/api/v2/workforcemanagement/agentschedules/mine":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementAgentschedulesMine","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuGetCurrentAgentScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuCurrentAgentScheduleSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentschedulesMine"}},"/api/v2/workforcemanagement/schedules":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementSchedules"}},"/api/v2/workforcemanagement/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all of my shift trades","description":"","operationId":"getWorkforcemanagementShifttrades","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementShifttrades"}},"/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves integration statuses for a list of current user time off requests","description":"","operationId":"postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserTimeOffIntegrationStatusRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffIntegrationStatusResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The user is not in a management unit","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery"}},"/api/v2/workforcemanagement/notifications":{"get":{"tags":["Workforce Management"],"summary":"Get a list of notifications for the current user","description":"Notifications are only initially sent if you have the relevant Notify and Edit permissions","operationId":"getWorkforcemanagementNotifications","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementNotifications"}},"/api/v2/workforcemanagement/notifications/update":{"post":{"tags":["Workforce Management"],"summary":"Mark a list of notifications as read or unread","description":"","operationId":"postWorkforcemanagementNotificationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateNotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-purecloud-method-name":"postWorkforcemanagementNotificationsUpdate"}},"/api/v2/workforcemanagement/historicaldata/deletejob":{"get":{"tags":["Workforce Management"],"summary":"Retrieves delete job status for historical data imports of the organization","description":"","operationId":"getWorkforcemanagementHistoricaldataDeletejob","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoricalImportDeleteJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Invalid status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"No historical data delete request was found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"getWorkforcemanagementHistoricaldataDeletejob"},"post":{"tags":["Workforce Management"],"summary":"Delete the entries of the historical data imports in the organization","description":"","operationId":"postWorkforcemanagementHistoricaldataDeletejob","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Delete job is accepted. Try using get API to get the status.","schema":{"$ref":"#/definitions/HistoricalImportDeleteJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postWorkforcemanagementHistoricaldataDeletejob"}},"/api/v2/workforcemanagement/historicaldata/importstatus":{"get":{"tags":["Workforce Management"],"summary":"Retrieves status of the historical data imports of the organization","description":"","operationId":"getWorkforcemanagementHistoricaldataImportstatus","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoricalImportStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"getWorkforcemanagementHistoricaldataImportstatus"}},"/api/v2/workforcemanagement/historicaldata/validate":{"post":{"tags":["Workforce Management"],"summary":"Trigger validation process for historical import","description":"","operationId":"postWorkforcemanagementHistoricaldataValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/ValidationServiceRequest"}}],"responses":{"202":{"description":"Accepted - Triggering validation process."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"The request could not be processed due to invalid request data.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.historical.running.request":"Another request from organization is in progress."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postWorkforcemanagementHistoricaldataValidate"}},"/api/v2/workforcemanagement/agents/integrations/hris/query":{"post":{"tags":["Workforce Management"],"summary":"Query integrations for agents","description":"","operationId":"postWorkforcemanagementAgentsIntegrationsHrisQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryAgentsIntegrationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentsIntegrationsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentsIntegrationsHrisQuery"}},"/api/v2/workforcemanagement/agents/{agentId}/integrations/hris":{"put":{"tags":["Workforce Management"],"summary":"Update integrations for agent","description":"","operationId":"putWorkforcemanagementAgentIntegrationsHris","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The ID of the agent","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AgentIntegrationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentIntegrationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.bad.request":"The request failed validation","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","user.ids.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:edit"]},"x-purecloud-method-name":"putWorkforcemanagementAgentIntegrationsHris"}},"/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the results of time off types job","description":"","operationId":"getWorkforcemanagementIntegrationsHrisTimeofftypesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HrisTimeOffTypesJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementIntegrationsHrisTimeofftypesJob"}},"/api/v2/workforcemanagement/integrations/hris":{"get":{"tags":["Workforce Management"],"summary":"Get integrations","description":"","operationId":"getWorkforcemanagementIntegrationsHris","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntegrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:integration:view"]},"x-purecloud-method-name":"getWorkforcemanagementIntegrationsHris"}},"/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs":{"post":{"tags":["Workforce Management"],"summary":"Get list of time off types configured in integration","description":"","operationId":"postWorkforcemanagementIntegrationsHriTimeofftypesJobs","produces":["application/json"],"parameters":[{"name":"hrisIntegrationId","in":"path","description":"The ID of the HRIS integration for which time off types are queried.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HrisTimeOffTypesResponse"}},"202":{"description":"The time off types query is processing","schema":{"$ref":"#/definitions/HrisTimeOffTypesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The integration was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:integration:view"]},"x-purecloud-method-name":"postWorkforcemanagementIntegrationsHriTimeofftypesJobs"}},"/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"To get status of the modeling job.","description":"This Endpoint is Deprecated, and not recommended to be used.","operationId":"getWorkforcemanagementAdhocmodelingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the modeling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ModelingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adhocModel:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdhocmodelingjob"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions":{"get":{"tags":["Workforce Management"],"summary":"Get the performance prediction for the associated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Upload daily activity changes to be able to request a performance prediction recalculation","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations":{"post":{"tags":["Workforce Management"],"summary":"Request a daily recalculation of the performance prediction for the associated schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the performance prediction belongs to","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}":{"get":{"tags":["Workforce Management"],"summary":"Get recalculated performance prediction result","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit to which the performance prediction belongs","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule the recalculation belongs to","required":true,"type":"string"},{"name":"recalculationId","in":"path","description":"The ID of the recalculation request","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PerformancePredictionRecalculationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs":{"get":{"tags":["Workforce Management"],"summary":"Get the list of scheduling runs","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRuns","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRunListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRuns"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}":{"get":{"tags":["Workforce Management"],"summary":"Get a scheduling run","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRun"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRun"},"delete":{"tags":["Workforce Management"],"summary":"Cancel a scheduling run","description":"","operationId":"deleteWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"204":{"description":"The run was successfully canceled"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitSchedulingRun"},"patch":{"tags":["Workforce Management"],"summary":"Mark a schedule run as applied","description":"","operationId":"patchWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PatchBuScheduleRunRequest"}}],"responses":{"204":{"description":"The update was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitSchedulingRun"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a rescheduling operation","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRunResult","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"name":"managementUnitIds","in":"query","description":"The IDs of the management units for which to fetch the reschedule results","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The fields to expand. Omitting will return an empty response","required":true,"type":"array","items":{"type":"string","enum":["headcountForecast","generationResults","agentSchedules"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuRescheduleResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","wfm.only.authorized.for.team.access":"Unauthorized: User only given team access permissions","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit","wfm:schedule:generate"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRunResult"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Search published schedules","description":"","operationId":"postWorkforcemanagementBusinessunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["managementUnits.agents"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedule"},"delete":{"tags":["Workforce Management"],"summary":"Delete a schedule","description":"","operationId":"deleteWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule is being deleted and updates will be sent by notification"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekSchedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule":{"post":{"tags":["Workforce Management"],"summary":"Start a rescheduling run","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleReschedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuRescheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"202":{"description":"The rescheduling run was started and updates will be sent by notification","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleReschedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Get the list of week schedules for the specified week","description":"Use \"recent\" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"includeOnlyPublished","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["forecast.description"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedules"},"post":{"tags":["Workforce Management"],"summary":"Create a blank schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCreateBlankScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"201":{"description":"The schedule was successfully created","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"VALIDATION_FAILURE","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedules"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for importing a schedule","description":"Once the upload is complete, call the /import route to start the schedule import process","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScheduleUploadResponse"}},"201":{"description":"The upload url for import was successfully created","schema":{"$ref":"#/definitions/ImportScheduleUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import":{"post":{"tags":["Workforce Management"],"summary":"Starts processing a schedule import","description":"Call after uploading the schedule data to the url supplied by the /import/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesImport","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/WfmProcessUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleUploadProcessingResponse"}},"202":{"description":"The schedule import is processing","schema":{"$ref":"#/definitions/ScheduleUploadProcessingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesImport"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuGenerateScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"202":{"description":"The schedule generation run was started and updates will be sent via notification","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCopyScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"201":{"description":"The schedule was successfully copied","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule copy was started and updates will be sent via notification","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Get the generation results for a generated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast":{"get":{"tags":["Workforce Management"],"summary":"Get the headcount forecast by planning group for the schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"forceDownload","in":"query","description":"Whether to force the result to come via download url. For testing purposes only","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuHeadcountForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query":{"post":{"tags":["Workforce Management"],"summary":"Loads agent schedule data from the schedule. Used in combination with the metadata route","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuQueryAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units, or is lacking the necessary team conditional permissions","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You requested teams to which you do not have access","wfm.management.unit.not.authorized":"You are not authorized to view schedules for this management unit","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Loads agent's schedule history.","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"agentId","in":"path","description":"THe ID of the agent","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAgentScheduleHistoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The requested user is not in a team but you only have access to teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams","wfm.management.unit.not.authorized":"You are not authorized to view schedule history for this management unit","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","wfm.only.authorized.for.team.required.divisions":"The requested user is not in a team but you only have access to teams in the required division","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl":{"post":{"tags":["Workforce Management"],"summary":"Creates a signed upload URL for updating a schedule","description":"Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process","operationId":"postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateScheduleUploadResponse"}},"201":{"description":"The upload url for schedule update was successfully created","schema":{"$ref":"#/definitions/UpdateScheduleUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update":{"post":{"tags":["Workforce Management"],"summary":"Starts processing a schedule update","description":"Call after uploading the schedule data to the url supplied by the /update/uploadurl route","operationId":"postWorkforcemanagementBusinessunitWeekScheduleUpdate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/ProcessScheduleUpdateUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule update process was started","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only edit schedules for up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"The user is only authorized to call this route for specific teams","missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.no.authorization.to.edit.schedule.for.teams":"The user is not authorized to edit the schedule(s) of any of the users in the requested teams","wfm.missing.team.permissions":"You must have access to the requested teams","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleUpdate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitSchedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UserListScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","wfm.team.only.permissions.not.allowed":"Team-only permissions are not allowed","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","wfm.deprecated.api.timeout":"The response of this deprecated route needed to come via notification, instead please use /agentschedules/search"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitSchedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"Return only published schedules","required":false,"type":"boolean"},{"name":"earliestWeekDate","in":"query","description":"The start date of the earliest week to query in yyyy-MM-dd format","required":false,"type":"string"},{"name":"latestWeekDate","in":"query","description":"The start date of the latest week to query in yyyy-MM-dd format","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedules"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get a week schedule","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"string","enum":["generationResults","headcountForecast"]},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedule"}},"/api/v2/workforcemanagement/schedulingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the scheduling job","description":"","operationId":"getWorkforcemanagementSchedulingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the scheduling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchedulingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedulingrequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementSchedulingjob"}},"/api/v2/workforcemanagement/shrinkage/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Request to fetch the status of the historical shrinkage query","description":"","operationId":"getWorkforcemanagementShrinkageJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"Accepted","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementShrinkageJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a historical shrinkage report","description":"The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body. ","operationId":"postWorkforcemanagementManagementunitShrinkageJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalShrinkageRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shrinkage:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitShrinkageJobs"}},"/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a historical shrinkage report","description":"The maximum supported range for historical shrinkage queries is up to 32 days","operationId":"postWorkforcemanagementTeamShrinkageJobs","produces":["application/json"],"parameters":[{"name":"teamId","in":"path","description":"The ID of the team","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalShrinkageTeamsRequest"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalShrinkageResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.unauthorized.for.any.team.members":"You are not authorized for any members of the team","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shrinkage:view"]},"x-purecloud-method-name":"postWorkforcemanagementTeamShrinkageJobs"}},"/api/v2/workforcemanagement/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for the current user for specified activity code and dates","description":"","operationId":"postWorkforcemanagementTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/TimeOffBalanceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The current user time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the results of time off types job","description":"","operationId":"getWorkforcemanagementTimeoffbalanceJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalanceJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"The job with the requested ID was not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementTimeoffbalanceJob"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for dates spanned by a given time off request","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the time off request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The time off request id.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs":{"post":{"tags":["Workforce Management"],"summary":"Query time off balances for a given user for specified activity code and dates","description":"","operationId":"postWorkforcemanagementManagementunitUserTimeoffbalanceJobs","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/TimeOffBalanceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"202":{"description":"The user time off balance query is processing","schema":{"$ref":"#/definitions/TimeOffBalancesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitUserTimeoffbalanceJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time-off limit objects","description":"","operationId":"getWorkforcemanagementBusinessunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific time-off limit objects","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view","wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeofflimits"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time-off limit object","description":"","operationId":"postWorkforcemanagementBusinessunitTimeofflimits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuCreateTimeOffLimitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"201":{"description":"The time-off limit was successfully created","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeofflimits"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time-off limit object","description":"Returns properties of time-off limit object, but not daily values","operationId":"getWorkforcemanagementBusinessunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeofflimit"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time-off limit object","description":"","operationId":"deleteWorkforcemanagementBusinessunitTimeofflimit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit object to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time-off limit object deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitTimeofflimit"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values":{"put":{"tags":["Workforce Management"],"summary":"Sets daily values for a date range of time-off limit object","description":"Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API","operationId":"putWorkforcemanagementBusinessunitTimeofflimitValues","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffLimitId","in":"path","description":"The ID of the time-off limit object to set values for","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSetTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:edit"]},"x-purecloud-method-name":"putWorkforcemanagementBusinessunitTimeofflimitValues"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query":{"post":{"tags":["Workforce Management"],"summary":"Retrieves time-off limit related values based on a given set of filters.","description":"","operationId":"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/QueryTimeOffLimitValuesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffLimitValuesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffLimit:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Gets a time-off plan","description":"","operationId":"getWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeoffplan"},"delete":{"tags":["Workforce Management"],"summary":"Deletes a time-off plan","description":"","operationId":"deleteWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The time-off plan was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitTimeoffplan"},"patch":{"tags":["Workforce Management"],"summary":"Updates a time-off plan","description":"","operationId":"patchWorkforcemanagementBusinessunitTimeoffplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"timeOffPlanId","in":"path","description":"The ID of the time-off plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuUpdateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitTimeoffplan"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans":{"get":{"tags":["Workforce Management"],"summary":"Gets a list of time-off plans","description":"","operationId":"getWorkforcemanagementBusinessunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"managementUnitId","in":"query","description":"The ID of the management unit to get management unit specific staffing groups","required":false,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitTimeoffplans"},"post":{"tags":["Workforce Management"],"summary":"Creates a new time-off plan","description":"","operationId":"postWorkforcemanagementBusinessunitTimeoffplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuCreateTimeOffPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"201":{"description":"The time-off plan was successfully created","schema":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","wfm.configuration.conflict":"The request failed due to existing configuration conflict","invalid.property":"Value [%s] is not a valid property for object [%s]","wfm.validation.management.unit.not.found":"Management unit not found","constraint.validation":"%s","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","wfm.permission.failure":"The user is not authorized to make the request because they are not authorized for the division of the business unit nor for the requested management units","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitTimeoffplans"}},"/api/v2/taskmanagement/workbins/query":{"post":{"tags":["Task Management"],"summary":"Query for workbins","description":"","operationId":"postTaskmanagementWorkbinsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"QueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorkbinQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","invalid.input.int.value.too.low":"Page size too small.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"User has no permission access to the division.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"postTaskmanagementWorkbinsQuery"}},"/api/v2/taskmanagement/workbins/{workbinId}":{"get":{"tags":["Task Management"],"summary":"Get a workbin","description":"","operationId":"getTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbin"},"delete":{"tags":["Task Management"],"summary":"Delete a workbin","description":"","operationId":"deleteTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.entity.used":"Workbin still being used by a Worktype.","pre.check.delete.failed":"Workbin still has Workitems associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkbin"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a workbin","description":"","operationId":"patchTaskmanagementWorkbin","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Json with attributes and their new values: {\"description\":\"new description\", \"name\":\"new name\"}.","required":true,"schema":{"$ref":"#/definitions/WorkbinUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkbin"}},"/api/v2/taskmanagement/workbins":{"post":{"tags":["Task Management"],"summary":"Create a workbin","description":"","operationId":"postTaskmanagementWorkbins","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkbinCreate"}}],"responses":{"201":{"description":"Workbin created.","schema":{"$ref":"#/definitions/Workbin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"Maximum number of Workbins reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:add"]},"x-purecloud-method-name":"postTaskmanagementWorkbins"}},"/api/v2/taskmanagement/workitems":{"post":{"tags":["Task Management"],"summary":"Create a workitem","description":"","operationId":"postTaskmanagementWorkitems","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"201":{"description":"Workitem created.","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.missing.queue":"No queueId provided.","service.limit.per.day.maximum.created.limit.reached":"Reached maximum amount of workitems created per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.date.above.max":"Date above maximum.","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.date.below.min":"Date below minimum.","invalid.input.duplicate.scored.agents":"Duplicate entries in the scored agents list.","invalid.input.empty.value":"Empty value.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.timestamp.above.max":"Timestamp above maximum.","invalid.input.timestamp.below.min":"Timestamp below minimum.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.undefined.status":"Undefined status.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.input.missing.required.field":"Required field not supplied in payload.","invalid.input.default.status.empty":"Default status id is empty for worktype.","invalid.input.missing.mandatory.status":"Missing mandatory Open and Closed statuses in the Worktype.","workitem.queue.division.mismatch":"Queue is in a different division from workitem."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","utilization.label.id.not.found":"Utilization label ID does not exist","not.found":"The requested resource was not found.","not.found.error":"Worktype or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.workitem.division.mismatch":"A Workitem's Workbin and Worktype must belong to the same division.","wrapup.not.in.queue":"Wrapup code is not configured in the queue.","pre.check.value.greater.than":"Due date greater than expiration or expiration greater than TTL.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","service.limit.acd.started.maximum.limit.reached":"Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schema.error.schema.not.found":"Schema not found.","schema.error.schema.disabled":"Schema disabled.","schema.error.worktype.no.schema":"Worktype for this workitem does not have a schema defined.","schema.error.property.disabled":"Schema property disabled.","schema.error.missing.attributes":"Missing attributes.","schema.error.schema.deleted":"Schema deleted.","schema.error.invalid.schema":"Invalid schema.","schema.error.missing.version":"Schema version is not defined in this workitem.","schema.error.invalid.instance":"Invalid schema instance."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schedule.service.error.job.creation.failed":"Failed to schedule status transition.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitems"}},"/api/v2/taskmanagement/workitems/query/jobs":{"post":{"tags":["Task Management"],"summary":"Create a workitem query job","description":"","operationId":"postTaskmanagementWorkitemsQueryJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WorkitemQueryJobCreate","required":true,"schema":{"$ref":"#/definitions/WorkitemQueryJobCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemQueryJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.concurrent.query.job.per.user.limit.exceeded":"Rate limit exceeded for concurrent queries per user","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","workitem.concurrent.query.job.per.organization.limit.exceeded":"Rate limit exceeded for concurrent queries per org","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"No permission in any divisions to create the job.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:queryJob:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsQueryJobs"}},"/api/v2/taskmanagement/workitems/query/jobs/{jobId}":{"get":{"tags":["Task Management"],"summary":"Get the workitem query job associated with the job id.","description":"","operationId":"getTaskmanagementWorkitemsQueryJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemQueryJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","workitem.missing.required.division.permissions":"Missing division permissions to view the job."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Job not found with the supplied id"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:queryJob:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsQueryJob"}},"/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results":{"get":{"tags":["Task Management"],"summary":"Get results from for workitem query job ","description":"","operationId":"getTaskmanagementWorkitemsQueryJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemPagedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s","workitem.missing.required.division.permissions":"Missing division permissions to view the job results."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Job not found with the supplied id"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:queryJobResults:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsQueryJobResults"}},"/api/v2/taskmanagement/workitems/{workitemId}/disconnect":{"post":{"tags":["Task Management"],"summary":"Disconnect the assignee of the workitem","description":"","operationId":"postTaskmanagementWorkitemDisconnect","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:disconnect"]},"x-purecloud-method-name":"postTaskmanagementWorkitemDisconnect"}},"/api/v2/taskmanagement/workitems/{workitemId}/terminate":{"post":{"tags":["Task Management"],"summary":"Terminate a workitem","description":"","operationId":"postTaskmanagementWorkitemTerminate","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Terminated request","required":false,"schema":{"$ref":"#/definitions/WorkitemTerminate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","pre.check.status.must.be.closed.category.for.terminated.workitem":"Status provided is not a 'Closed' category status.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Not found error"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.cannot.terminate.terminated.workitem":"Cannot terminate an already terminated workitem."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:terminate"]},"x-purecloud-method-name":"postTaskmanagementWorkitemTerminate"}},"/api/v2/taskmanagement/workitems/{workitemId}":{"get":{"tags":["Task Management"],"summary":"Get a workitem","description":"","operationId":"getTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields to expand. Comma separated if more than one.","required":false,"type":"string","enum":["type","workbin","status","queue","assignee"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitem"},"delete":{"tags":["Task Management"],"summary":"Delete a workitem","description":"","operationId":"deleteTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.cannot.be.deleted.due.to.assignment.state":"Workitem cannot be deleted in certain assignment states"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkitem"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a workitem","description":"","operationId":"patchTaskmanagementWorkitem","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.invalid.assign.state":"Invalid assignment state.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.date.above.max":"Date above maximum.","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.date.below.min":"Date below minimum.","invalid.input.transition.delay.too.low":"Status transition delay too low.","invalid.input.duplicate.scored.agents":"Duplicate entries in the scored agents list.","invalid.input.empty.value":"Empty value.","invalid.input.missing.queue.in.workitem":"No queueId provided in the Workitem.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.update.queue.and.assignee":"Cannot update queue and assignee in the same request.","service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","invalid.input.timestamp.above.max":"Timestamp above maximum.","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","invalid.input.timestamp.below.min":"Timestamp below minimum.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.undefined.status":"Undefined status.","invalid.input.update.user.and.queue":"Cannot update user and queue in the same request.","invalid.input.update.assign.state.in.assign":"Cannot update assignmentState.","invalid.input.missing.assignee":"Cannot perform assignment without an assignee.","invalid.input.int.value.too.low":"Integer too low.","invalid.input.invalid.status.transition":"Invalid status transition.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","workitem.queue.division.mismatch":"Queue is in a different division from workitem."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","utilization.label.id.not.found":"Utilization label ID does not exist","not.found":"The requested resource was not found.","not.found.error":"Workitem type or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition.","pre.check.workitem.division.cannot.be.changed":"A workitem cannot be moved to a Workbin from another division.","invalid.assignment.requester.not.assignee":"Requester is not the assignee.","pre.check.cannot.be.reassigned":"Workitem cannot be reassigned.","pre.check.cannot.update.terminated.workitem":"Terminated workitem cannot be updated.","pre.check.value.greater.than":"Due date greater than expiration or expiration greater than TTL.","service.limit.acd.started.maximum.limit.reached":"Reached maximum number of routing (assignmentState: AcdStarted) workitems for queue","invalid.assignment.cannot.reassign.for.state":"Cannot be assigned to another user."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schema.error.schema.not.found":"Schema not found.","schema.error.worktype.no.schema":"Worktype for this workitem does not have a schema defined.","schema.error.property.disabled":"Schema property disabled.","schema.error.missing.attributes":"Missing attributes.","schema.error.invalid.schema":"Invalid schema.","schema.error.missing.version":"Schema version is not defined in this workitem.","schema.error.invalid.instance":"Invalid schema instance."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"schedule.service.error.job.creation.failed":"Job creation failed.","schedule.service.error.job.search.failed":"Job search failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:edit","workitems:workitem:accept"]},"x-purecloud-method-name":"patchTaskmanagementWorkitem"}},"/api/v2/taskmanagement/workitems/{workitemId}/assignment":{"patch":{"tags":["Task Management"],"summary":"Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"patchTaskmanagementWorkitemAssignment","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/WorkitemManualAssign"}}],"responses":{"202":{"description":"The manual assignment request was accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","workitem.not.queued.for.assignment":"The workitem cannot be manually assigned as it is not queued for assignment.","invalid.property":"Value [%s] is not a valid property for object [%s]","operation.failed":"The manual assignment attempt failed.","constraint.validation":"%s","invalid.status":"The user's current routing status does not allow for new assignments.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","feature.not.enabled":"Manual assignment not enabled for queue","invalid.id":"The targeted user ID is missing or invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","assignee.missing.any.division.permissions":"Assignee does not have permissions assigned in the division","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","assignee.missing.any.permissions":"Assignee does not have permissions assigned","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Workitem not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:pull","workitems:workitem:assign"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemAssignment"}},"/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel":{"post":{"tags":["Task Management"],"summary":"Cancel the assignment process for a workitem that is currently queued for assignment through ACD.","description":"","operationId":"postTaskmanagementWorkitemAcdCancel","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workitem"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.assign.state.cannot.be.set":"Assignment state cannot be set.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.assignment.state.transition":"Invalid assignment state transition."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:cancelRouting"]},"x-purecloud-method-name":"postTaskmanagementWorkitemAcdCancel"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}":{"get":{"tags":["Task Management"],"summary":"Get a schema","description":"","operationId":"getTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchema"},"put":{"tags":["Task Management"],"summary":"Update a schema","description":"","operationId":"putTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:edit"]},"x-purecloud-method-name":"putTaskmanagementWorkitemsSchema"},"delete":{"tags":["Task Management"],"summary":"Delete a schema","description":"","operationId":"deleteTaskmanagementWorkitemsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.schema.cannot.be.deleted":"Workitem schema cannot be deleted. There are Worktypes associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorkitemsSchema"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["Task Management"],"summary":"Get a specific version of a schema","description":"","operationId":"getTaskmanagementWorkitemsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemaVersion"}},"/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a schema","description":"","operationId":"getTaskmanagementWorkitemsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemaVersions"}},"/api/v2/taskmanagement/workitems/schemas":{"get":{"tags":["Task Management"],"summary":"Get a list of schemas.","description":"","operationId":"getTaskmanagementWorkitemsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemsSchemas"},"post":{"tags":["Task Management"],"summary":"Create a schema","description":"","operationId":"postTaskmanagementWorkitemsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","constraint.validation":"%s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitemSchema:add"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsSchemas"}},"/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups":{"get":{"tags":["Task Management"],"summary":"Get all wrapup codes added for the given user for a workitem.","description":"","operationId":"getTaskmanagementWorkitemUserWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["wrapupCode"]},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup view permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemUserWrapups"},"patch":{"tags":["Task Management"],"summary":"Add/Remove a wrapup code for a given user in a workitem.","description":"","operationId":"patchTaskmanagementWorkitemUserWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to add/remove a wrapup code for a workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemWrapupUpdate"}},{"name":"userId","in":"path","description":"The ID of the user","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Wrapup code did not pass validation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","wrapup.action.required":"The request body is missing the action property","invalid.value":"Invalid value for action is provided.","validation.failure":"The json request body is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup edit permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.not.found":"Wrapup code not found","wrapup.deleted":"Wrapup code has been deleted","user.not.found":"User not found","workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","wrapup.max.count.per.user":"Maximum wrap-up count is reached.","wrapup.already.added":"This wrap-up code was already added for this user.","wrapup.not.in.queue":"Wrap-up code is not configured in the queue.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","wrapup.cannot.be.added.or.removed":"A terminated workitem cannot have wrap-up codes applied or removed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemUserWrapups"}},"/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups":{"patch":{"tags":["Task Management"],"summary":"Add/Remove a wrapup code for the current user in a workitem.","description":"","operationId":"patchTaskmanagementWorkitemUsersMeWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to add/remove the wrapup code for workitem","required":true,"schema":{"$ref":"#/definitions/WorkitemWrapupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.limit.workitem.updates.per.minute.limit.reached":"Reached maximum amount of updates on a single workitem per minute","service.limit.workitem.updates.per.day.limit.reached":"Reached maximum amount of updates on a single workitem per day","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Wrapup did not pass validation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","service.limit.per.day.maximum.updated.limit.reached":"Reached maximum amount of workitems updated per day","db.transaction.cancelled":"Database transaction was cancelled.","wrapup.action.required":"The request body is missing the action property","invalid.value":"Invalid value for action is provided.","validation.failure":"The json request body is not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup edit permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.not.found":"Wrapup code not found","wrapup.deleted":"Wrapup code has been deleted","user.not.found":"User not found","workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","wrapup.max.count.per.user":"Maximum wrap-up count is reached.","wrapup.already.added":"This wrap-up code was already added for this user.","wrapup.not.in.queue":"Wrap-up code is not configured in the queue.","wrapup.no.queue":"There is no queue for the workitem or its worktype.","wrapup.cannot.be.added.or.removed":"A terminated workitem cannot have wrapup codes applied or removed"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapupSelf:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorkitemUsersMeWrapups"}},"/api/v2/taskmanagement/workitems/{workitemId}/wrapups":{"get":{"tags":["Task Management"],"summary":"Get all wrapup codes added for all users for a workitem.","description":"","operationId":"getTaskmanagementWorkitemWrapups","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"The ID of the Workitem.","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["wrapupCode"]},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemWrapupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the wrapup view permission ","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"workitem.not.found":"Workitem not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:wrapup:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemWrapups"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}":{"get":{"tags":["Task Management"],"summary":"Get a status","description":"","operationId":"getTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeStatus"},"delete":{"tags":["Task Management"],"summary":"Delete a status","description":"","operationId":"deleteTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.status.is.default.status":"The status is the Worktype's default status.","pre.check.worktype.being.used":"Worktype is in use.","pre.check.status.is.destination":"The status is a destination status.","pre.check.status.is.default.destination":"The status is a default destination of another status."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeStatus"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a status","description":"","operationId":"patchTaskmanagementWorktypeStatus","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"statusId","in":"path","description":"Status id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkitemStatusUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.int.value.too.high":"Integer too high.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.duplicate.status.name":"Duplicate status name.","invalid.input.transition.delay.too.low":"Transition delay too low.","invalid.input.empty.value":"Empty value.","invalid.input.transition.delay.too.high":"Transition delay too high.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.wrong.time.format":"Wrong time format.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.duplicate.destinations":"Duplicate destinations.","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.input.status.itself.as.destination":"Cannot have itself as destination.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.destinations.without.default.destination":"Destinations list does not contain the default destination.","invalid.input.destination.does.not.exist":"Destination does not exist.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.input.missing.transition.delay":"Missing transition delay."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype or Status not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeStatus"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/statuses":{"get":{"tags":["Task Management"],"summary":"Get list of statuses for this worktype.","description":"","operationId":"getTaskmanagementWorktypeStatuses","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatusListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.invalid.path.id":"Invalid UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeStatuses"},"post":{"tags":["Task Management"],"summary":"Add a status to a worktype","description":"","operationId":"postTaskmanagementWorktypeStatuses","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkitemStatusCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemStatus"}},"201":{"description":"Workitem status created.","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","invalid.input.invalid.category":"Invalid category.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.duplicate.status.name":"Duplicate status name.","invalid.input.transition.delay.too.low":"Transition delay too low.","invalid.input.empty.value":"Empty value.","invalid.input.transition.delay.too.high":"Transition delay too high.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.input.wrong.time.format":"Wrong time format.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.duplicate.destinations":"Duplicate destinations.","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.destination.does.not.exist":"Destination does not exist.","invalid.input.limit.reached":"Limit reached for number of statuses.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.input.missing.transition.delay":"Missing transition delay."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:status:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeStatuses"}},"/api/v2/taskmanagement/worktypes/query":{"post":{"tags":["Task Management"],"summary":"Query for worktypes","description":"","operationId":"postTaskmanagementWorktypesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"QueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorktypeQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","invalid.input.int.value.too.low":"Page size too small.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","workitem.missing.any.division.permissions":"User has no permission access to the division.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"postTaskmanagementWorktypesQuery"}},"/api/v2/taskmanagement/worktypes/{worktypeId}":{"get":{"tags":["Task Management"],"summary":"Get a worktype","description":"","operationId":"getTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"expands","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["defaultQueue","defaultSkills","defaultLanguage","schema"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktype"},"delete":{"tags":["Task Management"],"summary":"Delete a worktype","description":"","operationId":"deleteTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.empty.value":"Empty value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.invalid.uuid":"Invalid UUID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Worktype not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.worktype.being.used":"Worktype still has Workitems associated to it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktype"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a worktype","description":"","operationId":"patchTaskmanagementWorktype","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorktypeUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.no.attribute.to.update":"No attributes to update.","invalid.input.int.value.too.high":"Integer too high.","invalid.input.attr.not.updatable":"Attribute not updatable.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.default.queue.required":"Default Queue ID cannot be null if Assignment is enabled.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","db.transaction.cancelled":"Database transaction was cancelled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.status.not.in.status.list":"Status not in status list.","invalid.input.no.change":"No changes found in request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.schema.cannot.change":"Schema cannot be changed.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","worktype.queue.division.mismatch":"Worktype must be in the same division as the default queue.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","workitem.schema.not.updatable":"The schemaId of a worktype cannot be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","not.found":"The requested resource was not found.","not.found.error":"Worktype or Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.worktype.workbin.division.mismatch":"A Worktype and its default Workbin must belong to the same division.","pre.check.name.in.use":"Name is already in use.","pre.check.value.greater.than":"Due duration greater than expiration or expiration greater than TTL."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["workitems:worktype:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktype"}},"/api/v2/taskmanagement/worktypes":{"post":{"tags":["Task Management"],"summary":"Create a worktype","description":"","operationId":"postTaskmanagementWorktypes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorktypeCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Worktype"}},"201":{"description":"Worktype created.","schema":{"$ref":"#/definitions/Worktype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Integer too high.","workitem.default.workbin.required":"A defaultWorkbinId is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.input.default.queue.required":"Default Queue ID cannot be null if Assignment is enabled.","invalid.property":"Value [%s] is not a valid property for object [%s]","workitem.division.mismatch":"Worktype must be in the same division as its default Workbin.","constraint.validation":"%s","invalid.input.string.value.too.short":"String too short.","invalid.input.string.value.too.long":"String too long.","invalid.input.empty.value":"Empty value.","invalid.input.int.value.too.low":"Integer too low.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","worktype.queue.division.mismatch":"Worktype must be in the same division as the default queue.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.input.list.value.too.long":"List too long.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"Skill IDs do not exist","not.found":"The requested resource was not found.","not.found.error":"Default Workbin not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.name.in.use":"Name is already in use.","pre.check.value.greater.than":"Due duration greater than expiration or expiration greater than TTL.","pre.check.maximum.limit.reached":"Maximum number of Worktypes reached."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypes"}},"/api/v2/analytics/actions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for action aggregates asynchronously","description":"","operationId":"postAnalyticsActionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ActionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"postAnalyticsActionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/actions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for action aggregates","description":"","operationId":"getAnalyticsActionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getAnalyticsActionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/actions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsActionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getAnalyticsActionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for agent copilot aggregates","description":"","operationId":"getAnalyticsAgentcopilotsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:agentCopilotAggregate:view"]},"x-purecloud-method-name":"getAnalyticsAgentcopilotsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsAgentcopilotsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentCopilotAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:agentCopilotAggregate:view"]},"x-purecloud-method-name":"getAnalyticsAgentcopilotsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/agentcopilots/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for agent copilot aggregates","description":"","operationId":"postAnalyticsAgentcopilotsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AgentCopilotAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentCopilotAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:agentCopilotAggregate:view"]},"x-purecloud-method-name":"postAnalyticsAgentcopilotsAggregatesQuery","x-genesys-preview":true}},"/api/v2/analytics/agentcopilots/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for agent copilot aggregates asynchronously","description":"","operationId":"postAnalyticsAgentcopilotsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AgentCopilotAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:agentCopilotAggregate:view"]},"x-purecloud-method-name":"postAnalyticsAgentcopilotsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for bot aggregates asynchronously","description":"","operationId":"postAnalyticsBotsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/BotAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"postAnalyticsBotsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for bot aggregates","description":"","operationId":"getAnalyticsBotsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"getAnalyticsBotsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/bots/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsBotsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BotAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:botAggregate:view"]},"x-purecloud-method-name":"getAnalyticsBotsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Conversations"],"summary":"Get status for async query for conversation aggregates","description":"","operationId":"getAnalyticsConversationsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsConversationsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs":{"post":{"tags":["Analytics","Conversations"],"summary":"Query for conversation aggregates asynchronously","description":"","operationId":"postAnalyticsConversationsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Conversations"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsConversationsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsConversationsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Quality"],"summary":"Get status for async query for evaluation aggregates","description":"","operationId":"getAnalyticsEvaluationsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsEvaluationsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Quality"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsEvaluationsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"getAnalyticsEvaluationsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/evaluations/aggregates/jobs":{"post":{"tags":["Analytics","Quality"],"summary":"Query for evaluation aggregates asynchronously","description":"","operationId":"postAnalyticsEvaluationsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for flow execution aggregates asynchronously","description":"","operationId":"postAnalyticsFlowexecutionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowExecutionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowexecutionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for flow execution aggregates","description":"","operationId":"getAnalyticsFlowexecutionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowexecutionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsFlowexecutionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowExecutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowexecutionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs":{"post":{"tags":["Analytics","Flows"],"summary":"Query for flow aggregates asynchronously","description":"","operationId":"postAnalyticsFlowsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Flows"],"summary":"Get status for async query for Flow aggregates","description":"","operationId":"getAnalyticsFlowsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/flows/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Flows"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsFlowsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"getAnalyticsFlowsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs":{"post":{"tags":["Analytics","Journey"],"summary":"Query for journey aggregates asynchronously","description":"","operationId":"postAnalyticsJourneysAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Journey"],"summary":"Get status for async query for journey aggregates","description":"","operationId":"getAnalyticsJourneysAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsJourneysAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Journey"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsJourneysAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsJourneysAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsKnowledgeAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"getAnalyticsKnowledgeAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for knowledge aggregates asynchronously","description":"","operationId":"postAnalyticsKnowledgeAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/KnowledgeAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"postAnalyticsKnowledgeAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/knowledge/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for knowledge aggregates","description":"","operationId":"getAnalyticsKnowledgeAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:knowledgeAggregate:view"]},"x-purecloud-method-name":"getAnalyticsKnowledgeAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for resolution aggregates","description":"","operationId":"getAnalyticsResolutionsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsResolutionsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsResolutionsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResolutionAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"getAnalyticsResolutionsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/resolutions/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for resolution aggregates asynchronously","description":"","operationId":"postAnalyticsResolutionsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ResolutionAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:resolutionAggregate:view"]},"x-purecloud-method-name":"postAnalyticsResolutionsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs":{"post":{"tags":["Analytics","Quality"],"summary":"Query for survey aggregates asynchronously","description":"","operationId":"postAnalyticsSurveysAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Quality"],"summary":"Get status for async query for survey aggregates","description":"","operationId":"getAnalyticsSurveysAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsSurveysAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Quality"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsSurveysAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"getAnalyticsSurveysAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for task management aggregates","description":"","operationId":"postAnalyticsTaskmanagementAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TaskManagementAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TaskManagementAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"postAnalyticsTaskmanagementAggregatesQuery","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for task management aggregates asynchronously","description":"","operationId":"postAnalyticsTaskmanagementAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TaskManagementAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"postAnalyticsTaskmanagementAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for task management aggregates","description":"","operationId":"getAnalyticsTaskmanagementAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"getAnalyticsTaskmanagementAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async task management query","description":"","operationId":"getAnalyticsTaskmanagementAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TaskManagementAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:taskManagementAggregate:view"]},"x-purecloud-method-name":"getAnalyticsTaskmanagementAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates asynchronously","description":"","operationId":"postAnalyticsTranscriptsAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesJobs","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics"],"summary":"Get status for async query for transcript aggregates","description":"","operationId":"getAnalyticsTranscriptsAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"getAnalyticsTranscriptsAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsTranscriptsAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"getAnalyticsTranscriptsAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs/{jobId}":{"get":{"tags":["Analytics","Users"],"summary":"Get status for async query for user aggregates","description":"","operationId":"getAnalyticsUsersAggregatesJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"getAnalyticsUsersAggregatesJob","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs/{jobId}/results":{"get":{"tags":["Analytics","Users"],"summary":"Fetch a page of results for an async aggregates query","description":"","operationId":"getAnalyticsUsersAggregatesJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor token to retrieve next page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAsyncAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"getAnalyticsUsersAggregatesJobResults","x-genesys-preview":true}},"/api/v2/analytics/users/aggregates/jobs":{"post":{"tags":["Analytics","Users"],"summary":"Query for user aggregates asynchronously","description":"","operationId":"postAnalyticsUsersAggregatesJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAsyncAggregationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesJobs","x-genesys-preview":true}},"/api/v2/chats/users/{userId}":{"get":{"tags":["Chat"],"summary":"Get information for a 1on1","description":"","operationId":"getChatsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneOnOne"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:view"]},"x-purecloud-method-name":"getChatsUser","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/messages/pins":{"post":{"tags":["Chat"],"summary":"Add pinned messages for a 1on1, up to a maximum of 5 pinned messages","description":"","operationId":"postChatsUserMessagesPins","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"in":"body","name":"body","description":"Pinned Message Ids","required":true,"schema":{"$ref":"#/definitions/PinnedMessageRequest"}}],"responses":{"204":{"description":"Pinned messages added successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:edit"]},"x-purecloud-method-name":"postChatsUserMessagesPins","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}":{"delete":{"tags":["Chat"],"summary":"Remove a pinned message from a 1on1","description":"","operationId":"deleteChatsUserMessagesPin","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"pinnedMessageId","in":"path","description":"pinnedMessageId","required":true,"type":"string"}],"responses":{"204":{"description":"Pinned message removed successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:chat:access","chat:1on1:edit"]},"x-purecloud-method-name":"deleteChatsUserMessagesPin","x-genesys-preview":true}},"/api/v2/conversations/{conversationId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a conversation creating a barged in conference of connected participants.","description":"","operationId":"postConversationBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationBarge","x-genesys-preview":true}},"/api/v2/conversations/{conversationId}/utilizationlabel":{"patch":{"tags":["Conversations"],"summary":"Update the utilization label on a conversation. When there is no value provided, the system default label is applied","description":"","operationId":"patchConversationUtilizationlabel","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation Utilization Label","required":true,"schema":{"$ref":"#/definitions/ConversationUtilizationLabelUpdate"}}],"responses":{"202":{"description":"The utilization label update request was accepted.","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","utilization.label.id.not.found":"Utilization label id was not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:utilizationLabel:edit"]},"x-purecloud-method-name":"patchConversationUtilizationlabel","x-genesys-preview":true}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge":{"post":{"tags":["Conversations"],"summary":"Barge a given participant's call creating a barged in conference of connected participants.","description":"","operationId":"postConversationsCallParticipantBarge","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.barge.not.consult.initiator":"A user cannot barge a consult transfer party that is not the initiator.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","conversation.error.multiple.barges":"A user cannot barge a participant that is already being barged.","conversation.error.barge.conference":"A participant cannot be barged when conversation is a conference.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:barge"]},"x-purecloud-method-name":"postConversationsCallParticipantBarge","x-genesys-preview":true}},"/api/v2/conversations/videos/meetings/{meetingId}":{"get":{"tags":["Conversations"],"summary":"Gets a record for a given meetingId","description":"","operationId":"getConversationsVideosMeeting","produces":["application/json"],"parameters":[{"name":"meetingId","in":"path","description":"meetingId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MeetingIdRecord"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"getConversationsVideosMeeting","x-genesys-preview":true}},"/api/v2/conversations/videos/meetings":{"post":{"tags":["Conversations"],"summary":"Generate a meetingId for a given conferenceId","description":"","operationId":"postConversationsVideosMeetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"MeetingIdRequest","required":true,"schema":{"$ref":"#/definitions/GenerateMeetingIdRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MeetingIdRecord"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"postConversationsVideosMeetings","x-genesys-preview":true}},"/api/v2/conversations/videos/{conferenceId}/details":{"get":{"tags":["Conversations"],"summary":"Get video conference details (e.g. the current number of active participants).","description":"","operationId":"getConversationsVideoDetails","produces":["application/json"],"parameters":[{"name":"conferenceId","in":"path","description":"conferenceId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VideoConferenceDetails"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.conference.not.found":"The conference does not exist."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["video:video:access"]},"x-purecloud-method-name":"getConversationsVideoDetails","x-genesys-preview":true}},"/api/v2/flows/instances/settings/executiondata":{"get":{"tags":["Architect"],"summary":"Get the execution history enabled setting.","description":"Get the execution history enabled setting.","operationId":"getFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsExecutiondata","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Edit the execution history enabled setting.","description":"Edit the execution history enabled setting.","operationId":"patchFlowsInstancesSettingsExecutiondata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"New Execution Data Setting","required":true,"schema":{"$ref":"#/definitions/ExecutionDataSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataFlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowinstanceexecutiondata:edit"]},"x-purecloud-method-name":"patchFlowsInstancesSettingsExecutiondata","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels/default":{"get":{"tags":["Architect"],"summary":"Returns the flow default log level.","description":"Returns the flow default log level which will be used if no specific flow id log level is found.","operationId":"getFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true},"put":{"tags":["Architect"],"summary":"Edit the flow default log level.","description":"Edit the flow default log level.","operationId":"putFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:edit"]},"x-purecloud-method-name":"putFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Resets the org log level to default, base","description":"Resets the org log level to default, base","operationId":"deleteFlowsInstancesSettingsLoglevelsDefault","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevelDefault:delete"]},"x-purecloud-method-name":"deleteFlowsInstancesSettingsLoglevelsDefault","x-genesys-preview":true}},"/api/v2/flows/{flowId}/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieves the log level for a flow by flow id.","description":"Retrieves the log level for a flow by flow id.","operationId":"getFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to get the loglevel for","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view"]},"x-purecloud-method-name":"getFlowInstancesSettingsLoglevels","x-genesys-preview":true},"post":{"tags":["Architect"],"summary":"Set the logLevel for a particular flow id","description":"Assigns a new loglevel to a flow id","operationId":"postFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to set the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:add"]},"x-purecloud-method-name":"postFlowInstancesSettingsLoglevels","x-genesys-preview":true},"put":{"tags":["Architect"],"summary":"Edit the logLevel for a particular flow id","description":"Updates the loglevel for a flow id","operationId":"putFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"flowId","in":"path","description":"The flow id to edit the loglevel for","required":true,"type":"string"},{"in":"body","name":"body","description":"New LogLevel settings","required":true,"schema":{"$ref":"#/definitions/FlowLogLevelRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:edit"]},"x-purecloud-method-name":"putFlowInstancesSettingsLoglevels","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Deletes a log level for a flow by flow id.","description":"Deletes the associated log level for a flow by flow id","operationId":"deleteFlowInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"The flow id to delete the loglevel for","required":true,"type":"string"}],"responses":{"204":{"description":"The loglevel was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:delete"]},"x-purecloud-method-name":"deleteFlowInstancesSettingsLoglevels","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels/characteristics":{"get":{"tags":["Architect"],"summary":"Gets the available flow log level characteristics for this organization.","description":"Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.","operationId":"getFlowsInstancesSettingsLoglevelsCharacteristics","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowLogLevelCharacteristicsDefinitions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowLogLevel:view","architect:flowLogLevelDefault:view"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevelsCharacteristics","x-genesys-preview":true}},"/api/v2/flows/instances/settings/loglevels":{"get":{"tags":["Architect"],"summary":"Retrieve a list of LogLevels for the organization.","description":"Returns a paged set of LogLevels per flow id","operationId":"getFlowsInstancesSettingsLoglevels","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"array","items":{"type":"string","enum":["name","type","logLevelCharacteristics.characteristics"]},"collectionFormat":"multi"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowSettingsResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowLogLevel:view","architect:flow:search"]},"x-purecloud-method-name":"getFlowsInstancesSettingsLoglevels","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/draft/function":{"get":{"tags":["Integrations"],"summary":"Get draft function settings for Action","description":"","operationId":"getIntegrationsActionDraftFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftFunction","x-genesys-preview":true},"put":{"tags":["Integrations"],"summary":"Update draft function settings.","description":"","operationId":"putIntegrationsActionDraftFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to update function settings.","required":true,"schema":{"$ref":"#/definitions/Function"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:edit"]},"x-purecloud-method-name":"putIntegrationsActionDraftFunction","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/draft/function/upload":{"post":{"tags":["Uploads","Integrations"],"summary":"Create upload presigned URL for draft function package file.","description":"","operationId":"postIntegrationsActionDraftFunctionUpload","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to request URL upload.","required":true,"schema":{"$ref":"#/definitions/FunctionUploadRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftFunctionUpload","x-genesys-preview":true}},"/api/v2/integrations/actions/{actionId}/function":{"get":{"tags":["Integrations"],"summary":"Get published function settings for Action","description":"","operationId":"getIntegrationsActionFunction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FunctionConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionFunction","x-genesys-preview":true}},"/api/v2/integrations/actions/functions/runtimes":{"get":{"tags":["Integrations"],"summary":"Get action function settings for Action","description":"","operationId":"getIntegrationsActionsFunctionsRuntimes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/FunctionRuntime"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:actionFunction:view"]},"x-purecloud-method-name":"getIntegrationsActionsFunctionsRuntimes","x-genesys-preview":true}},"/api/v2/chats/users/me/settings":{"get":{"tags":["Chat"],"summary":"Get a user's chat settings","description":"","operationId":"getChatsUsersMeSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getChatsUsersMeSettings","x-genesys-preview":true},"patch":{"tags":["Chat"],"summary":"Update a user's chat settings","description":"","operationId":"patchChatsUsersMeSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ChatUserSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-purecloud-method-name":"patchChatsUsersMeSettings","x-genesys-preview":true}},"/api/v2/chats/users/{userId}/settings":{"get":{"tags":["Chat"],"summary":"Get a user's chat settings","description":"","operationId":"getChatsUserSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:usersettings:view","chat:setting:view"]},"x-purecloud-method-name":"getChatsUserSettings","x-genesys-preview":true},"patch":{"tags":["Chat"],"summary":"Update a user's chat settings","description":"","operationId":"patchChatsUserSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ChatUserSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatUserSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:usersettings:edit","chat:setting:edit"]},"x-purecloud-method-name":"patchChatsUserSettings","x-genesys-preview":true}},"/api/v2/journey/sessions/{sessionId}/events":{"get":{"tags":["Journey"],"summary":"Retrieve all events for a given session.","description":"","operationId":"getJourneySessionEvents","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"System-generated UUID that represents the session the event is a part of.","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:event:view"]},"x-purecloud-method-name":"getJourneySessionEvents","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs":{"post":{"tags":["Journey"],"summary":"Create Outcome Attributions","description":"","operationId":"postJourneyOutcomesAttributionsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outcome attribution request","required":false,"schema":{"$ref":"#/definitions/OutcomeAttributionListing"}}],"responses":{"202":{"description":"Accepted - Running job asynchronously","schema":{"$ref":"#/definitions/OutcomeAttributionAsyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcomeAttributionJob:add"]},"x-purecloud-method-name":"postJourneyOutcomesAttributionsJobs","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get job status.","description":"","operationId":"getJourneyOutcomesAttributionsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeAttributionJobStateResponse"}},"202":{"description":"Accepted - Running job asynchronously","schema":{"$ref":"#/definitions/OutcomeAttributionJobStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:outcomeAttributionJob:view"]},"x-purecloud-method-name":"getJourneyOutcomesAttributionsJob","x-genesys-preview":true}},"/api/v2/journey/outcomes/attributions/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get outcome attribution entities from completed job.","description":"","operationId":"getJourneyOutcomesAttributionsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"ID of the job.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeAttributionResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unprocessable.entity":"Request body contains validation errors"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:outcomeAttribution:view"]},"x-purecloud-method-name":"getJourneyOutcomesAttributionsJobResults","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}":{"get":{"tags":["Journey"],"summary":"Get a Journey View by ID","description":"returns the latest version","operationId":"getJourneyView","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyView","x-genesys-preview":true},"delete":{"tags":["Journey"],"summary":"Delete a Journey View by ID","description":"deletes all versions","operationId":"deleteJourneyView","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:delete"]},"x-purecloud-method-name":"deleteJourneyView","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{versionId}":{"get":{"tags":["Journey"],"summary":"Get a Journey View by ID and version","description":"","operationId":"getJourneyViewVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"versionId","in":"path","description":"versionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersion","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions":{"post":{"tags":["Journey"],"summary":"Update a Journey View by ID","description":"creates a new version","operationId":"postJourneyViewVersions","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"in":"body","name":"body","description":"JourneyView","required":true,"schema":{"$ref":"#/definitions/JourneyView"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"postJourneyViewVersions","x-genesys-preview":true}},"/api/v2/journey/views":{"get":{"tags":["Journey"],"summary":"Get a list of Journey Views","description":"","operationId":"getJourneyViews","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViews","x-genesys-preview":true},"post":{"tags":["Journey"],"summary":"Create a new Journey View","description":"","operationId":"postJourneyViews","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"JourneyView","required":true,"schema":{"$ref":"#/definitions/JourneyView"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:add"]},"x-purecloud-method-name":"postJourneyViews","x-genesys-preview":true}},"/api/v2/journey/views/encodings/validate":{"post":{"tags":["Journey"],"summary":"Validate whether an encoding exist for a label/value combination.","description":"True indicates a valid encoding","operationId":"postJourneyViewsEncodingsValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"type":"array","items":{"$ref":"#/definitions/Label"}}}],"responses":{"200":{"description":"Execution submitted successfully.","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsEncodings:view"]},"x-purecloud-method-name":"postJourneyViewsEncodingsValidate","x-genesys-preview":true}},"/api/v2/journey/views/eventdefinitions/{eventDefinitionId}":{"get":{"tags":["Journey"],"summary":"Get an Event Definition","description":"","operationId":"getJourneyViewsEventdefinition","produces":["application/json"],"parameters":[{"name":"eventDefinitionId","in":"path","description":"Event Definition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyEventDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:eventDefinition:view"]},"x-purecloud-method-name":"getJourneyViewsEventdefinition","x-genesys-preview":true}},"/api/v2/journey/views/eventdefinitions":{"get":{"tags":["Journey"],"summary":"Get a list of Event Definitions","description":"","operationId":"getJourneyViewsEventdefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyEventDefinitionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:eventDefinition:view"]},"x-purecloud-method-name":"getJourneyViewsEventdefinitions","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest":{"get":{"tags":["Journey"],"summary":"Get the latest job of a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJobsLatest","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:view"]},"x-purecloud-method-name":"getJourneyViewVersionJobsLatest","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get the job for a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJob","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"jobId","in":"path","description":"JobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","custom.bad.request":"The request could not be understood by the server due to malformed syntax.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:view"]},"x-purecloud-method-name":"getJourneyViewVersionJob","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs":{"post":{"tags":["Journey"],"summary":"Submit a job request for a journey view version.","description":"used for long descriptions","operationId":"postJourneyViewVersionJobs","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"name":"journeyVersionId","in":"path","description":"Journey View Version","required":true,"type":"string"}],"responses":{"202":{"description":"Job submitted successfully.","schema":{"$ref":"#/definitions/JourneyViewJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.conflicting.request":"Job is already running for this version of the journey view"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsJobs:add"]},"x-purecloud-method-name":"postJourneyViewVersionJobs","x-genesys-preview":true}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results":{"get":{"tags":["Journey"],"summary":"Get the result of a job for a journey view version.","description":"used for long descriptions","operationId":"getJourneyViewVersionJobResults","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"JourneyViewResult id","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Id of the executing job","required":true,"type":"string"}],"responses":{"200":{"description":"Result received successfully","schema":{"$ref":"#/definitions/JourneyViewResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.resource.not.found":"Resource Not Found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:viewsResults:view"]},"x-purecloud-method-name":"getJourneyViewVersionJobResults","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads":{"post":{"tags":["Knowledge"],"summary":"Upload Article Content","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocumentUploads","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocumentUploads","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}/uploads/{uploadId}":{"get":{"tags":["Knowledge"],"summary":"Get document content upload status","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocumentUpload","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},{"name":"uploadId","in":"path","description":"UploadId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentContentUpload"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","input.validations":"Input parameters do not match the required criteria","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operation.not.found":"Upload does not exist","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist","document.not.found":"Document does not exist"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocumentUpload","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}":{"get":{"tags":["Knowledge","Uploads"],"summary":"Get content upload from URL job status","description":"","operationId":"getKnowledgeKnowledgebaseUploadsUrlsJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Upload job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Content upload job status","schema":{"$ref":"#/definitions/GetUploadSourceUrlJobStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:uploadSourceUrlJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseUploadsUrlsJob","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs":{"post":{"tags":["Knowledge","Uploads"],"summary":"Create content upload from URL job","description":"","operationId":"postKnowledgeKnowledgebaseUploadsUrlsJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"uploadRequest","required":true,"schema":{"$ref":"#/definitions/CreateUploadSourceUrlJobRequest"}}],"responses":{"202":{"description":"Content upload in progress","schema":{"$ref":"#/definitions/CreateUploadSourceUrlJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"limit.reached":"Daily or monthly limit reached"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:uploadSourceUrlJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseUploadsUrlsJobs","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove":{"post":{"tags":["Knowledge"],"summary":"Bulk remove documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsBulkRemove","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkRemoveRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsBulkRemove","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update":{"post":{"tags":["Knowledge"],"summary":"Bulk update documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsBulkUpdate","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsBulkUpdate","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add":{"post":{"tags":["Knowledge"],"summary":"Bulk add document versions.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentBulkVersionAddRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:documentVersion:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query":{"get":{"tags":["Knowledge"],"summary":"Get ids of operation creator users and oauth clients","description":"","operationId":"getKnowledgeKnowledgebaseOperationsUsersQuery","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OperationCreatorUserResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importExportOperationsList:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseOperationsUsersQuery","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations":{"get":{"tags":["Knowledge"],"summary":"Get operations","description":"","operationId":"getKnowledgeKnowledgebaseOperations","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"userId","in":"query","description":"If specified, retrieves operations associated with user ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"If specified, retrieves operations with specified operation type, comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["Export","Import","Parse","Sync"]},"collectionFormat":"multi"},{"name":"status","in":"query","description":"If specified, retrieves operations with specified operation status, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ","required":false,"type":"string","format":"interval"},{"name":"sourceId","in":"query","description":"If specified, retrieves operations associated with source ids, comma separated values expected.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OperationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importExportOperationsList:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseOperations","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import":{"post":{"tags":["Knowledge"],"summary":"Import the parsed articles","description":"","operationId":"postKnowledgeKnowledgebaseParseJobImport","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequestImport"}}],"responses":{"204":{"description":"Parsed import job in progress"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseParseJobImport","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}":{"get":{"tags":["Knowledge"],"summary":"Get parse job report","description":"","operationId":"getKnowledgeKnowledgebaseParseJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.","required":false,"type":"array","items":{"type":"string","enum":["urls"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Parse job is done","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"202":{"description":"Parse job in progress","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseParseJob","x-genesys-preview":true},"patch":{"tags":["Knowledge"],"summary":"Send update to the parse operation","description":"","operationId":"patchKnowledgeKnowledgebaseParseJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"parseJobId","in":"path","description":"Parse job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequestPatch"}}],"responses":{"204":{"description":"Override saved"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseParseJob","x-genesys-preview":true}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs":{"post":{"tags":["Knowledge"],"summary":"Create parse job","description":"","operationId":"postKnowledgeKnowledgebaseParseJobs","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeParseJobRequest"}}],"responses":{"202":{"description":"Parse job in progress","schema":{"$ref":"#/definitions/KnowledgeParseJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"knowledgebase.not.found":"Knowledge Base does not exist","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:importJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseParseJobs","x-genesys-preview":true}},"/api/v2/languageunderstanding/settings":{"get":{"tags":["Language Understanding"],"summary":"Get Organization Configuration","description":"","operationId":"getLanguageunderstandingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:settings:view"]},"x-purecloud-method-name":"getLanguageunderstandingSettings","x-genesys-preview":true}},"/api/v2/documentation/all/search":{"post":{"tags":["Search"],"summary":"Search all documents","description":"","operationId":"postDocumentationAllSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationV2SearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationAllSearch","x-genesys-preview":true}},"/api/v2/routing/utilization/tags/{tagId}":{"get":{"tags":["Routing"],"summary":"Get details about this utilization tag","description":"","operationId":"getRoutingUtilizationTag","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTag","x-genesys-preview":true},"delete":{"tags":["Routing"],"summary":"Delete an utilization tag","description":"","operationId":"deleteRoutingUtilizationTag","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Remove all tag usages (if found) without warning","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.utilization.tag":"Utilization tag cannot be deleted due to its usage in max utilization."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilizationTag","x-genesys-preview":true}},"/api/v2/routing/utilization/tags/{tagId}/agents":{"get":{"tags":["Routing"],"summary":"Get list of agent ids associated with a utilization tag","description":"","operationId":"getRoutingUtilizationTagAgents","produces":["application/json"],"parameters":[{"name":"tagId","in":"path","description":"Utilization Tag ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTagAgents","x-genesys-preview":true}},"/api/v2/routing/utilization/tags":{"get":{"tags":["Routing"],"summary":"Get list of utilization tags","description":"","operationId":"getRoutingUtilizationTags","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order by name","required":false,"type":"string","default":"ascending","enum":["ascending","descending"]},{"name":"name","in":"query","description":"Utilization tag's name (Wildcard is supported, e.g., 'tag1*')","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTagEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilizationTags","x-genesys-preview":true},"post":{"tags":["Routing"],"summary":"Create an utilization tag","description":"","operationId":"postRoutingUtilizationTags","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UtilizationTag","required":true,"schema":{"$ref":"#/definitions/CreateUtilizationTagRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UtilizationTag"}},"201":{"description":"Utilization tag created.","schema":{"$ref":"#/definitions/UtilizationTag"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid utilization code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"An utilization tag with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.utilization.tag":"Invalid utilization tag request.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"postRoutingUtilizationTags","x-genesys-preview":true}},"/api/v2/routing/sms/phonenumbers/alphanumeric":{"post":{"tags":["Routing"],"summary":"Provision an alphanumeric number for SMS","description":"","operationId":"postRoutingSmsPhonenumbersAlphanumeric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsAlphanumericProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"202":{"description":"Accepted - the phone number create is in progress.","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.phone.number":"The address is invalid.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","phone.number.duplicate":"Phone number has already been created.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"provisioning.action.in.progress":"A provisioning action is already in progress for this phone number"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbersAlphanumeric","x-genesys-preview":true}},"/api/v2/groups/dynamicsettings/preview":{"post":{"tags":["Groups"],"summary":"Preview the number of users selected for a dynamic group definition query","description":"","operationId":"postGroupsDynamicsettingsPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group query to preview","required":true,"schema":{"$ref":"#/definitions/DynamicGroupQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DynamicGroupQueryPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:view"]},"x-purecloud-method-name":"postGroupsDynamicsettingsPreview","x-genesys-preview":true}},"/api/v2/groups/{groupId}/dynamicsettings":{"get":{"tags":["Groups"],"summary":"Get dynamic group definition","description":"","operationId":"getGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DynamicGroupDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:view"]},"x-purecloud-method-name":"getGroupDynamicsettings","x-genesys-preview":true},"put":{"tags":["Groups"],"summary":"Create / Update dynamic group definition","description":"","operationId":"putGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Create/Update dynamic groups","required":true,"schema":{"$ref":"#/definitions/DynamicGroupQuery"}}],"responses":{"204":{"description":"Success, dynamic group was updated"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","general.bad.request":"Provided request is not valid","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroupDynamicsettings","x-genesys-preview":true},"delete":{"tags":["Groups"],"summary":"Remove dynamic group definition","description":"","operationId":"deleteGroupDynamicsettings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"204":{"description":"Success, dynamic group was removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroupDynamicsettings","x-genesys-preview":true}},"/api/v2/settings/executiondata":{"get":{"tags":["Settings"],"summary":"Get the execution history enabled setting.","description":"Get the execution history enabled setting.","operationId":"getSettingsExecutiondata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataGlobalSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["settings:executiondata:view"]},"x-purecloud-method-name":"getSettingsExecutiondata","x-genesys-preview":true},"patch":{"tags":["Settings"],"summary":"Edit the execution history on off setting.","description":"Edit the execution history on off setting.","operationId":"patchSettingsExecutiondata","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"New Execution Data Setting","required":true,"schema":{"$ref":"#/definitions/ExecutionDataSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExecutionDataGlobalSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["settings:executiondata:edit"]},"x-purecloud-method-name":"patchSettingsExecutiondata","x-genesys-preview":true}},"/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get media endpoint statistics event.","description":"","operationId":"getTelephonyProvidersEdgesMediastatisticsConversationCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Identifier of the conversation","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Identifier of the media session","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaStatistics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMediastatisticsConversationCommunication","x-genesys-preview":true}},"/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get media endpoint statistics events.","description":"","operationId":"getTelephonyProvidersEdgesMediastatisticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Identifier of the conversation","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MediaStatisticsListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMediastatisticsConversation","x-genesys-preview":true}},"/api/v2/users/search/conversation/target":{"post":{"tags":["Users","Search"],"summary":"Search users as conversation targets","description":"","operationId":"postUsersSearchConversationTarget","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:target"]},"x-purecloud-method-name":"postUsersSearchConversationTarget","x-genesys-preview":true}},"/api/v2/users/search/queuemembers/manage":{"post":{"tags":["Users","Search"],"summary":"Search manage queue member","description":"","operationId":"postUsersSearchQueuemembersManage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.search.criteria":"search criteria exceeded limit","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","search.criteria.values.exceed.limit":"search criteria values exceeded limit","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","too.many.requested.results":"too many requested results"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Unable to find any users that match your search criteria"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queueMember:manage","routing:queue:edit"]},"x-purecloud-method-name":"postUsersSearchQueuemembersManage","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice":{"post":{"tags":["Architect"],"summary":"Creates a presigned URL for uploading a grammar voice mode file","description":"","operationId":"postArchitectGrammarLanguageFilesVoice","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/GrammarFileUploadRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguageFilesVoice","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Clear the voice mode file for the grammar language if there is one","description":"","operationId":"deleteArchitectGrammarLanguageFilesVoice","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"File was cleared."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguageFilesVoice","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf":{"post":{"tags":["Architect"],"summary":"Creates a presigned URL for uploading a grammar DTMF mode file","description":"","operationId":"postArchitectGrammarLanguageFilesDtmf","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/GrammarFileUploadRequest"}}],"responses":{"200":{"description":"Presigned URL successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguageFilesDtmf","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Clear the DTMF mode file for the grammar language if there is one","description":"","operationId":"deleteArchitectGrammarLanguageFilesDtmf","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"File was cleared."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguageFilesDtmf","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a grammar language.","description":"","operationId":"getArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammarLanguage","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Delete specified grammar language","description":"","operationId":"deleteArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"deleteArchitectGrammarLanguage","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Updates a grammar language","description":"","operationId":"patchArchitectGrammarLanguage","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/GrammarLanguageUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.language.not.found":"Could not find grammar language.","architect.grammar.not.found":"Could not find grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"patchArchitectGrammarLanguage","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}/languages":{"post":{"tags":["Architect"],"summary":"Create a new language for a given grammar","description":"","operationId":"postArchitectGrammarLanguages","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"Grammar ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/GrammarLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.grammar.language.validate.failed.no.language":"Failed to validate grammar language due to missing or invalid language.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not grammar with specified ID."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.language.already.exists":"Grammar already has the specified language."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"postArchitectGrammarLanguages","x-genesys-preview":true}},"/api/v2/architect/grammars/{grammarId}":{"get":{"tags":["Architect"],"summary":"Get a grammar","description":"Returns a specified grammar","operationId":"getArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"},{"name":"includeFileUrls","in":"query","description":"Include grammar language file URLs","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Specified grammar not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammar","x-genesys-preview":true},"delete":{"tags":["Architect"],"summary":"Delete a grammar.","description":"","operationId":"deleteArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not find the specified grammar."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:delete"]},"x-purecloud-method-name":"deleteArchitectGrammar","x-genesys-preview":true},"patch":{"tags":["Architect"],"summary":"Updates a grammar","description":"","operationId":"patchArchitectGrammar","produces":["application/json"],"parameters":[{"name":"grammarId","in":"path","description":"grammar ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Grammar"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.validate.failed.missing.name":"Failed to validate grammar due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.grammar.validate.failed.invalid.name.no.alpha":"Failed to validate grammar due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","architect.grammar.validate.failed.invalid.name.spaces":"Failed to validate grammar due to invalid name. Names must not contain leading or trailing whitespaces.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.grammar.not.found":"Could not find the specified grammar."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.already.exists":"A grammar with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:edit"]},"x-purecloud-method-name":"patchArchitectGrammar","x-genesys-preview":true}},"/api/v2/architect/grammars":{"get":{"tags":["Architect"],"summary":"Get a pageable list of grammars, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.","operationId":"getArchitectGrammars","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["description","id","name"]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc"]},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"includeFileUrls","in":"query","description":"Include grammar language file URLs","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GrammarListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:view"]},"x-purecloud-method-name":"getArchitectGrammars","x-genesys-preview":true},"post":{"tags":["Architect"],"summary":"Create a new grammar","description":"","operationId":"postArchitectGrammars","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Grammar"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Grammar"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.validate.failed.missing.name":"Failed to validate grammar due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","architect.grammar.validate.failed.name.no.alpha":"Failed to validate grammar due to invalid name. Names must contain at least one alphanumeric character.","invalid.property":"Value [%s] is not a valid property for object [%s]","architect.object.validate.failed":"Failed to validate object.","constraint.validation":"%s","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.grammar.validate.failed.invalid.name":"Failed to validate grammar due to invalid name. grammar names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.grammar.validate.failed":"Failed to validate grammar.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.grammar.exceeded.max.amount":"Could not create grammar since the maximum number of grammars already exist.","architect.grammar.already.exists":"A grammar with the specified name already exists."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:grammar:add"]},"x-purecloud-method-name":"postArchitectGrammars","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a workbin","description":"","operationId":"getTaskmanagementWorkbinVersions","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a workbin","description":"","operationId":"getTaskmanagementWorkbinVersion","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Workbin version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/workbins/{workbinId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a workbin's attribute change history","description":"","operationId":"getTaskmanagementWorkbinHistory","produces":["application/json"],"parameters":[{"name":"workbinId","in":"path","description":"Workbin ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkbinChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workbin:view"]},"x-purecloud-method-name":"getTaskmanagementWorkbinHistory","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/query":{"post":{"tags":["Task Management"],"summary":"Query for workitems","description":"This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.","operationId":"postTaskmanagementWorkitemsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WorkitemQueryPostRequest","required":true,"schema":{"$ref":"#/definitions/WorkitemQueryPostRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemPostQueryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.invalid.base64.string":"Wrong cursor (after key) format","invalid.query.missing.workitem.filter":"Missing mandatory filters","invalid.input.wrong.number.values":"Wrong number of values provided for filter","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.input.wrong.attribute.type":"Wrong attribute type.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.query.missing.filters":"Missing filters.","constraint.validation":"%s","invalid.input.filter.without.value":"Missing filter values","invalid.input.empty.value":"Empty value.","invalid.input.int.value.too.low":"Page size too small.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.query.between.order.of.values":"First value cannot be greater than the second value for a BETWEEN operator","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.input.invalid.uuid":"Invalid UUID.","invalid.query":"Invalid query","invalid.query.sort.attribute.in.invalid.filter":"Sorting attribute is in an invalid filter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.input.attributes.missing.expands":"Invalid value for attributes. 'attributes' list must contain all fields specified in 'expands' list."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","not.found.error":"Not found error"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"postTaskmanagementWorkitemsQuery","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a workitem","description":"","operationId":"getTaskmanagementWorkitemVersions","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a workitem","description":"","operationId":"getTaskmanagementWorkitemVersion","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Workitem version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/workitems/{workitemId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a workitem's attribute change history","description":"","operationId":"getTaskmanagementWorkitemHistory","produces":["application/json"],"parameters":[{"name":"workitemId","in":"path","description":"Workitem ID","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:workitem:view"]},"x-purecloud-method-name":"getTaskmanagementWorkitemHistory","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/versions":{"get":{"tags":["Task Management"],"summary":"Get all versions of a worktype","description":"","operationId":"getTaskmanagementWorktypeVersions","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeVersions","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}":{"get":{"tags":["Task Management"],"summary":"Get a version of a worktype","description":"","operationId":"getTaskmanagementWorktypeVersion","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"entityVersion","in":"path","description":"Worktype version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found.version.not.found":"Version not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeVersion","x-genesys-preview":true}},"/api/v2/taskmanagement/worktypes/{worktypeId}/history":{"get":{"tags":["Task Management"],"summary":"Get a listing of a worktype's attribute change history","description":"","operationId":"getTaskmanagementWorktypeHistory","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"descending","enum":["ascending","descending"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorktypeChangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.input.int.value.too.high":"Page size too large.","invalid.input.int.value.too.low":"Page size too small.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.input.invalid.uuid":"Invalid UUID.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workitems","workitems:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["workitems:worktype:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeHistory","x-genesys-preview":true}}},"securityDefinitions":{"PureCloud OAuth":{"type":"oauth2","authorizationUrl":"https://login.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}},"Guest Chat JWT":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"BatchEventResponse":{"type":"object","properties":{"errors":{"type":"array","description":"A list of validation or server errors that occurred for posted events.","items":{"$ref":"#/definitions/EventError"}}}},"EventError":{"type":"object","properties":{"eventId":{"type":"string","description":"The eventId (V4 UUID) for the event that encountered an error."},"message":{"type":"string","description":"A message describing the error."},"retryable":{"type":"boolean","description":"The event for this eventId can be resubmitted if this value is true."}}},"AudioState":{"type":"object","properties":{"canHear":{"type":"boolean","description":"Indicates that this communication's audio allows its participant to hear others."},"canSpeak":{"type":"boolean","description":"Indicates that this communication's audio allows others to hear this participant."}}},"AudioUpdatedEvent":{"type":"object","required":["audioState","communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"audioState":{"description":"The updated audioState for the target communication.","$ref":"#/definitions/AudioState"}}},"BatchConversationEventRequest":{"type":"object","properties":{"endTransferEvents":{"type":"array","description":"Voice - EndTransfer events for this batch","items":{"$ref":"#/definitions/EndTransferEvent"}},"phoneTransferEvents":{"type":"array","description":"Voice - PhoneTransfer events for this batch","items":{"$ref":"#/definitions/PhoneTransferEvent"}},"progressTransferEvents":{"type":"array","description":"Voice - ProgressTransfer events for this batch","items":{"$ref":"#/definitions/ProgressTransferEvent"}},"routingTransferEvents":{"type":"array","description":"Voice - RoutingTransfer events for this batch","items":{"$ref":"#/definitions/RoutingTransferEvent"}},"userTransferEvents":{"type":"array","description":"Voice - UserTransfer events for this batch","items":{"$ref":"#/definitions/UserTransferEvent"}},"communicationAnsweredEvents":{"type":"array","description":"Voice - CommunicationAnswered events for this batch","items":{"$ref":"#/definitions/CommunicationAnsweredEvent"}},"communicationDispositionAppliedEvents":{"type":"array","description":"Voice - CommunicationDispositionApplied events for this batch","items":{"$ref":"#/definitions/CommunicationDispositionAppliedEvent"}},"holdUpdatedEvents":{"type":"array","description":"Voice - HoldUpdated events for this batch","items":{"$ref":"#/definitions/HoldUpdatedEvent"}},"externalEstablishedEvents":{"type":"array","description":"Voice - ExternalEstablished events for this batch","items":{"$ref":"#/definitions/ExternalEstablishedEvent"}},"ivrEstablishedEvents":{"type":"array","description":"Voice - IvrEstablished events for this batch","items":{"$ref":"#/definitions/IvrEstablishedEvent"}},"phoneEstablishedEvents":{"type":"array","description":"Voice - PhoneEstablished events for this batch","items":{"$ref":"#/definitions/PhoneEstablishedEvent"}},"routingEstablishedEvents":{"type":"array","description":"Voice - RoutingEstablished events for this batch","items":{"$ref":"#/definitions/RoutingEstablishedEvent"}},"userEstablishedEvents":{"type":"array","description":"Voice - UserEstablished events for this batch","items":{"$ref":"#/definitions/UserEstablishedEvent"}},"audioUpdatedEvents":{"type":"array","description":"Voice - AudioUpdated events for this batch","items":{"$ref":"#/definitions/AudioUpdatedEvent"}},"communicationEndedEvents":{"type":"array","description":"Voice - CommunicationEnded events for this batch","items":{"$ref":"#/definitions/CommunicationEndedEvent"}},"consultTransferEvents":{"type":"array","description":"Voice - ConsultTransfer events for this batch","items":{"$ref":"#/definitions/ConsultTransferEvent"}},"progressConsultTransferEvents":{"type":"array","description":"Voice - ProgressConsultTransfer events for this batch","items":{"$ref":"#/definitions/ProgressConsultTransferEvent"}},"endConsultTransferEvents":{"type":"array","description":"Voice - EndConsultTransfer events for this batch","items":{"$ref":"#/definitions/EndConsultTransferEvent"}}},"description":"A maximum of 100 events are allowed per request"},"CommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"CommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"CommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Error","Peer","Self","System","Transfer","TransferACD","TransferConference","TransferConsult","TransferUser"]},"destinationConversationId":{"type":"string","description":"The id (V4 UUID) of the conversation that the communication is being moved to when conversations are merged."}}},"ConsultTransferEvent":{"type":"object","required":["conversationId","destinationCommunicationId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."}}},"EmailBeginTransmittingEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."}}},"EmailCommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"EmailCommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"EmailCommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Unknown","Self","Peer","System","Error","Spam","Transfer","TransferACD","TransferUser"]}}},"EmailCommunicationRepliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."}}},"EmailEndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"EmailExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"displayName":{"type":"string","description":"A name for the participant if it is available for this conversation."},"includeMessage":{"type":"boolean","description":"Indicates that established communication has an initial email. If true, the initial messagesSent value will be initialized to 1."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailFlowEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailHoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"EmailInitialConfiguration":{"type":"object","required":["from","to"],"properties":{"to":{"type":"string","description":"An email address that this email is to."},"from":{"type":"string","description":"An email address that this email is from."},"cc":{"type":"array","description":"An email addresses that this email is carbon copied to.","items":{"type":"string"}},"bcc":{"type":"array","description":"An email addresses that this email is blind carbon copied to.","items":{"type":"string"}},"subject":{"type":"string","description":"The subject for this email."},"previousEmailId":{"type":"string","description":"UUID identifying the most recent previous email communication ID from the same participant on this email conversation. Will be null if this is a new participant."},"held":{"type":"boolean","description":"Indicates that this communication's initial state is held."},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"EmailProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"EmailRoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"queueId":{"type":"string","description":"The id of the queue that is routing this conversation."},"skillIds":{"type":"array","description":"The unique identifiers for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier for the language that should be used to determine the destination for the conversation."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailRoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"EmailUserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"userId":{"type":"string","description":"A unique Id (V4 UUID) identifying the user this communication belongs to."},"queueId":{"type":"string","description":"A unique Id (V4 UUID) identifying the queue that the user is emailing on behalf of. Applies to outbound emails only."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/EmailInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"EmailUserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"EndConsultTransferEvent":{"type":"object","required":["conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"}}},"EndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"ExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"aniName":{"type":"string","description":"The automatic number identification name if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"dnisName":{"type":"string","description":"The dialed number identification name if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"HoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"InitialConfiguration":{"type":"object","properties":{"audioState":{"description":"Indicates the initial audio state for the communication.","$ref":"#/definitions/AudioState"},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"recordingActive":{"type":"boolean","description":"Indicates whether recording is active for this communication at creation."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"IvrEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"ivrPhoneNumber":{"type":"string","description":"The phone number for this IVR, if any is known"},"ivrName":{"type":"string","description":"A displayable name for this IVR, if any is known."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingCommunicationAnsweredEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"}}},"MessagingCommunicationDispositionAppliedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"code":{"type":"string","description":"The wrapup-code (V4 UUID) used to disposition this interaction. If this value is not provided the disposition is considered skipped."},"notes":{"type":"string","description":"Text entered by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped."},"tags":{"type":"array","description":"The list of tags selected by the agent to describe the interaction or disposition. Ignored if the disposition is considered skipped.","items":{"type":"string"}}}},"MessagingCommunicationEndedEvent":{"type":"object","required":["communicationId","conversationId","disconnectType","eventDateTime","eventId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"disconnectType":{"type":"string","description":"Indicates how this communication was ended.","enum":["Unknown","Self","Peer","System","Error","Transfer","TransferACD","TransferUser"]}}},"MessagingEndTransferEvent":{"type":"object","required":["commandId","conversationId","eventDateTime","eventId","finalState","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"finalState":{"type":"string","description":"Indicates whether the transfer completed successfully, was cancelled, or failed for some reason.","enum":["Completed","Canceled","Failed"]},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that was being transferred."}}},"MessagingExternalEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"displayName":{"type":"string","description":"A name for the participant if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingFlowEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingHoldUpdatedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","held"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"held":{"type":"boolean","description":"Indicates whether this communication is held."}}},"MessagingInitialConfiguration":{"type":"object","required":["fromAddress","toAddress"],"properties":{"toAddress":{"type":"string","description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended."},"fromAddress":{"type":"string","description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended."},"messageType":{"type":"string","description":"The type of message platform from which the message originated.","enum":["Sms","Twitter","Facebook","Line","WhatsApp","WebMessage","Open","Instagram","Unknown"]},"held":{"type":"boolean","description":"Indicates that this communication's initial state is held."},"alerting":{"type":"boolean","description":"Indicates that this communication's initial state is alerting. If false, the communication started in a connected state."},"inbound":{"type":"boolean","description":"Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND."},"invitedBy":{"type":"string","description":"The id of the communication (the \"peer\") that \"invited\" this communication, if this occurred."},"additionalInfo":{"type":"object","description":"Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.","additionalProperties":{"type":"string"}}}},"MessagingProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"MessagingRoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"queueId":{"type":"string","description":"The id of the queue that is routing this conversation."},"skillIds":{"type":"array","description":"The unique identifiers for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier for the language that should be used to determine the destination for the conversation."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingRoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"MessagingUserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication."},"userId":{"type":"string","description":"A unique Id (V4 UUID) identifying the user this communication belongs to."},"queueId":{"type":"string","description":"A unique Id (V4 UUID) identifying the queue that the user is messaging on behalf of. Applies to outbound messages only."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/MessagingInitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"MessagingUserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"PhoneEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"The phone number for this phone."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"PhoneTransferEvent":{"type":"object","required":["commandId","conversationId","destinationPhoneNumber","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationPhoneNumber":{"type":"string","description":"The desired destination phone number that the object communication should be transferred to."}}},"ProgressConsultTransferEvent":{"type":"object","required":["conversationId","destinationCommunicationId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."}}},"ProgressTransferEvent":{"type":"object","required":["commandId","conversationId","destinationCommunicationId","eventDateTime","eventId","objectCommunicationId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"commandId":{"type":"string","description":"The id (V4 UUID) used to identify the transfer already started by the external platform."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred to."}}},"RoutingEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","queueId","sourceConfiguration"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"Identifies the phone number used to reach this queue if it is different from the information that would be accessed by queueId."},"queueId":{"type":"string","description":"The id (V4 UUID) of the queue that is routing this conversation."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"RoutingTransferEvent":{"type":"object","required":["commandId","conversationId","destinationQueueId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent *Transfer events."},"initiatingCommunicationId":{"type":"string","description":"Indicates the desired type of transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationQueueId":{"type":"string","description":"The id (V4 UUID) of the desired destination queue that the object communication should be transferred to."},"languageId":{"type":"string","description":"The unique identifier (V4 UUID) for the language that should be used to determine the destination for the conversation."},"skillIds":{"type":"array","description":"The unique identifiers (V4 UUID) for the skills that should be used to determine the destination for the conversation.","items":{"type":"string"}}}},"SourceConfiguration":{"type":"object","required":["interactionId","sourceId"],"properties":{"sourceId":{"type":"string","description":"Identifies the external platform that is the source of the conversation."},"interactionId":{"type":"string","description":"The customer's unique external identifier associated with the conversation that comes from the external platform."},"tagId":{"type":"string","description":"The customer's external identifier or tag associated with the conversation. If set, it will be used to tag the conversation."}}},"UserEstablishedEvent":{"type":"object","required":["communicationId","conversationId","eventDateTime","eventId","initialConfiguration","sourceConfiguration","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"communicationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this communication"},"phoneNumber":{"type":"string","description":"Identifies the phone number used to reach this user if it is different from the information that would be accessed by userId."},"userId":{"type":"string","description":"The userId (V4 UUID) for the user this communication belongs to."},"stationId":{"type":"string","description":"A Station ID (V4 UUID) that identifies the station being used if the user is using a station and the stationId is known."},"ani":{"type":"string","description":"The automatic number identification if it is available for this conversation."},"dnis":{"type":"string","description":"The dialed number identification if it is available for this conversation."},"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not this user will be required to complete after call work."},"queueId":{"type":"string","description":"The id (V4 UUID) of the queue that the user is calling on behalf of. Applies to outbound calls only."},"initialConfiguration":{"description":"Metadata about this communication.","$ref":"#/definitions/InitialConfiguration"},"sourceConfiguration":{"description":"Metadata about the source of this communication's interaction.","$ref":"#/definitions/SourceConfiguration"}}},"UserTransferEvent":{"type":"object","required":["commandId","conversationId","destinationUserId","eventDateTime","eventId","initiatingCommunicationId","objectCommunicationId","targetCommunicationId","transferType"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A unique Id (V4 UUID) identifying this conversation"},"transferType":{"type":"string","description":"Indicates the desired type of transfer.","enum":["Attended","Unattended"]},"commandId":{"type":"string","description":"The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events."},"initiatingCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication representing the participant that is initiating the transfer."},"targetCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`."},"objectCommunicationId":{"type":"string","description":"The id (V4 UUID) of the communication that is being transferred."},"destinationUserId":{"type":"string","description":"The id (V4 UUID) of the desired destination user that the object communication should be transferred to."}}},"BatchUserRoutingStatusEventRequest":{"type":"object","properties":{"userRoutingStatusEvents":{"type":"array","description":"UserRoutingStatus events for this batch","items":{"$ref":"#/definitions/UserRoutingStatusEvent"}}},"description":"A maximum of 100 events are allowed per request"},"UserRoutingStatusEvent":{"type":"object","required":["agentId","eventDateTime","eventId","sourceId","status"],"properties":{"eventId":{"type":"string","description":"A unique (UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A timestamp as epoch representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentId":{"type":"string","description":"Unique identifier of the agent."},"status":{"type":"string","description":"The agent's current routing status.","enum":["OffQueue","Idle","Interacting","Communicating","NotResponding"]},"sourceId":{"type":"string","description":"The agent's source platform Id."}}},"BatchUserPresenceEventRequest":{"type":"object","properties":{"userPresenceEvents":{"type":"array","description":"UserPresence events for this batch","items":{"$ref":"#/definitions/UserPresenceEvent"}}},"description":"A maximum of 100 events are allowed per request"},"UserPresenceEvent":{"type":"object","required":["eventDateTime","eventId","sourceId","userId"],"properties":{"eventId":{"type":"string","description":"A unique (V4 UUID) eventId for this event"},"eventDateTime":{"type":"string","format":"date-time","description":"A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string","description":"The User ID of the user associated with this UserPresence"},"sourceId":{"type":"string","description":"The id (V4 UUID) of the presence source being updated"},"presenceDefinitionId":{"type":"string","description":"The id (UUID) of the presence definition that the user presence is associated with"},"message":{"type":"string","description":"The message associated with the presence"}}},"AuthzDivision":{"type":"object","required":["description"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A helpful description for the division."},"homeDivision":{"type":"boolean","description":"A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update.","readOnly":true},"objectCounts":{"type":"object","description":"A count of objects in this division, grouped by type.","readOnly":true,"additionalProperties":{"type":"integer","format":"int64"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzDivisionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Entity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"NamedEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true}}},"OrgOAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organization":{"description":"The oauth client's organization.","readOnly":true,"$ref":"#/definitions/NamedEntity"}}},"RoleDivision":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"Role to be associated with the given division which forms a grant"},"divisionId":{"type":"string","description":"Division associated with the given role which forms a grant"}}},"TokenInfo":{"type":"object","properties":{"organization":{"description":"The current organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"homeOrganization":{"description":"The token's home organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"authorizedScope":{"type":"array","description":"The list of scopes authorized for the OAuth client","readOnly":true,"items":{"type":"string"}},"clonedUser":{"description":"Only present when a user is a clone of trustee user in the trustor org.","readOnly":true,"$ref":"#/definitions/TokenInfoClonedUser"},"OAuthClient":{"$ref":"#/definitions/OrgOAuthClient"}}},"TokenInfoClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"User id of the original native user","readOnly":true},"organization":{"description":"Organization of the original native user","readOnly":true,"$ref":"#/definitions/Entity"}}},"ActiveAlertCount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of active alerts for a user."}}},"AddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Biography":{"type":"object","properties":{"biography":{"type":"string","description":"Personal detailed description"},"interests":{"type":"array","items":{"type":"string"}},"hobbies":{"type":"array","items":{"type":"string"}},"spouse":{"type":"string"},"education":{"type":"array","description":"User education details","items":{"$ref":"#/definitions/Education"}}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN","OTHER"]},"extension":{"type":"string","description":"Use internal extension instead of address. Mutually exclusive with the address field."},"countryCode":{"type":"string"},"integration":{"type":"string","example":"microsoftteams","description":"Integration tag value if this number is associated with an external integration."}}},"Division":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"Education":{"type":"object","properties":{"school":{"type":"string"},"fieldOfStudy":{"type":"string"},"notes":{"type":"string","description":"Notes about education has a 2000 character limit"},"dateStart":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"EmployerInfo":{"type":"object","properties":{"officialName":{"type":"string"},"employeeId":{"type":"string"},"employeeType":{"type":"string"},"dateHire":{"type":"string"}}},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"locations":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupContact":{"type":"object","required":["address","mediaType","type"],"properties":{"address":{"type":"string","description":"Phone number for this contact type"},"extension":{"type":"string","description":"Extension is set if the number is e164 valid"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"type":{"type":"string","description":"Contact type of the address","enum":["GROUPRING","GROUPPHONE"]},"mediaType":{"type":"string","description":"Media type of the address","enum":["PHONE"]}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email","callback","message"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read."},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the location"},"floorplanId":{"type":"string","description":"Unique identifier for the location floorplan image","readOnly":true},"coordinates":{"type":"object","description":"Users coordinates on the floorplan. Only used when floorplanImage is set","additionalProperties":{"type":"number","format":"double"}},"notes":{"type":"string","description":"Optional description on the users location"},"locationDefinition":{"$ref":"#/definitions/LocationDefinition"}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"LocationAddressVerificationDetails":{"type":"object","properties":{"status":{"type":"string","description":"Status of address verification process","enum":["Pending","InProgress","Retry","Complete","Failed"]},"dateFinished":{"type":"string","format":"date-time","description":"Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateStarted":{"type":"string","format":"date-time","description":"Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"service":{"type":"string","example":"smartystreets-us","description":"Third party service used for address verification"}}},"LocationDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactUser":{"description":"Site contact for the location entity","$ref":"#/definitions/AddressableEntityRef"},"emergencyNumber":{"description":"Emergency number for the location entity","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"$ref":"#/definitions/LocationAddress"},"state":{"type":"string","description":"Current state of the location entity","enum":["active","deleted"]},"notes":{"type":"string","description":"Notes for the location entity"},"version":{"type":"integer","format":"int32","description":"Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response"},"path":{"type":"array","description":"A list of ancestor IDs in order","readOnly":true,"items":{"type":"string"}},"profileImage":{"type":"array","description":"Profile image of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"floorplanImage":{"type":"array","description":"Floorplan images of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"addressVerificationDetails":{"description":"Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter","readOnly":true,"$ref":"#/definitions/LocationAddressVerificationDetails"},"addressVerified":{"type":"boolean","description":"Boolean field which states if the address has been verified as an actual address","readOnly":true},"addressStored":{"type":"boolean","description":"Boolean field which states if the address has been stored for E911","readOnly":true},"images":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"LocationImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"OAuthLastTokenIssued":{"type":"object","properties":{"dateIssued":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean"},"indefinite":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PresenceDefinition":{"type":"object","properties":{"id":{"type":"string","description":"description"},"systemPresence":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]},"value":{"type":"string"}}},"ResourcePermissionPolicy":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string","description":"The userId of the agent"},"status":{"type":"string","description":"Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist.","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"startTime":{"type":"string","format":"date-time","description":"The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Team":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The team name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Team information."},"dateCreated":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members in a team","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"User":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"unusedRoles":{"type":"array","description":"A collection of the roles the user is not using","readOnly":true,"items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"message":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"Represents the ID of a registered source"},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing language.","enum":["active","inactive","deleted"]},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id."},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}},"webRtcCallAppearances":{"type":"integer","format":"int32","description":"The number of call appearances on the station.","readOnly":true}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"WorkPlanBidRanks":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlanBiddingPerformance":{"type":"integer","format":"int32","description":"Work plan bidding agent performance ranking. The range of values is between 0 and 9999."},"biddingTieBreaker":{"type":"string","description":"Custom agent ranking metric that some customers can use."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WritableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread."}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email","callback","message"]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of unread alerts for a specific rule type."}}},"ActionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ActionAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ActionAggregateDataContainer"}}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"AggregateViewData":{"type":"object","properties":{"name":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}},"views":{"type":"array","items":{"$ref":"#/definitions/AggregateViewData"}}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"countNegative":{"type":"integer","format":"int64"},"countPositive":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"},"p95":{"type":"integer","format":"int64"},"p99":{"type":"integer","format":"int64"}}},"ActionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ActionAggregateQueryPredicate"}}}},"ActionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ActionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ActionAggregateQueryPredicate"}}}},"ActionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ActionAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ActionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tTotalExecution"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ActionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"ActionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tTotalExecution"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"AsyncQueryResponse":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results."}}},"AsyncQueryStatus":{"type":"object","properties":{"state":{"type":"string","description":"The current state of the asynchronous query","enum":["QUEUED","PENDING","FAILED","CANCELLED","FULFILLED","EXPIRED"]},"errorMessage":{"type":"string","description":"The error associated with the current query, if the state is FAILED"},"expirationDate":{"type":"string","format":"date-time","description":"The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"submissionDate":{"type":"string","format":"date-time","description":"The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionDate":{"type":"string","format":"date-time","description":"The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BotAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"BotAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BotAggregateDataContainer"}}}},"BotAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/BotAggregateQueryPredicate"}}}},"BotAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/BotAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/BotAggregateQueryPredicate"}}}},"BotAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"BotAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/BotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionCollection","oBotSessionCollectionSelfServed","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/BotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"BotAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionCollection","oBotSessionCollectionSelfServed","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"ConversationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","canonicalExternalContactId","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ConversationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"QueryDivision":{"type":"object","properties":{}},"ConversationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ConversationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}}}},"ConversationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"ConversationActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/ConversationActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/ConversationActivityEntityData"}}}},"ConversationActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metric":{"type":"string","description":"Activity metric","enum":["oAlerting","oInteracting","oWaiting"]},"activeRouting":{"type":"string","description":"Active routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"userId":{"type":"string","description":"Unique identifier for the user"},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/ConversationActivityScoredAgent"}}}},"ConversationActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oAlerting","oInteracting","oWaiting"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"ConversationActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ConversationActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}}},"ConversationActivityScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The subscription id"},"topic":{"type":"string","description":"Notification topic"}}},"ConversationActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/ConversationActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"ConversationActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationActivityQueryPredicate"}}}},"ConversationActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationActivityQueryPredicate"}}}},"ConversationActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oAlerting","oInteracting","oWaiting"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"ConversationActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"AnalyticsAgentGroup":{"type":"object","properties":{"agentGroupId":{"type":"string","description":"Conditional group routing agent group identifier"},"agentGroupType":{"type":"string","description":"Conditional group routing agent group type","enum":["Group","SkillGroup","Team"]}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"totalHits":{"type":"integer","format":"int32"}}},"AnalyticsConversationSegment":{"type":"object","properties":{"audioMuted":{"type":"boolean","description":"Flag indicating if audio is muted or not (true/false)"},"conference":{"type":"boolean","description":"Indicates whether the segment was a conference"},"destinationConversationId":{"type":"string","description":"The unique identifier of a new conversation when a conversation is ended for a conference"},"destinationSessionId":{"type":"string","description":"The unique identifier of a new session when a session is ended for a conference"},"disconnectType":{"type":"string","description":"The session disconnect type","enum":["client","conferenceTransfer","consultTransfer","dndEndpoint","dndTransfer","endpoint","error","forwardTransfer","noAnswerTransfer","notAvailableTransfer","other","peer","spam","system","timeout","transfer","transportFailure","uncallable"]},"errorCode":{"type":"string","description":"A code corresponding to the error that occurred"},"groupId":{"type":"string","description":"Unique identifier for a PureCloud group"},"q850ResponseCodes":{"type":"array","description":"Q.850 response code(s)","items":{"type":"integer","format":"int64"}},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutingUserIds":{"type":"array","description":"Unique identifier(s) for agent(s) requested for an interaction","items":{"type":"string"}},"segmentEnd":{"type":"string","format":"date-time","description":"The end time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentStart":{"type":"string","format":"date-time","description":"The start time of a segment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentType":{"type":"string","description":"The activity that takes place in the segment, such as hold or interact","enum":["alert","barging","callback","coaching","contacting","converting","delay","dialing","hold","interact","ivr","monitoring","parked","scheduled","sharing","system","transmitting","unknown","uploading","voicemail","wrapup"]},"sipResponseCodes":{"type":"array","description":"SIP response code(s)","items":{"type":"integer","format":"int64"}},"sourceConversationId":{"type":"string","description":"The unique identifier of the previous conversation when a new conversation is created for a conference"},"sourceSessionId":{"type":"string","description":"The unique identifier of the previous session when a new session is created for a conference"},"subject":{"type":"string","description":"The subject for the initial email that started this conversation"},"videoMuted":{"type":"boolean","description":"Flag indicating if video is muted/paused or not (true/false)"},"wrapUpCode":{"type":"string","description":"Wrap up code"},"wrapUpNote":{"type":"string","description":"Note entered by an agent during after-call work"},"wrapUpTags":{"type":"array","description":"Tag(s) assigned during after-call work","items":{"type":"string"}},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}},"properties":{"type":"array","description":"Additional segment properties","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"AnalyticsConversationWithoutAttributes":{"type":"object","properties":{"conferenceStart":{"type":"string","format":"date-time","description":"The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationInitiator":{"type":"string","description":"Indicates the participant purpose of the participant initiating a message conversation","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"conversationStart":{"type":"string","format":"date-time","description":"The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"customerParticipation":{"type":"boolean","description":"Indicates a messaging conversation in which the customer participated by sending at least one message"},"divisionIds":{"type":"array","description":"Identifier(s) of division(s) associated with a conversation","items":{"type":"string"}},"externalTag":{"type":"string","description":"External tag for the conversation"},"knowledgeBaseIds":{"type":"array","description":"The unique identifier(s) of the knowledge base(s) used","items":{"type":"string"}},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"]},"selfServed":{"type":"boolean","description":"Indicates whether all flow sessions were self serviced"},"evaluations":{"type":"array","description":"Evaluations associated with this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys associated with this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions associated with this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipantWithoutAttributes"}}}},"AnalyticsEvaluation":{"type":"object","properties":{"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable"},"assigneeId":{"type":"string","description":"UserId of the assignee"},"calibrationId":{"type":"string","description":"The calibration ID used for the purpose of training evaluators"},"contextId":{"type":"string","description":"A unique identifier for an evaluation form, regardless of version"},"deleted":{"type":"boolean","description":"Whether the evaluation has been deleted"},"evaluationId":{"type":"string","description":"Unique identifier for the evaluation"},"evaluationStatus":{"type":"string","description":"Status of evaluation","enum":["Finished","InProgress","InReview","Pending","Retracted"]},"evaluatorId":{"type":"string","description":"A unique identifier of the user who evaluated the interaction"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"formId":{"type":"string","description":"ID of the evaluation form used"},"formName":{"type":"string","description":"Name of the evaluation form used"},"queueId":{"type":"string","description":"The ID of the associated queue"},"released":{"type":"boolean","description":"Whether the evaluation has been released"},"rescored":{"type":"boolean","description":"Whether the evaluation has been rescored at least once"},"userId":{"type":"string","description":"ID of the agent the evaluation was performed against"},"oTotalCriticalScore":{"type":"integer","format":"int64"},"oTotalScore":{"type":"integer","format":"int64"}}},"AnalyticsFlow":{"type":"object","properties":{"endingLanguage":{"type":"string","description":"Flow ending language, e.g. en-us"},"entryReason":{"type":"string","description":"The particular entry reason for this flow, e.g. an address, userId, or flowId"},"entryType":{"type":"string","description":"The entry type for this flow, e.g. dnis, dialer, agent, flow, or direct","enum":["agent","direct","dnis","flow","outbound"]},"exitReason":{"type":"string","description":"The exit reason for this flow, e.g. DISCONNECT"},"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowName":{"type":"string","description":"The name of this flow at the time of flow execution"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"flowVersion":{"type":"string","description":"The version of this flow"},"issuedCallback":{"type":"boolean","description":"Flag indicating whether the flow issued a callback"},"recognitionFailureReason":{"type":"string","description":"The recognition failure reason causing to exit/disconnect"},"startingLanguage":{"type":"string","description":"Flow starting language, e.g. en-us"},"transferTargetAddress":{"type":"string","description":"The address of a flow transfer target, e.g. a phone number, an email address, or a queueId"},"transferTargetName":{"type":"string","description":"The name of a flow transfer target"},"transferType":{"type":"string","description":"The type of transfer for flows that ended with a transfer"},"outcomes":{"type":"array","description":"Flow outcomes","items":{"$ref":"#/definitions/AnalyticsFlowOutcome"}}}},"AnalyticsFlowOutcome":{"type":"object","properties":{"flowOutcome":{"type":"string","description":"Combination of unique flow outcome identifier and its value separated by colon"},"flowOutcomeEndTimestamp":{"type":"string","format":"date-time","description":"The outcome ending timestamp in ISO 8601 format. This may be null if the outcome did not succeed."},"flowOutcomeId":{"type":"string","description":"Unique identifier of a flow outcome"},"flowOutcomeStartTimestamp":{"type":"string","format":"date-time","description":"The outcome starting timestamp in ISO 8601 format"},"flowOutcomeValue":{"type":"string","description":"Flow outcome value, e.g. SUCCESS"}}},"AnalyticsMediaEndpointStat":{"type":"object","properties":{"codecs":{"type":"array","description":"The MIME type(s) of the audio encodings used by the audio streams belonging to this endpoint","items":{"type":"string"}},"discardedPackets":{"type":"integer","format":"int64","description":"The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint"},"duplicatePackets":{"type":"integer","format":"int64","description":"The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"invalidPackets":{"type":"integer","format":"int64","description":"The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint"},"maxLatencyMs":{"type":"integer","format":"int64","description":"The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds"},"minMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this endpoint"},"minRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this endpoint"},"overrunPackets":{"type":"integer","format":"int64","description":"The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)"},"receivedPackets":{"type":"integer","format":"int64","description":"The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)"},"underrunPackets":{"type":"integer","format":"int64","description":"The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)"}}},"AnalyticsParticipantWithoutAttributes":{"type":"object","properties":{"externalContactId":{"type":"string","description":"External contact identifier"},"externalOrganizationId":{"type":"string","description":"External organization identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"]},"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"purpose":{"type":"string","description":"The participant's purpose","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"AnalyticsProperty":{"type":"object","properties":{"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property."},"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"]},"value":{"type":"string","description":"What property value to match against"}}},"AnalyticsProposedAgent":{"type":"object","properties":{"agentRank":{"type":"integer","format":"int32","description":"Proposed agent rank for this conversation from predictive routing (lower is better)"},"proposedAgentId":{"type":"string","description":"Unique identifier for the agent that was proposed by predictive routing"}}},"AnalyticsResolution":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"The ID of the last queue on which the conversation was handled."},"userId":{"type":"string","description":"The ID of the last user who handled the conversation."},"nNextContactAvoided":{"type":"integer","format":"int64"}}},"AnalyticsScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"AnalyticsSession":{"type":"object","properties":{"activeSkillIds":{"type":"array","description":"ID(s) of Skill(s) that are active on the conversation","items":{"type":"string"}},"acwSkipped":{"type":"boolean","description":"Marker for an agent that skipped after call work"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressOther":{"type":"string","description":"The email address for the participant on the other side of the email conversation"},"addressSelf":{"type":"string","description":"The email address for the participant on this side of the email conversation"},"addressTo":{"type":"string","description":"The address receiving an action"},"agentAssistantId":{"type":"string","description":"Unique identifier of the active virtual agent assistant"},"agentBullseyeRing":{"type":"integer","format":"int32","description":"Bullseye ring of the targeted agent"},"agentOwned":{"type":"boolean","description":"Flag indicating an agent-owned callback"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"assignerId":{"type":"string","description":"ID of the user that manually assigned a conversation"},"authenticated":{"type":"boolean","description":"Flag that indicates that the identity of the customer has been asserted as verified by the provider."},"bargedParticipantId":{"type":"string","description":"The participantId being barged in on (if someone (e.g. an agent) is being barged in on, this would correspond to one of the other participantIds present in the conversation)"},"bcc":{"type":"array","description":"Blind carbon copy email address(es)","items":{"type":"string"}},"callbackNumbers":{"type":"array","description":"Callback phone number(s)","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackUserName":{"type":"string","description":"The name of the user requesting a call back"},"cc":{"type":"array","description":"Carbon copy email address(es)","items":{"type":"string"}},"cleared":{"type":"boolean","description":"Flag that indicates that the conversation has been cleared by the customer"},"coachedParticipantId":{"type":"string","description":"The participantId being coached (if someone (e.g. an agent) is being coached, this would correspond to one of the other participantIds present in the conversation)"},"cobrowseRole":{"type":"string","description":"Describes side of the cobrowse (sharer or viewer)"},"cobrowseRoomId":{"type":"string","description":"A unique identifier for a PureCloud cobrowse room"},"deliveryStatus":{"type":"string","description":"The email or SMS delivery status","enum":["DeliveryFailed","DeliverySuccess","Failed","Published","Queued","Read","Received","Sent"]},"deliveryStatusChangeDate":{"type":"string","format":"date-time","description":"Date and time of the most recent delivery status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"destinationAddresses":{"type":"array","description":"Destination address(es) of transfers or consults","items":{"type":"string"}},"detectedSpeechEnd":{"type":"string","format":"date-time","description":"Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"detectedSpeechStart":{"type":"string","format":"date-time","description":"Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dispositionAnalyzer":{"type":"string","description":"(Dialer) Analyzer (for example speech.person)"},"dispositionName":{"type":"string","description":"(Dialer) Result of the analysis (for example disposition.classification.callable.machine)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"edgeId":{"type":"string","description":"Unique identifier of the edge device"},"eligibleAgentCounts":{"type":"array","description":"Number of eligible agents for each predictive routing attempt","items":{"type":"integer","format":"int32"}},"extendedDeliveryStatus":{"type":"string","description":"Extended delivery status"},"flowInType":{"type":"string","description":"Type of flow in that occurred when entering ACD."},"flowOutType":{"type":"string","description":"Type of flow out that occurred when emitting tFlowOut."},"journeyActionId":{"type":"string","description":"Identifier of the journey action."},"journeyActionMapId":{"type":"string","description":"Identifier of the journey action map that triggered the action."},"journeyActionMapVersion":{"type":"integer","format":"int32","description":"Version of the journey action map that triggered the action."},"journeyCustomerId":{"type":"string","description":"Primary identifier of the journey customer in the source where the activities originate from."},"journeyCustomerIdType":{"type":"string","description":"Type of primary identifier of the journey customer (e.g. cookie)."},"journeyCustomerSessionId":{"type":"string","description":"Unique identifier of the journey session."},"journeyCustomerSessionIdType":{"type":"string","description":"Type or category of journey sessions (e.g. web, ticket, delivery, atm)."},"mediaBridgeId":{"type":"string","description":"Media bridge ID for the conference session consistent across all participants"},"mediaCount":{"type":"integer","format":"int32","description":"Count of any media (images, files, etc) included in this session"},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"messageType":{"type":"string","description":"Message type for messaging services. E.g.: sms, facebook, twitter, line"},"monitoredParticipantId":{"type":"string","description":"The participantId being monitored (if someone (e.g. an agent) is being monitored, this would correspond to one of the other participantIds present in the conversation)"},"outboundCampaignId":{"type":"string","description":"(Dialer) Unique identifier of the outbound campaign"},"outboundContactId":{"type":"string","description":"(Dialer) Unique identifier of the contact"},"outboundContactListId":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"peerId":{"type":"string","description":"This identifies pairs of related sessions on a conversation. E.g. an external session’s peerId will be the session that the call originally connected to, e.g. if an IVR was dialed, the IVR session, which will also have the external session’s ID as its peer. After that point, any transfers of that session to other internal components (acd, agent, etc.) will all spawn new sessions whose peerIds point back to that original external session."},"protocolCallId":{"type":"string","description":"The original voice protocol call ID, e.g. a SIP call ID"},"provider":{"type":"string","description":"The source provider for the communication."},"recording":{"type":"boolean","description":"Flag determining if an audio recording was started or not"},"remote":{"type":"string","description":"Name, phone number, or email address of the remote party."},"remoteNameDisplayable":{"type":"string","description":"Unique identifier for the remote party"},"removedSkillIds":{"type":"array","description":"ID(s) of Skill(s) that have been removed by bullseye routing","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"roomId":{"type":"string","description":"Unique identifier for the room"},"routingRing":{"type":"integer","format":"int32","description":"Routing ring for bullseye or preferred agent routing"},"routingRule":{"type":"string","description":"Routing rule for preferred, conditional and predictive routing type"},"routingRuleType":{"type":"string","description":"Routing rule type","enum":["Bullseye","Conditional","Predictive","Preferred"]},"screenShareAddressSelf":{"type":"string","description":"Direct ScreenShare address"},"screenShareRoomId":{"type":"string","description":"A unique identifier for a PureCloud ScreenShare room"},"scriptId":{"type":"string","description":"A unique identifier for a script"},"selectedAgentId":{"type":"string","description":"Selected agent ID"},"selectedAgentRank":{"type":"integer","format":"int32","description":"Selected agent GPR rank"},"sessionDnis":{"type":"string","description":"Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"sharingScreen":{"type":"boolean","description":"Flag determining if screenShare is started or not (true/false)"},"skipEnabled":{"type":"boolean","description":"(Dialer) Whether the agent can skip the dialer contact"},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before PureCloud begins the call for a call back (0 disables automatic calling)"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"videoAddressSelf":{"type":"string","description":"Direct Video address"},"videoRoomId":{"type":"string","description":"A unique identifier for a PureCloud video room"},"waitingInteractionCounts":{"type":"array","description":"Number of waiting interactions for each predictive routing attempt","items":{"type":"integer","format":"int32"}},"agentGroups":{"type":"array","description":"Conditional group routing agent groups","items":{"$ref":"#/definitions/AnalyticsAgentGroup"}},"proposedAgents":{"type":"array","description":"Proposed agents","items":{"$ref":"#/definitions/AnalyticsProposedAgent"}},"mediaEndpointStats":{"type":"array","description":"MediaEndpointStats associated with this session","items":{"$ref":"#/definitions/AnalyticsMediaEndpointStat"}},"flow":{"description":"IVR flow execution associated with this session","$ref":"#/definitions/AnalyticsFlow"},"metrics":{"type":"array","description":"List of metrics for this session","items":{"$ref":"#/definitions/AnalyticsSessionMetric"}},"segments":{"type":"array","description":"List of segments for this session","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}}}},"AnalyticsSessionMetric":{"type":"object","properties":{"emitDate":{"type":"string","format":"date-time","description":"Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"Unique name of this metric"},"value":{"type":"integer","format":"int64","description":"The metric value"}}},"AnalyticsSurvey":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Specifies when an event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"The ID of the associated queue"},"surveyCompletedDate":{"type":"string","format":"date-time","description":"Completion datetime of the survey in ISO 8601 format"},"surveyFormContextId":{"type":"string","description":"Unique identifier for the survey form, regardless of version"},"surveyFormId":{"type":"string","description":"ID of the survey form used"},"surveyFormName":{"type":"string","description":"Name of the survey form used"},"surveyId":{"type":"string","description":"ID of the survey"},"surveyPartialResponse":{"type":"boolean","description":"Whether the survey was completed with any required questions unanswered."},"surveyPromoterScore":{"type":"integer","format":"int32","description":"Score of the survey used with NPS"},"surveyStatus":{"type":"string","description":"The status of the survey"},"surveyType":{"type":"string","description":"The type of the survey","enum":["Web","Voice"]},"userId":{"type":"string","description":"ID of the agent the survey was performed against"},"oSurveyTotalScore":{"type":"integer","format":"int64"}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"ConversationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationEnd","conversationId","conversationInitiator","conversationStart","customerParticipation","divisionId","externalTag","mediaStatsMinConversationMos","originatingDirection"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oFlowMilestone","oMediaCount","oMessageTurn","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tConversationDuration","tDialing","tFirstConnect","tFirstDial","tFlow","tFlowDisconnect","tFlowExit","tFlowOut","tFlowOutcome","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"ConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"EvaluationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","deleted","evaluationId","evaluationStatus","evaluatorId","eventTime","formId","formName","queueId","released","rescored","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oTotalCriticalScore","oTotalScore"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"PagingSpec":{"type":"object","required":["pageNumber","pageSize"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"ResolutionDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nNextContactAvoided"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for metric predicates"},"range":{"description":"Right hand side for metric predicates","$ref":"#/definitions/NumericRange"}}},"SegmentDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SegmentDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentOwned","ani","authenticated","bargedParticipantId","callbackNumber","callbackScheduledTime","canonicalExternalContactId","cleared","coachedParticipantId","conference","deliveryStatus","destinationAddress","destinationConversationId","detectedSpeechEnd","detectedSpeechStart","direction","disconnectType","dnis","edgeId","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalOrganizationId","flaggedReason","flowId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowVersion","groupId","journeyActionId","journeyActionMapId","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","mediaCount","mediaType","messageType","monitoredParticipantId","outboundCampaignId","outboundContactId","outboundContactListId","participantName","protocolCallId","provider","purpose","queueId","recording","remote","remoteNameDisplayable","requestedLanguageId","requestedRouting","requestedRoutingSkillId","scoredAgentId","scriptId","segmentEnd","segmentType","sessionDnis","sipResponseCode","subject","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode","wrapUpNote"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension, metric, or property predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension, metric, or property predicates","$ref":"#/definitions/NumericRange"}}},"SurveyDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["eventTime","queueId","surveyCompletedDate","surveyFormContextId","surveyFormId","surveyId","surveyPartialResponse","surveyPromoterScore","surveyStatus","surveyType","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oSurveyTotalScore"]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"AnalyticsConversationWithoutAttributesMultiGetResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"PropertyIndexRequest":{"type":"object","required":["properties","sessionId","targetDate"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session"},"targetDate":{"type":"string","format":"date-time","description":"Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"AsyncConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"},"startOfDayIntervalMatching":{"type":"boolean","description":"Add a filter to only include conversations that started after the beginning of the interval start date (UTC)"}}},"AnalyticsConversation":{"type":"object","properties":{"conferenceStart":{"type":"string","format":"date-time","description":"The start time of a conference call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"The end time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationInitiator":{"type":"string","description":"Indicates the participant purpose of the participant initiating a message conversation","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"conversationStart":{"type":"string","format":"date-time","description":"The start time of a conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"customerParticipation":{"type":"boolean","description":"Indicates a messaging conversation in which the customer participated by sending at least one message"},"divisionIds":{"type":"array","description":"Identifier(s) of division(s) associated with a conversation","items":{"type":"string"}},"externalTag":{"type":"string","description":"External tag for the conversation"},"knowledgeBaseIds":{"type":"array","description":"The unique identifier(s) of the knowledge base(s) used","items":{"type":"string"}},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"]},"selfServed":{"type":"boolean","description":"Indicates whether all flow sessions were self serviced"},"evaluations":{"type":"array","description":"Evaluations associated with this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys associated with this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions associated with this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipant"}}}},"AnalyticsConversationAsyncQueryResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsParticipant":{"type":"object","properties":{"externalContactId":{"type":"string","description":"External contact identifier"},"externalOrganizationId":{"type":"string","description":"External organization identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"]},"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"purpose":{"type":"string","description":"The participant's purpose","enum":["acd","agent","api","botflow","campaign","customer","dialer","external","fax","group","inbound","ivr","manual","outbound","station","user","voicemail","voicesurveyflow","workflow"]},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}},"attributes":{"type":"object","description":"List of attributes associated to this participant","additionalProperties":{"type":"string"}}}},"DataAvailabilityResponse":{"type":"object","properties":{"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EvaluationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"EvaluationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}}}},"EvaluationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","conversationStart","divisionId","evaluationContextId","evaluationCreatedDate","evaluationId","evaluationReleaseDate","evaluatorId","formId","queueId","released","rescored","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]}}},"EvaluationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowExecutionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowExecutionAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionAggregateDataContainer"}}}},"FlowExecutionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryPredicate"}}}},"FlowExecutionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowExecutionAggregateQueryPredicate"}}}},"FlowExecutionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["divisionId","flowId","flowObjectId","flowVersion"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowExecutionAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["divisionId","flowId","flowObjectId","flowVersion"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowExecutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlowExecutions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowExecutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"FlowExecutionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlowExecutions"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}}}},"FlowAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","canonicalExternalContactId","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"FlowAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"FlowObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowObservationDataContainer"}}}},"ObservationMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"},"truncated":{"type":"boolean","description":"Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations."},"observations":{"type":"array","description":"List of observations sorted by timestamp in ascending order. This list may be truncated.","items":{"$ref":"#/definitions/ObservationValue"}}}},"ObservationValue":{"type":"object","required":["observationDate"],"properties":{"observationDate":{"type":"string","format":"date-time","description":"The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier for a skill requested for an interaction","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"Unique identifier for the user"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"teamId":{"type":"string","description":"The team id the user is a member of"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods","uniqueItems":true,"items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}}}},"FlowObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oFlow"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oFlow"]}}}},"FlowObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["flowId","mediaType"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/FlowActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/FlowActivityEntityData"}}}},"FlowActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metric":{"type":"string","description":"Activity metric","enum":["oFlow"]},"activeRouting":{"type":"string","description":"Active routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"mediaType":{"type":"string","description":"The session media type","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"queueId":{"type":"string","description":"Queue identifier"},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier(s) for skill(s) requested for an interaction","items":{"type":"string"}},"requestedRoutings":{"type":"array","description":"Routing type(s) for requested/attempted routing methods.","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]},"userId":{"type":"string","description":"Unique identifier for the user"},"scoredAgents":{"type":"array","description":"Scored agents","items":{"$ref":"#/definitions/FlowActivityScoredAgent"}}}},"FlowActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oFlow"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"FlowActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/FlowActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}}},"FlowActivityScoredAgent":{"type":"object","properties":{"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"},"scoredAgentId":{"type":"string","description":"Unique identifier for the agent that was scored for this conversation"}}},"FlowActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/FlowActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"FlowActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowActivityQueryPredicate"}}}},"FlowActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowActivityQueryPredicate"}}}},"FlowActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oFlow"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"FlowActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["activeRouting","addressFrom","addressTo","agentScore","ani","conversationId","convertedFrom","convertedTo","direction","dnis","flowId","flowType","mediaType","participantName","queueId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","routingPriority","scoredAgentId","sessionId","teamId","usedRouting","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"JourneyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"JourneyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}}}},"JourneyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/JourneyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"JourneyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"JourneyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"KnowledgeAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"KnowledgeAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/KnowledgeAggregateDataContainer"}}}},"KnowledgeAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/KnowledgeAggregateQueryPredicate"}}}},"KnowledgeAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/KnowledgeAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/KnowledgeAggregateQueryPredicate"}}}},"KnowledgeAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"KnowledgeAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/KnowledgeAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/KnowledgeAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."}}},"KnowledgeAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"QueueObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"QueueObservationQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/QueueObservationDataContainer"}}}},"QueueObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/QueueObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"]}}}},"QueueObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/QueueObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["mediaType","queueId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RateLimitAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"RateLimitAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/RateLimitAggregateDataContainer"}}}},"RateLimitAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RateLimitAggregateQueryPredicate"}}}},"RateLimitAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RateLimitAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RateLimitAggregateQueryPredicate"}}}},"RateLimitAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["correlationId","entityId","limitName","max","namespace","timeUnit","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RateLimitAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["correlationId","entityId","limitName","max","namespace","timeUnit","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/RateLimitAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oRateLimitRecorded"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/RateLimitAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"RateLimitAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["oRateLimitRecorded"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"RoutingActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/RoutingActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/RoutingActivityEntityData"}}}},"RoutingActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"RoutingActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oActiveUsers","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"RoutingActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/RoutingActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"RoutingActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/RoutingActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["queueId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/RoutingActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"RoutingActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingActivityQueryPredicate"}}}},"RoutingActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingActivityQueryPredicate"}}}},"RoutingActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oActiveUsers","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"RoutingActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"SurveyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"SurveyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"SurveyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"SurveyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}}}},"SurveyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"]}}},"TeamActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/TeamActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/TeamActivityEntityData"}}}},"TeamActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"TeamActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oTeamOffQueueUsers","oTeamOnQueueUsers","oTeamPresences","oTeamRoutingStatuses"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"TeamActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/TeamActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"TeamActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/TeamActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["teamId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TeamActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"TeamActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TeamActivityQueryPredicate"}}}},"TeamActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TeamActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TeamActivityQueryPredicate"}}}},"TeamActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oTeamOffQueueUsers","oTeamOnQueueUsers","oTeamPresences","oTeamRoutingStatuses"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"TeamActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"TranscriptAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TranscriptAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}}}},"TranscriptAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TranscriptAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","ani","channel","conversationDuration","conversationId","direction","divisionId","dnis","flowId","flowVersion","handleTime","mediaType","messageType","queueId","resultsBy","teamId","topicId","userId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TranscriptAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"TranscriptAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"UserAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"AnalyticsRoutingStatusRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"routingStatus":{"type":"string","description":"The user's ACD routing status","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]}}},"AnalyticsUserDetail":{"type":"object","properties":{"userId":{"type":"string","description":"The identifier for the user"},"primaryPresence":{"type":"array","description":"The presence records for the user","items":{"$ref":"#/definitions/AnalyticsUserPresenceRecord"}},"routingStatus":{"type":"array","description":"The ACD routing status records for the user","items":{"$ref":"#/definitions/AnalyticsRoutingStatusRecord"}}}},"AnalyticsUserDetailsQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"totalHits":{"type":"integer","format":"int32"}}},"AnalyticsUserPresenceRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"The user's system presence","enum":["AVAILABLE","AWAY","BUSY","OFFLINE","IDLE","ON_QUEUE","MEAL","TRAINING","MEETING","BREAK"]},"organizationPresenceId":{"type":"string","description":"The identifier for the user's organization presence"}}},"PresenceDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/PresenceDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","systemPresence"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RoutingStatusDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingStatusDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["routingStatus"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"presenceAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"routingStatusAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"UserObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"UserObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/UserObservationDataContainer"}}}},"UserObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"]}}}},"UserObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}}}},"UserAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"UserAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"UserActivityData":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from grouping dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"Data for metrics","items":{"$ref":"#/definitions/UserActivityMetricValue"}},"truncated":{"type":"boolean","description":"Flag for a truncated list of entities. If truncated, the first half of the list of entities will contain the oldest entities and the second half the newest entities."},"entities":{"type":"array","description":"Details for active entities","items":{"$ref":"#/definitions/UserActivityEntityData"}}}},"UserActivityEntityData":{"type":"object","required":["activityDate"],"properties":{"activityDate":{"type":"string","format":"date-time","description":"The time at which the activity was observed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organizationPresenceId":{"type":"string","description":"Organization presence identifier"},"presenceDate":{"type":"string","format":"date-time","description":"Date of the latest presence change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"queueMembershipStatus":{"type":"string","description":"Queue membership status (e.g. active or inactive)"},"routingStatus":{"type":"string","description":"Agent routing status"},"routingStatusDate":{"type":"string","format":"date-time","description":"Date of the latest routing status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"System presence"},"teamId":{"type":"string","description":"The team ID the user is a member of"},"userId":{"type":"string","description":"Unique identifier for the user"}}},"UserActivityMetricValue":{"type":"object","properties":{"metric":{"type":"string","description":"metric","enum":["oActiveQueues","oMemberQueues"]},"count":{"type":"integer","format":"int32","description":"metric count"}}},"UserActivityResponse":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/UserActivityData"}},"entityIdDimension":{"type":"string","description":"Dimension that is used as an entityId","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"]}}},"UserActivityQuery":{"type":"object","required":["groupBy","metrics"],"properties":{"metrics":{"type":"array","description":"List of requested metrics","items":{"$ref":"#/definitions/UserActivityQueryMetric"}},"groupBy":{"type":"array","description":"Dimension(s) to group by","uniqueItems":true,"items":{"type":"string","enum":["userId"]}},"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserActivityQueryFilter"},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]}}},"UserActivityQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserActivityQueryPredicate"}}}},"UserActivityQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserActivityQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserActivityQueryPredicate"}}}},"UserActivityQueryMetric":{"type":"object","required":["metric"],"properties":{"metric":{"type":"string","description":"The requested metric","enum":["oActiveQueues","oMemberQueues"]},"details":{"type":"boolean","description":"Flag for including observation details for this metric in the response"}}},"UserActivityQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","presenceDate","queueId","queueMembershipStatus","routingStatus","routingStatusDate","systemPresence","teamId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}}}},"AsyncUserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc","unordered"]},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"}}},"AnalyticsUserDetailsAsyncQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ReportingTurn":{"type":"object","properties":{"userInput":{"type":"string","description":"The chosen user input associated with this reporting turn."},"botPrompts":{"type":"array","description":"The bot prompts associated with this reporting turn.","items":{"type":"string"}},"sessionId":{"type":"string","description":"The bot session ID that this reporting turn is grouped under."},"askAction":{"description":"The bot flow 'ask' action associated with this reporting turn (e.g. AskForIntent).","$ref":"#/definitions/ReportingTurnAction"},"intent":{"description":"The intent and associated slots detected during this reporting turn.","$ref":"#/definitions/ReportingTurnIntent"},"knowledge":{"description":"The knowledge data captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledge"},"knowledgeBaseEvents":{"description":"The knowledge data captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeEvents"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp indicating when the original turn was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"askActionResult":{"type":"string","description":"Result of the bot flow 'ask' action.","enum":["SuccessCollection","SuccessConfirmationYes","SuccessConfirmationNo","SkippedCollection","NoMatchCollection","NoMatchConfirmation","AgentRequestedByUser","ConfirmationRequired","Error","ExpressionError","NoInputCollection","NoInputConfirmation","DisambiguationRequired","SuccessDisambiguation","SuccessDisambiguationNone","NoMatchDisambiguation","NoInputDisambiguation"]},"sessionEndDetails":{"description":"The details related to end of bot flow session.","$ref":"#/definitions/SessionEndDetails"},"conversation":{"description":"The conversation details, across potentially multiple Bot Flow sessions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"ReportingTurnAction":{"type":"object","properties":{"actionId":{"type":"string","description":"The ID of the action in the bot flow."},"actionName":{"type":"string","description":"The name of the action in the bot flow."},"actionNumber":{"type":"integer","format":"int32","description":"The number of the action in the bot flow."},"actionType":{"type":"string","enum":["AddFlowMilestoneAction","AskForNLUIntentAction","AskForBooleanAction","AskForSlotAction","AskSurveyQuestionAction","AskForNLUNextIntentAction","BotState","CallTaskAction","ClearSlotAction","ClearUtilizationLabelAction","DisconnectAction","EndTaskAction","ExitBotFlowAction","UpdateVariableAction","CommunicateAction","DecisionAction","FindEmergencyGroupAction","FindGrammarAction","FindGrammarByIdAction","FindGroupAction","FindLanguageSkillAction","FindQueueAction","FindQueueByIdAction","FindScheduleAction","FindScheduleGroupAction","FindSkillAction","FindSystemPromptAction","FindUserAction","FindUserByIdAction","FindUsersByIdAction","FindUserPromptAction","FindUtilizationLabelAction","SwitchAction","DataAction","DataTableLookupAction","GetExternalContactAction","GetExternalOrganizationAction","LoopAction","ExitLoopAction","NextLoopAction","LoopUntilAction","SetActiveIntentAction","SetFlowOutcomeAction","InitializeFlowOutcomeAction","AskForStringAction","SendResponseAction","GetResponseAction","ExtractSecureDataAction","SecureAction","TransferTaskAction","DigitalMenuAction","WaitForInputAction","EvaluateScheduleAction","EvaluateScheduleGroupAction","ShowKnowledgeArticleAction","SendKnowledgeFeedbackAction","SetLocaleAction","ScreenPopAction","SetUtilizationLabelAction","TransferPureMatchAction","Unknown"]}}},"ReportingTurnIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the intent detected during this reporting turn."},"confidence":{"type":"number","format":"double","description":"The confidence score of the intent detected during this reporting turn."},"slots":{"type":"array","description":"The slots detected during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnIntentSlot"}}}},"ReportingTurnIntentSlot":{"type":"object","properties":{"name":{"type":"string","description":"The name of the slot."},"value":{"type":"string","description":"The value of the slot."},"type":{"type":"string","description":"The NLU entity type of the slot (either builtin or user defined)"},"confidence":{"type":"number","format":"double","description":"The confidence score this slot received during detection."}}},"ReportingTurnKnowledge":{"type":"object","properties":{"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"feedback":{"description":"The knowledge feedback data that was captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeFeedback"},"search":{"description":"The knowledge search data that was captured during this reporting turn.","$ref":"#/definitions/ReportingTurnKnowledgeSearch"}}},"ReportingTurnKnowledgeDocument":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the knowledge document."},"question":{"type":"string","description":"The the question that was used to match against the search query."},"answer":{"type":"string","description":"The corresponding answer to the question."},"confidence":{"type":"number","format":"double","description":"The confidence score of how well the question matched the search query."}}},"ReportingTurnKnowledgeEvents":{"type":"object","properties":{"search":{"type":"array","description":"The knowledge search data captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeSearchEvent"}},"feedback":{"type":"array","description":"The knowledge feedback data captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeFeedbackEvent"}}}},"ReportingTurnKnowledgeFeedback":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of the original knowledge search that this feedback relates to."},"rating":{"type":"integer","format":"int32","description":"The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}}}},"ReportingTurnKnowledgeFeedbackEvent":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"feedbackRating":{"type":"integer","format":"int32","description":"The feedback rating for the search (1.0 - 5.0). 1 = Negative, 5 = Positive."},"documentVariationId":{"type":"string","description":"The variation of the document."},"documentVersionId":{"type":"string","description":"The version of the document."}}},"ReportingTurnKnowledgeSearch":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"documents":{"type":"array","description":"The list of search documents captured during this reporting turn.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"query":{"type":"string","description":"The search query that was used to search the Knowledge Base documents for a matching question."}}},"ReportingTurnKnowledgeSearchEvent":{"type":"object","properties":{"searchId":{"type":"string","description":"The ID of this knowledge search."},"knowledgeBaseId":{"type":"string","description":"The Knowledge Base ID that the captured knowledge data relates to."},"documents":{"type":"array","description":"The list of search documents that the feedback applies to.","items":{"$ref":"#/definitions/ReportingTurnKnowledgeDocument"}},"searchQuery":{"type":"string","description":"The search query that was used to search the Knowledge Base documents for a matching question."},"answerDocumentId":{"type":"string","description":"The document ID of the search answer."}}},"ReportingTurnsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingTurn"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SessionEndDetails":{"type":"object","properties":{"type":{"type":"string","description":"The type of termination handling that resulted in the session end. It can be either Exit or Disconnect","enum":["Disconnect","Exit"]},"reason":{"type":"string","description":"The reason for termination action. It can be due to an error or normal flow execution"}}},"BotChannel":{"type":"object","required":["inputModes","name","outputModes","userAgent"],"properties":{"name":{"type":"string","description":"The name of the channel.","enum":["Chat","Call","Messaging"]},"inputModes":{"type":"array","description":"The input modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text","Voice","DTMF"]}},"outputModes":{"type":"array","description":"The output modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text","Voice"]}},"userAgent":{"description":"Information about the end user agent calling the bot flow.","$ref":"#/definitions/TextBotUserAgent"}},"description":"Channel information relevant to a bot flow."},"BotFlowSession":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the bot session."},"flow":{"description":"The flow associated to this bot session.","$ref":"#/definitions/Entity"},"channel":{"description":"Channel-specific information that describes the message channel/provider.","$ref":"#/definitions/BotChannel"},"language":{"type":"string","description":"The initial language of operation for the session."},"endLanguage":{"type":"string","description":"The language of the session at the time the session ended"},"botResult":{"type":"string","description":"The reason for session termination.","enum":["Unknown","ExitRequestedByUser","ExitRequestedByBot","ExitError","ExitRecognitionFailure","DisconnectRequestedByUser","DisconnectRequestedByBot","DisconnectSessionExpired","DisconnectError","DisconnectRecognitionFailure","TransferToACD"]},"botResultCategory":{"type":"string","description":"The category of result for the session.","enum":["Unknown","UserExit","BotExit","Error","RecognitionFailure","UserDisconnect","BotDisconnect","SessionExpired","Transfer"]},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"description":"The conversation details, across potentially multiple Bot Flow sessions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SessionsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotFlowSession"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"TextBotUserAgent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the user agent.","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"]}},"description":"Information about the caller executing a bot flow."},"AnalyticsDataRetentionResponse":{"type":"object","properties":{"retentionDays":{"type":"integer","format":"int32","description":"Analytics data retention period in days for the organization."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time when the analytics data retention was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date and time when the analytics data retention was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UpdateAnalyticsDataRetentionRequest":{"type":"object","required":["retentionDays"],"properties":{"retentionDays":{"type":"integer","format":"int32","description":"Analytics data retention period in days to set for the organization."}}},"AnalyticsReportingSettings":{"type":"object","properties":{"piiMaskingEnabled":{"type":"boolean","description":"Indication of whether or not personal data is masked in data export and the Analytics/Reporting UI"},"queueAgentAccessObfuscation":{"type":"boolean","description":"Indication of whether or not to obfuscate export data from the Queue Agent Details view based on User ACL"},"myInteractionsPiiMaskingEnabled":{"type":"boolean","description":"Indicates whether PII data is masked in My Interaction export and the Analytics/Reporting UI"}}},"ConversationProperties":{"type":"object","properties":{"isWaiting":{"type":"boolean","description":"Indicates filtering for waiting"},"isActive":{"type":"boolean","description":"Indicates filtering for active"},"isAcd":{"type":"boolean","description":"Indicates filtering for Acd"},"isPreferred":{"type":"boolean","description":"Indicates filtering for Preferred Agent Routing"},"isScreenshare":{"type":"boolean","description":"Indicates filtering for screenshare"},"isCobrowse":{"type":"boolean","description":"Indicates filtering for Cobrowse"},"isVoicemail":{"type":"boolean","description":"Indicates filtering for Voice mail"},"isFlagged":{"type":"boolean","description":"Indicates filtering for flagged"},"isMonitored":{"type":"boolean","description":"Indicates filtering for monitored"},"isScreenMonitored":{"type":"boolean","description":"Indicates filtering for screenMonitored"},"filterWrapUpNotes":{"type":"boolean","description":"Indicates filtering for WrapUpNotes"},"matchAll":{"type":"boolean","description":"Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic"}}},"DashboardConfiguration":{"type":"object","required":["dateCreated","dateModified","name","widgets"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of dashboard configuration."},"rows":{"type":"integer","description":"The count of rows for the specific dashboard configuration."},"columns":{"type":"integer","description":"The count of columns for the specific dashboard."},"widgets":{"type":"array","description":"List of widgets for dashboard configuration.","items":{"$ref":"#/definitions/Widget"}},"favorite":{"type":"boolean","description":"The flag indicates if the dashboard is favorited by the user"},"publicDashboard":{"type":"boolean","description":"The flag to indicate if the dashboard is published by an user"},"restricted":{"type":"boolean","description":"The flag to indicate if the dashboard has any restricted data for that user","readOnly":true},"layoutType":{"type":"string","description":"The layout type of the dashboard","enum":["Grid","Flow"]},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The last modified date of the dashboard. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The id of user who created the dashboard","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"shared":{"type":"boolean","description":"The flag to indicate if the dashboard is shared"},"dashboardsSharedWith":{"description":"The list of users and teams the dashboard is shared with","$ref":"#/definitions/DashboardsSharedWith"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DashboardsSharedWith":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of user ids to share the dashboard with","items":{"type":"string"}},"teamIds":{"type":"array","description":"The list of team ids to share the dashboard with","items":{"type":"string"}}}},"TranscriptTopics":{"type":"object","properties":{"includes":{"type":"array","description":"List of topics which need to be included in exact match criteria. This field is not mutually exclusive with excludes topic list.","items":{"type":"string"}},"excludes":{"type":"array","description":"List of topics which need to be excluded in exact match criteria. This field is not mutually exclusive with includes topic list.","items":{"type":"string"}}}},"Transcripts":{"type":"object","properties":{"exactMatch":{"type":"array","description":"List of transcript contents which needs to satisfy exact match criteria","items":{"type":"string"}},"contains":{"type":"array","description":"List of transcript contents which needs to satisfy contains criteria","items":{"type":"string"}},"doesNotContain":{"type":"array","description":"List of transcript contents which needs to satisfy does not contain criteria","items":{"type":"string"}}}},"ViewFilter":{"type":"object","properties":{"mediaTypes":{"type":"array","description":"The media types are used to filter the view","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queueIds":{"type":"array","description":"The queue ids are used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"QUEUE_ID"}},"skillIds":{"type":"array","description":"The skill ids are used to filter the view","items":{"type":"string"}},"skillGroups":{"type":"array","description":"The skill groups used to filter the view","items":{"type":"string"}},"languageIds":{"type":"array","description":"The language ids are used to filter the view","items":{"type":"string"}},"languageGroups":{"type":"array","description":"The language groups used to filter the view","items":{"type":"string"}},"directions":{"type":"array","description":"The directions are used to filter the view","items":{"type":"string","enum":["inbound","outbound"]}},"originatingDirections":{"type":"array","description":"The list of orginating directions used to filter the view","items":{"type":"string","enum":["inbound","outbound"]}},"wrapUpCodes":{"type":"array","description":"The wrap up codes are used to filter the view","items":{"type":"string"}},"dnisList":{"type":"array","description":"The dnis list is used to filter the view","items":{"type":"string"}},"sessionDnisList":{"type":"array","description":"The list of session dnis used to filter the view","items":{"type":"string"}},"filterQueuesByUserIds":{"type":"array","description":"The user ids are used to fetch associated queues for the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"USER_ID"}},"filterUsersByQueueIds":{"type":"array","description":"The queue ids are used to fetch associated users for the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"QUEUE_ID"}},"userIds":{"type":"array","description":"The user ids are used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"USER_ID"}},"managementUnitIds":{"type":"array","description":"The management unit ids are used to filter the view","items":{"type":"string"}},"addressTos":{"type":"array","description":"The address To values are used to filter the view","items":{"type":"string"}},"addressFroms":{"type":"array","description":"The address from values are used to filter the view","items":{"type":"string"}},"outboundCampaignIds":{"type":"array","description":"The outbound campaign ids are used to filter the view","items":{"type":"string"}},"outboundContactListIds":{"type":"array","description":"The outbound contact list ids are used to filter the view","items":{"type":"string"}},"contactIds":{"type":"array","description":"The contact ids are used to filter the view","items":{"type":"string"}},"externalContactIds":{"type":"array","description":"The external contact ids are used to filter the view","items":{"type":"string"}},"externalOrgIds":{"type":"array","description":"The external org ids are used to filter the view","items":{"type":"string"}},"aniList":{"type":"array","description":"The ani list ids are used to filter the view","items":{"type":"string"}},"durationsMilliseconds":{"type":"array","description":"The durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acdDurationsMilliseconds":{"type":"array","description":"The acd durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"talkDurationsMilliseconds":{"type":"array","description":"The talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acwDurationsMilliseconds":{"type":"array","description":"The acw durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"handleDurationsMilliseconds":{"type":"array","description":"The handle durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"holdDurationsMilliseconds":{"type":"array","description":"The hold durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"abandonDurationsMilliseconds":{"type":"array","description":"The abandon durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"evaluationScore":{"description":"The evaluationScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationCriticalScore":{"description":"The evaluationCriticalScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationFormIds":{"type":"array","description":"The evaluation form ids are used to filter the view","items":{"type":"string"}},"evaluatedAgentIds":{"type":"array","description":"The evaluated agent ids are used to filter the view","items":{"type":"string"}},"evaluatorIds":{"type":"array","description":"The evaluator ids are used to filter the view","items":{"type":"string"}},"transferred":{"type":"boolean","description":"Indicates filtering for transfers"},"abandoned":{"type":"boolean","description":"Indicates filtering for abandons"},"answered":{"type":"boolean","description":"Indicates filtering for answered interactions"},"messageTypes":{"type":"array","description":"The message media types used to filter the view","items":{"type":"string","enum":["sms","twitter","line","facebook","whatsapp","webmessaging","open","instagram"]}},"divisionIds":{"type":"array","description":"The divison Ids used to filter the view","items":{"type":"string"},"x-genesys-entity-type":{"value":"DIVISION_ID"}},"surveyFormIds":{"type":"array","description":"The survey form ids used to filter the view","items":{"type":"string"}},"surveyTotalScore":{"description":"The survey total score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyNpsScore":{"description":"The survey NPS score used to filter the view","$ref":"#/definitions/NumericRange"},"mos":{"description":"The desired range for mos values","$ref":"#/definitions/NumericRange"},"surveyQuestionGroupScore":{"description":"The survey question group score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyPromoterScore":{"description":"The survey promoter score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyFormContextIds":{"type":"array","description":"The list of survey form context ids used to filter the view","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of conversation ids used to filter the view","items":{"type":"string"}},"sipCallIds":{"type":"array","description":"The list of SIP call ids used to filter the view","items":{"type":"string"}},"isEnded":{"type":"boolean","description":"Indicates filtering for ended"},"isSurveyed":{"type":"boolean","description":"Indicates filtering for survey"},"surveyScores":{"type":"array","description":"The list of survey score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"promoterScores":{"type":"array","description":"The list of promoter score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"isCampaign":{"type":"boolean","description":"Indicates filtering for campaign"},"surveyStatuses":{"type":"array","description":"The list of survey statuses used to filter the view","items":{"type":"string"}},"conversationProperties":{"description":"A grouping of conversation level filters","$ref":"#/definitions/ConversationProperties"},"isBlindTransferred":{"type":"boolean","description":"Indicates filtering for blind transferred"},"isConsulted":{"type":"boolean","description":"Indicates filtering for consulted"},"isConsultTransferred":{"type":"boolean","description":"Indicates filtering for consult transferred"},"remoteParticipants":{"type":"array","description":"The list of remote participants used to filter the view","items":{"type":"string"}},"flowIds":{"type":"array","description":"The list of flow Ids","items":{"type":"string"}},"flowOutcomeIds":{"type":"array","description":"A list of outcome ids of the flow","items":{"type":"string"}},"flowOutcomeValues":{"type":"array","description":"A list of outcome values of the flow","items":{"type":"string","enum":["SUCCESS","FAILURE"]}},"flowDestinationTypes":{"type":"array","description":"The list of destination types of the flow","items":{"type":"string","enum":["ACD","USER","GROUP","NUMBER","FLOW","SECURE_FLOW","ACD_VOICEMAIL","USER_VOICEMAIL","GROUP_VOICEMAIL","RETURN_TO_AGENT"]}},"flowDisconnectReasons":{"type":"array","description":"The list of reasons for the flow to disconnect","items":{"type":"string","enum":["FLOW_DISCONNECT","FLOW_ERROR_DISCONNECT","DISCONNECT"]}},"flowTypes":{"type":"array","description":"A list of types of the flow","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]}},"flowEntryTypes":{"type":"array","description":"A list of types of the flow entry","items":{"type":"string","enum":["agent","direct","dnis","flow","outbound"]}},"flowEntryReasons":{"type":"array","description":"A list of reasons of flow entry","items":{"type":"string"}},"flowVersions":{"type":"array","description":"A list of versions of a flow","items":{"type":"string"}},"groupIds":{"type":"array","description":"A list of directory group ids","items":{"type":"string"}},"hasJourneyCustomerId":{"type":"boolean","description":"Indicates filtering for journey customer id"},"hasJourneyActionMapId":{"type":"boolean","description":"Indicates filtering for Journey action map id"},"hasJourneyVisitId":{"type":"boolean","description":"Indicates filtering for Journey visit id"},"hasMedia":{"type":"boolean","description":"Indicates filtering for presence of MMS media"},"roleIds":{"type":"array","description":"The role Ids used to filter the view","items":{"type":"string"}},"reportsTos":{"type":"array","description":"The report to user IDs used to filter the view","items":{"type":"string"}},"locationIds":{"type":"array","description":"The location Ids used to filter the view","items":{"type":"string"}},"flowOutTypes":{"type":"array","description":"A list of flow out types","items":{"type":"string"}},"providerList":{"type":"array","description":"A list of providers","items":{"type":"string"}},"callbackNumberList":{"type":"array","description":"A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])","items":{"type":"string"}},"callbackInterval":{"type":"string","description":"An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"usedRoutingTypes":{"type":"array","description":"A list of routing types used","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"requestedRoutingTypes":{"type":"array","description":"A list of routing types requested","items":{"type":"string","enum":["Bullseye","Conditional","Direct","Last","Manual","Predictive","Preferred","Standard","Vip"]}},"hasAgentAssistId":{"type":"boolean","description":"Indicates filtering for agent assist id"},"transcripts":{"type":"array","description":"A list of transcript contents requested","items":{"$ref":"#/definitions/Transcripts"}},"transcriptLanguages":{"type":"array","description":"A list of transcript languages requested","items":{"type":"string"}},"participantPurposes":{"type":"array","description":"A list of participant purpose requested","items":{"type":"string","enum":["internal","external"]}},"showFirstQueue":{"type":"boolean","description":"Indicates filtering for first queue data"},"teamIds":{"type":"array","description":"The team ids used to filter the view data","items":{"type":"string"}},"filterUsersByTeamIds":{"type":"array","description":"The team ids are used to fetch associated users for the view","items":{"type":"string"}},"journeyActionMapIds":{"type":"array","description":"The journey action map ids are used to fetch action maps for the associated view","items":{"type":"string"}},"journeyOutcomeIds":{"type":"array","description":"The journey outcome ids are used to fetch outcomes for the associated view","items":{"type":"string"}},"journeySegmentIds":{"type":"array","description":"The journey segment ids are used to fetch segments for the associated view","items":{"type":"string"}},"journeyActionMapTypes":{"type":"array","description":"The journey action map types are used to filter action map data for the associated view","items":{"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]}},"developmentRoleList":{"type":"array","description":"The list of development roles used to filter agent development view","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]}},"developmentTypeList":{"type":"array","description":"The list of development types used to filter agent development view","items":{"type":"string","enum":["Informational","Coaching","Assessment","AssessedContent","External"]}},"developmentStatusList":{"type":"array","description":"The list of development status used to filter agent development view","items":{"type":"string","enum":["Planned","Scheduled","InvalidSchedule","InProgress","Completed","NotCompleted"]}},"developmentModuleIds":{"type":"array","description":"The list of development moduleIds used to filter agent development view","items":{"type":"string"}},"developmentActivityOverdue":{"type":"boolean","description":"Indicates filtering for development activities"},"customerSentimentScore":{"description":"The customer sentiment score used to filter the view","$ref":"#/definitions/NumericRange"},"customerSentimentTrend":{"description":"The customer sentiment trend used to filter the view","$ref":"#/definitions/NumericRange"},"flowTransferTargets":{"type":"array","description":"The list of transfer targets used to filter flow data","items":{"type":"string"}},"developmentName":{"type":"string","description":"Filter for development name"},"topicIds":{"type":"array","description":"Represents the topics detected in the transcript","items":{"type":"string"}},"externalTags":{"type":"array","description":"The list of external Tags used to filter conversation data","items":{"type":"string"}},"isNotResponding":{"type":"boolean","description":"Indicates filtering for not responding users"},"isAuthenticated":{"type":"boolean","description":"Indicates filtering for the authenticated chat"},"botIds":{"type":"array","description":"The list of bot IDs used to filter bot views","items":{"type":"string"}},"botVersions":{"type":"array","description":"The list of bot versions used to filter bot views","items":{"type":"string"}},"botMessageTypes":{"type":"array","description":"The list of bot message types used to filter bot views","items":{"type":"string","enum":["Unknown","Phone","SMS","GenesysChatWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other"]}},"botProviderList":{"type":"array","description":"The list of bot providers used to filter bot views","items":{"type":"string","enum":["Unknown","Genesys","Amazon","Google","Nuance"]}},"botProductList":{"type":"array","description":"The list of bot products used to filter bot views","items":{"type":"string","enum":["Unknown","GenesysDialogEngine","AmazonLex","GoogleDialogFlow","GoogleDialogFlowResell","GenesysBotFlow","NuanceDlg","GoogleDialogFlowCx","GenesysByob","AmazonLexV2","GoogleDialogFlowCxResell","GoogleSttBotFlow","MicrosoftSttBotFlow"]}},"botRecognitionFailureReasonList":{"type":"array","description":"The list of bot recognition failure reasons used to filter bot views","items":{"type":"string","enum":["Unknown","NoInputCollection","NoInputConfirmation","NoInputDisambiguation","NoMatchCollection","NoMatchConfirmation","NoMatchDisambiguation","MaxWrongMatch"]}},"botIntentList":{"type":"array","description":"The list of bot intents used to filter bot views","items":{"type":"string"}},"botFinalIntentList":{"type":"array","description":"The list of bot final intents used to filter bot views","items":{"type":"string"}},"botSlotList":{"type":"array","description":"The list of bot slots used to filter bot views","items":{"type":"string"}},"botResultList":{"type":"array","description":"The list of bot results used to filter bot views","items":{"type":"string","enum":["Unknown","ExitRequestedByUser","ExitRequestedByBot","ExitError","ExitRecognitionFailure","DisconnectRequestedByUser","DisconnectRequestedByBot","DisconnectSessionExpired","DisconnectError","DisconnectRecognitionFailure","TransferToACD"]}},"blockedReasons":{"type":"array","description":"The list of blocked reason used to filter action map constraints views","items":{"type":"string","enum":["PageUrlConditionsNotMatching","AlreadyExistingOffer","TriggerDateInFuture","MultipleSimultaneousOffers","FrequencyCapping","OfferedOutsideSchedule","ServiceLevelThrottling","NoAvailableAgents"]}},"isRecorded":{"type":"boolean","description":"Indicates filtering for recorded"},"hasEvaluation":{"type":"boolean","description":"Indicates filtering for evaluation"},"hasScoredEvaluation":{"type":"boolean","description":"Indicates filtering for scored evaluation"},"emailDeliveryStatusList":{"type":"array","description":"The list of email delivery statuses used to filter views","items":{"type":"string","enum":["DeliveryFailed","DeliverySuccess","Failed","Published","Queued","Read","Received","Sent"]}},"isAgentOwnedCallback":{"type":"boolean","description":"Indicates filtering for agent owned callback interactions"},"agentCallbackOwnerIds":{"type":"array","description":"The list of callback owners used to filter interactions","items":{"type":"string"}},"transcriptTopics":{"type":"array","description":"The list of transcript topics requested in filter","items":{"$ref":"#/definitions/TranscriptTopics"}},"journeyFrequencyCapReasons":{"type":"array","description":"The list of frequency cap reasons to filter offer constraints","items":{"type":"string"}},"journeyBlockingActionMapIds":{"type":"array","description":"The list of blocking action maps to filter offer constraints","items":{"type":"string"}},"journeyActionTargetIds":{"type":"array","description":"The list of action targets to filter offer constraints","items":{"type":"string"}},"journeyBlockingScheduleGroupIds":{"type":"array","description":"The list of blocking schedule groups to filter offer constraints","items":{"type":"string"}},"journeyBlockingEmergencyScheduleGroupIds":{"type":"array","description":"The list of emergency schedule groups to filter offer constraints","items":{"type":"string"}},"journeyUrlEqualConditions":{"type":"array","description":"The list of url equal conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotEqualConditions":{"type":"array","description":"The list of url not equal conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlStartsWithConditions":{"type":"array","description":"The list of url starts with conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlEndsWithConditions":{"type":"array","description":"The list of url ends with conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlContainsAnyConditions":{"type":"array","description":"The list of url contains any conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotContainsAnyConditions":{"type":"array","description":"The list of url not contains any conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlContainsAllConditions":{"type":"array","description":"The list of url contains all conditions to filter offer constraints","items":{"type":"string"}},"journeyUrlNotContainsAllConditions":{"type":"array","description":"The list of url not contains all conditions to filter offer constraints","items":{"type":"string"}},"flowMilestoneIds":{"type":"array","description":"The list of flow milestones to filter exports","items":{"type":"string"}},"isAssessmentPassed":{"type":"boolean","description":"Filter to indicate if Agent passed assessment or not"},"conversationInitiators":{"type":"array","description":"The list to filter based on Brands (Bot/User/Agent) or End User who initiated the first message in the conversation","items":{"type":"string"}},"hasCustomerParticipated":{"type":"boolean","description":"Indicates if the customer has participated in an initiated conversation"},"isAcdInteraction":{"type":"boolean","description":"Filter to indicate if interaction was ACD or non-ACD"},"hasFax":{"type":"boolean","description":"Filters to indicate if interaction has FAX"},"dataActionIds":{"type":"array","description":"The list of Data Action IDs ","items":{"type":"string"}},"actionCategoryName":{"type":"string","description":"Deprecated - Please use integrationIds instead"},"integrationIds":{"type":"array","description":"The list of integration IDs for Data Action","items":{"type":"string"}},"responseStatuses":{"type":"array","description":"The list of Response codes for Data Action","items":{"type":"string"}},"availableDashboard":{"type":"string","description":"Filter to indicate the availability of the dashboard is public or private.","enum":["Public","Private"]},"favouriteDashboard":{"type":"boolean","description":"Filter to indicate whether the dashboard is favorite or unfavorite."},"myDashboard":{"type":"boolean","description":"Filter to indicate the dashboard owned by the user."},"stationErrors":{"type":"array","description":"The list of agent errors that are related to station","items":{"type":"string"}},"canonicalContactIds":{"type":"array","description":"The canonical contact ids are used to filter the view","items":{"type":"string"}},"alertRuleIds":{"type":"array","description":"The list of Alert Rule IDs","items":{"type":"string"}},"evaluationFormContextIds":{"type":"array","description":"The list of Evaluation Form Context IDs","items":{"type":"string"}},"evaluationStatuses":{"type":"array","description":"The evaluation statuses that are used to filter the view","items":{"type":"string","enum":["Finished","InProgress","InReview","Pending","Retracted"]}},"workbinIds":{"type":"array","description":"The list of Workbin IDs","items":{"type":"string"}},"worktypeIds":{"type":"array","description":"The list of Worktype IDs","items":{"type":"string"}},"workitemIds":{"type":"array","description":"The list of Workitem IDs","items":{"type":"string"}},"workitemAssigneeIds":{"type":"array","description":"The list of Workitem Assignee IDs","items":{"type":"string"}},"workitemStatuses":{"type":"array","description":"The list of Workitem Statuses IDs","items":{"type":"string"}},"isAnalyzedForSensitiveData":{"type":"boolean","description":"Deprecated - Use hasPciData or hasPiiData instead."},"hasSensitiveData":{"type":"boolean","description":"Deprecated. Use hasPciData or hasPiiData instead."},"hasPciData":{"type":"boolean","description":"Filter to indicate the transcript contains Pci data."},"hasPiiData":{"type":"boolean","description":"Filter to indicate the transcript contains Pii data."},"subPath":{"type":"string","description":"Filter for Sub Path"},"userState":{"type":"string","description":"The user supplied state value in the view","enum":["ActiveAndInactive","Active","Inactive","Deleted"]},"isClearedByCustomer":{"type":"boolean","description":"Filter to indicate if the customer cleared the conversation."},"evaluationAssigneeIds":{"type":"array","description":"The evaluation assignee ids that are used to filter the view.","items":{"type":"string"}},"evaluationAssigned":{"type":"boolean","description":"Filter to indicate that the user has no assigned evaluation."},"assistantIds":{"type":"array","description":"The assistant ids that are used to filter the view.","items":{"type":"string"}},"knowledgeBaseIds":{"type":"array","description":"The knowledge base ids that are used to filter the view.","items":{"type":"string"}},"isParked":{"type":"boolean","description":"Filter to indicate if the interactions are parked."},"agentEmpathyScore":{"description":"The agentEmpathyScore is used to filter the view","$ref":"#/definitions/NumericRange"},"surveyTypes":{"type":"array","description":"The surveyTypes is used to filter the view","items":{"type":"string","enum":["Web","Voice"]}},"surveyResponseStatuses":{"type":"array","description":"The list of Survey Response Status","items":{"type":"string","enum":["Unknown","FullResponse","PartialResponse"]}},"botFlowTypes":{"type":"array","description":"The botFlowTypes is used to filter the view","items":{"type":"string","enum":["Unknown","Bot","DigitalBot","VoiceSurvey"]}},"agentTalkDurationMilliseconds":{"type":"array","description":"The agent talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"customerTalkDurationMilliseconds":{"type":"array","description":"The customer talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"overtalkDurationMilliseconds":{"type":"array","description":"The overtalk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"silenceDurationMilliseconds":{"type":"array","description":"The silence durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acdDurationMilliseconds":{"type":"array","description":"The acd durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"ivrDurationMilliseconds":{"type":"array","description":"The ivr durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"otherDurationMilliseconds":{"type":"array","description":"The other (hold/music) durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"agentTalkPercentage":{"description":"The agent talk percentage used to filter the view","$ref":"#/definitions/NumericRange"},"customerTalkPercentage":{"description":"The customer talk percentage used to filter the view","$ref":"#/definitions/NumericRange"},"overtalkPercentage":{"description":"The overtalk percentage used to filter the view","$ref":"#/definitions/NumericRange"},"silencePercentage":{"description":"The silence percentage used to filter the view","$ref":"#/definitions/NumericRange"},"acdPercentage":{"description":"The acd percentage used to filter the view","$ref":"#/definitions/NumericRange"},"ivrPercentage":{"description":"The ivr percentage used to filter the view","$ref":"#/definitions/NumericRange"},"otherPercentage":{"description":"The other (hold/music percentage used to filter the view","$ref":"#/definitions/NumericRange"},"overtalkInstances":{"description":"The overtalk instance range used to filter the view","$ref":"#/definitions/NumericRange"},"isScreenRecorded":{"type":"boolean","description":"Filter to indicate if the screen is recorded"},"screenMonitorUserIds":{"type":"array","description":"The list of Screen Monitor User Ids","items":{"type":"string"}}}},"Warning":{"type":"object","properties":{"value":{"type":"integer","description":"The value for the warning configuration."},"rangeType":{"type":"string","description":"The range type for the warning configuration.","enum":["OVER","UNDER","BETWEEN"]},"color":{"type":"string","description":"The color for the warning configuration in RGB hexadecimal format (for example \"#FF0000\" represents red)."}}},"Widget":{"type":"object","required":["type"],"properties":{"row":{"type":"integer","description":"The row number for the specific dashboard widget configuration."},"column":{"type":"integer","description":"The column number for the specific dashboard widget configuration."},"title":{"type":"string","description":"The title for the dashboard widget configuration."},"type":{"type":"string","description":"The type of dashboard widget configuration.","enum":["METRIC","CHART","PIE","HEAT_MAP","FREE_TEXT","AGENT_STATUS","REALTIME_ADHERENCE","WEB_CONTENT_URL"]},"metrics":{"type":"array","description":"The list of metrics for the dashboard widget configuration.","items":{"type":"string","enum":["AVG_TALK_TIME","AVG_HOLD_TIME","AVG_ACW_TIME","AVG_WAIT_TIME","AVG_HANDLE_TIME","AVG_ALERT_TIME","AVG_ANSWER_TIME","AVG_ABANDON_TIME","TOTAL_TALK_TIME","TOTAL_HANDLE_TIME","TOTAL_HOLD_TIME","TOTAL_ACW_TIME","TOTAL_ALERT_TIME","MAX_ABANDON_TIME","MAX_WAIT_TIME","MAX_TALK_TIME","MAX_HOLD_TIME","MAX_ACW_TIME","MIN_ABANDON_TIME","MIN_WAIT_TIME","MIN_TALK_TIME","MIN_HOLD_TIME","MIN_ACW_TIME","ALERT_COUNT","OFFERED_COUNT","ABANDONED_COUNT","ABANDONED_PERCENT","SHORT_ABANDONED_COUNT","SHORT_ABANDONED_PERCENT","ABANDONED_NO_SHORT_COUNT","ABANDONED_NO_SHORT_PERCENT","ANSWERED_COUNT","ANSWERED_PERCENT","FLOWOUT_COUNT","FLOWOUT_PERCENT","OUTBOUND_COUNT","OUTBOUND_ATTEMPTED_COUNT","VOICEMAIL_COUNT","HANDLED_COUNT","HELD_COUNT","TRANSFERRED_COUNT","TRANSFERRED_PERCENT","WAITING_CURRENT","INTERACTING_CURRENT","HELD_CURRENT","ALERTING_CURRENT","SERVICE_LEVEL","OVER_SERVICE_LEVEL","ONLINE_AGENTS","AVAILABLE_AGENTS","AWAY_AGENTS","BREAK_AGENTS","MEAL_AGENTS","TRAINING_AGENTS","BUSY_AGENTS","MEETING_AGENTS","SYSTEM_AWAY_AGENTS","OFFLINE_AGENTS","ON_QUEUE_AGENTS","OFF_QUEUE_AGENTS","INTERACTING_AGENTS","ACW_AGENTS","COMMUNICATING_AGENTS","IDLE_AGENTS","NOT_RESPONDING_AGENTS","LONGEST_WAITING","LONGEST_INTERACTING","FLOW_ACTIVE_LONGEST","FLOW_ACTIVE_CURRENT","FLOW_ENTRIES_COUNT","FLOW_TOTAL_DURATION","FLOW_MAX_DURATION","FLOW_AVG_DURATION","FLOW_DISCONNECT_COUNT","FLOW_DISCONNECT_PERCENT","FLOW_TOTAL_DISCONNECT_DURATION","FLOW_AVG_DISCONNECT_DURATION","FLOW_MAX_DISCONNECT_DURATION","FLOW_FLOW_DISCONNECT","FLOW_FLOW_DISCONNECT_PERCENT","FLOW_SYSTEM_ERROR_DISCONNECT","FLOW_SYSTEM_ERROR_DISCONNECT_PERCENT","FLOW_CUSTOMER_DISCONNECT","FLOW_CUSTOMER_DISCONNECT_PERCENT","FLOW_SHORT_DISCONNECT","FLOW_SHORT_DISCONNECT_PERCENT","FLOW_EXIT_COUNT","FLOW_EXIT_PERCENT","FLOW_TOTAL_EXIT_DURATION","FLOW_MAX_EXIT_DURATION","FLOW_AVG_EXIT_DURATION","FLOW_ACD_EXIT_COUNT","FLOW_ACD_EXIT_PERCENT","FLOW_GROUP_EXIT_COUNT","FLOW_GROUP_EXIT_PERCENT","FLOW_NUMBER_EXIT_COUNT","FLOW_NUMBER_EXIT_PERCENT","FLOW_USER_EXIT_COUNT","FLOW_USER_EXIT_PERCENT","FLOW_FLOW_EXIT_COUNT","FLOW_FLOW_EXIT_PERCENT","FLOW_SECURE_FLOW_EXIT_COUNT","FLOW_SECURE_FLOW_EXIT_PERCENT","FLOW_ACD_VOICEMAIL_EXIT_COUNT","FLOW_ACD_VOICEMAIL_EXIT_PERCENT","FLOW_USER_VOICEMAIL_EXIT_COUNT","FLOW_USER_VOICEMAIL_EXIT_PERCENT","FLOW_OUTCOME_COUNT","FLOW_AVG_OUTCOME_DECIMAL","FLOW_OUTCOME_FAILURE_COUNT","FLOW_OUTCOME_FAILURE_PERCENT","FLOW_OUTCOME_SUCCESS_COUNT","FLOW_OUTCOME_SUCCESS_PERCENT","FLOW_OUTCOME_TOTAL_DURATION","FLOW_OUTCOME_MAX_DURATION","FLOW_OUTCOME_AVG_DURATION","FLOW_OUTCOME_MIN_DURATION","OFF_QUEUE_TIME","OFF_QUEUE_PERCENT","AVAILABLE_TIME","AVAILABLE_PERCENT","BUSY_TIME","BUSY_PERCENT","AWAY_TIME","AWAY_PERCENT","BREAK_TIME","BREAK_PERCENT","MEAL_TIME","MEAL_PERCENT","MEETING_TIME","MEETING_PERCENT","TRAINING_TIME","TRAINING_PERCENT","INTERACTING_TIME","INTERACTING_PERCENT","COMMUNICATING_TIME","COMMUNICATING_PERCENT","SYSTEM_AWAY_TIME","SYSTEM_AWAY_PERCENT","ON_QUEUE_TIME","ON_QUEUE_PERCENT","IDLE_TIME","IDLE_PERCENT","NOT_RESPONDING_TIME","NOT_RESPONDING_PERCENT","LOGGED_IN_TIME","OCCUPANCY_PERCENT","MIN_ALERT_TIME","MAX_ALERT_TIME","MIN_HANDLE_TIME","MAX_HANDLE_TIME","MIN_ANSWERED_TIME","MAX_ANSWERED_TIME","MIN_NOT_RESPONDING_TIME","MAX_NOT_RESPONDING_TIME","MET_SERVICE_LEVEL","WFM_ADHERENCE_STATUS","WFM_SCHEDULED_ACTIVITY","WFM_ADHERENCE_DURATION","AGENT_TITLE","AGENT_DEPARTMENT","AGENT_EXTENSION","AGENT_SKILLS","AGENT_LOCATION","AGENT_REPORTS_TO","AGENT_EMAIL","AGENT_ROLE","AGENT_GROUP","AGENT_TIME_IN_STATUS","AGENT_TIME_IN_ROUTING_STATUS","AGENT_STATUS","AGENT_SECONDARY_STATUS","AGENT_ROUTING_STATUS","AGENT_MEDIA_TYPES","ACW_COUNT","ANSWER_TRANSFERRED_PERCENT","FLOW_AVG_MILESTONE_DECIMAL","NOT_RESPONDING_COUNT","AVG_ACW_HANDLED","AVG_CONTACTING_TIME","AVG_DIALING_TIME","AVG_FLOWOUT_TIME","AVG_HOLD_HANDLED","AVG_MONITOR","BLIND_TRANSFER_COUNT","BLIND_TRANSFER_PERCENT","CONNECTED_COUNT","CONSULT_COUNT","CONSULT_TRANSFER_COUNT","CONSULT_TRANSFER_PERCENT","CONTACTING_COUNT","DIALING_COUNT","ERROR_COUNT","EXTERNAL_MEDIA_COUNT","MAX_CONTACTING_TIME","MAX_DIALING_TIME","MAX_FLOWOUT_TIME","FLOW_MILESTONE_COUNT","MIN_FLOWOUT_TIME","MAX_MONITOR","MIN_CONTACTING_TIME","MIN_DIALING_TIME","MIN_MONITOR","MONITOR_COUNT","MEDIA_COUNT","SERVICE_LEVEL_TARGET","SERVICE_LEVEL_TARGET_CURRENT","TALK_COUNT","TOTAL_ABANDON_TIME","TOTAL_NOT_RESPONDING_TIME","TOTAL_CONTACTING","TOTAL_DIALING","TOTAL_MONITOR","TOTAL_WAIT_TIME","WAIT_COUNT","PARK_COUNT","AVG_PARK_TIME","TOTAL_PARK_TIME","MIN_PARK_TIME","MAX_PARK_TIME"]}},"displayText":{"type":"string","description":"The display text for the dashboard widget configuration."},"displayTextColor":{"type":"string","description":"The color of the display text for the dashboard widget configuration in RGB hexadecimal format (for example \"#FF0000\" represents red)."},"webContentUrl":{"type":"string","description":"The external web URL for the dashboard widget configuration."},"splitFilters":{"type":"boolean","description":"Indicates each filter to be displayed individually."},"splitByMediaType":{"type":"boolean","description":"Indicates that data for each media type should be shown individually."},"showLongest":{"type":"boolean","description":"Indicates the display be the longest time."},"displayAsTable":{"type":"boolean","description":"Indicates the widget to be displayed as table."},"showDuration":{"type":"boolean","description":"Indicates the display to include duration."},"sortOrder":{"type":"string","description":"The sort order of the table.","enum":["ascending","descending"]},"sortKey":{"type":"string","description":"The sort key of the table.","enum":["Name","Duration"]},"entityLimit":{"type":"integer","format":"int32","description":"Indicates the limit of displayed entities."},"displayAggregates":{"type":"boolean","description":"Indicates whether to display aggregate across all entity and media type combination."},"isFullWidth":{"type":"boolean","description":"Indicates whether a widget should take the full width of a dashboard or be shown only in a single slot."},"showPercentageChange":{"type":"boolean","description":"Indicates whether a widget should show the percentage diff between two values."},"showProfilePicture":{"type":"boolean","description":"Indicates whether a widget should show the profile picture of an agent."},"filter":{"description":"The filters to be applied for dashboard widget configuration","$ref":"#/definitions/ViewFilter"},"periods":{"type":"array","description":"The list of periods for the dashboard widget configuration","items":{"type":"string","enum":["NONE","CURRENT_HALF_HOUR","TODAY","YESTERDAY","THIS_WEEK","LAST_WEEK","THIS_MONTH","LAST_MONTH","PRIOR_7_DAYS","PAST_7_DAYS_TO_DATE","PRIOR_30_DAYS","PAST_30_DAYS_TO_DATE","PRIOR_3_MONTHS"]}},"mediaTypes":{"type":"array","description":"The list of media types for the dashboard widget configuration","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"warnings":{"type":"array","description":"List of warnings for dashboard widget configuration","items":{"$ref":"#/definitions/Warning"}},"showTimeInStatus":{"type":"boolean","description":"Indicates the show time in status of a widget configuration."},"showOfflineAgents":{"type":"boolean","description":"Indicates to show offline agent widget."},"selectedStatuses":{"type":"array","description":"Indicates the selected statuses used to filter the agent widget in the dashboard.","items":{"type":"string","enum":["Available","Away","Busy","Break","Meeting","Training","Meal","SystemAway","OnQueue","Interacting","NotResponding","Idle","Communicating","OffQueue","Online","Offline"]}}}},"Empty":{"type":"object"},"DashboardConfigurationBulkRequest":{"type":"object","required":["dashboardConfigurationIds"],"properties":{"dashboardConfigurationIds":{"type":"array","description":"The user supplied dashboard configuration ids","items":{"type":"string"}}}},"DashboardConfigurationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DashboardConfiguration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DashboardConfigurationQueryRequest":{"type":"object","required":["dashboardConfigurationIds"],"properties":{"dashboardConfigurationIds":{"type":"array","description":"The user supplied dashboard configuration ids","items":{"type":"string"}},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The order in which response will be sorted","enum":["Asc","Desc"]}}},"DashboardUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dashboardCount":{"type":"integer","format":"int32","description":"The count of dashboards for the user"},"publicDashboardCount":{"type":"integer","format":"int32","description":"The count of public dashboards for the user"},"state":{"type":"string","description":"The state of the user","enum":["active","inactive"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DashboardUserListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DashboardUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportJobResponse":{"type":"object","required":["createdDateTime","exportFormat","filter","interval","locale","modifiedDateTime","percentageComplete","period","read","runId","status","timeZone","viewType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"runId":{"type":"string","description":"The unique run id of the export schedule execute"},"status":{"type":"string","description":"The current status of the export request","enum":["SUBMITTED","RUNNING","CANCELLING","CANCELLED","COMPLETED","COMPLETED_WITH_PARTIAL_RESULTS","FAILED"]},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"downloadUrl":{"type":"string","description":"The url to download the request if it's status is completed"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"exportErrorMessagesType":{"type":"string","description":"The error message in case the export request failed","enum":["FAILED_CONVERTING_EXPORT_JOB","FAILED_NO_DATA_EXPORT_JOB_FOUND","FAILED_GETTING_DATA_FROM_SERVICE","FAILED_GENERATING_TEMP_FILE","FAILED_SAVING_FILE_TO_S3","FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD","FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE","FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB","EXPORT_TYPE_NOT_IMPLEMENTED","REACHED_MAXIMUM_ATTEMPT_OF_RETRY","FAILED_LONG_RUNNING_EXPORT","TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION","FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB","NOT_AUTHORIZED_TO_VIEW_EXPORT","STATIC_LINK_EXPORT_FAILED","TOO_MANY_SEARCH_CRITERIA","SEARCH_CRITERIA_VALUES_EXCEED_LIMIT","EXPORT_EMAIL_FILE_SIZE_EXCEEDED_LIMIT","CIRCUIT_BREAKER_OPEN_FOR_VIEW_TYPE"]},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"createdDateTime":{"type":"string","format":"date-time","description":"The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDateTime":{"type":"string","format":"date-time","description":"The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"percentageComplete":{"type":"number","format":"double","description":"The percentage of the job that has completed processing"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"emailStatuses":{"type":"object","description":"The status of individual email addresses as a map","additionalProperties":{"type":"string","enum":["Sent","Pending","Failed"]}},"emailErrorDescription":{"type":"string","description":"The optional error message in case the export fail to email"},"includeDurationFormatInHeader":{"type":"boolean","description":"Indicates whether to include selected duration format to the column headers"},"durationFormat":{"type":"string","description":"Indicates the duration format for the exports","enum":["Seconds","Milliseconds","Hhmmss","Hms"]},"exportAllowedToRerun":{"type":"boolean","description":"Indicates whether the export run is allowed to rerun"},"enabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SelectedColumns":{"type":"object","properties":{"columnOrder":{"type":"integer","format":"int32","description":"Indicates the order/position of the selected column"},"columnName":{"type":"string","description":"Indicates enum name of the column from the export view"}}},"ReportingExportJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportMetadataJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"viewType":{"type":"string","description":"The view type of the export metadata","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"dateLimitations":{"type":"string","description":"The date limitations of the export metadata"},"requiredFilters":{"type":"array","description":"The list of required filters for the export metadata","items":{"type":"string"}},"supportedFilters":{"type":"array","description":"The list of supported filters for the export metadata","items":{"type":"string"}},"requiredColumnIds":{"type":"array","description":"The list of required column ids for the export metadata","items":{"type":"string"}},"dependentColumnIds":{"type":"object","description":"The list of dependent column ids for the export metadata","additionalProperties":{"type":"array","items":{"type":"string"}}},"availableColumnIds":{"type":"array","description":"The list of available column ids for the export metadata","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportingExportJobRequest":{"type":"object","required":["exportFormat","filter","interval","locale","name","period","timeZone","viewType"],"properties":{"name":{"type":"string","description":"The user supplied name of the export request"},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","DASHBOARD_USERS","DASHBOARD_USERS_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW","AGENT_SCORECARD_VIEW","AGENT_SCORECARD_ME_VIEW","AGENT_GAMIFICATION_LEADERSHIP_VIEW","AGENT_SCHEDULE_ME_VIEW","BOT_PERFORMANCE_SUMMARY_VIEW","BOT_PERFORMANCE_DETAIL_VIEW","SCHEDULED_EXPORTS_VIEW","TOPIC_TREND_SUMMARY_VIEW","TOPIC_TREND_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_DETAIL_VIEW","ACTION_MAP_BLOCKED_CONSTRAINTS_INTERVAL_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_DETAIL_VIEW","FLOW_MILESTONE_PERFORMANCE_INTERVAL_DETAIL_VIEW","AGENT_TOPIC_SUMMARY_VIEW","AGENT_TOPIC_DETAIL_VIEW","QUEUE_TOPIC_SUMMARY_VIEW","QUEUE_TOPIC_DETAIL_VIEW","FLOW_TOPIC_SUMMARY_VIEW","FLOW_TOPIC_DETAIL_VIEW","AGENT_INTERACTIONS_ME_VIEW","ALERT_RULES_VIEW","CONFIGURE_ALERT_RULE_VIEW","PREDICTIVE_ROUTING_VIEW","PREDICTIVE_ROUTING_QUEUE_OVERVIEW","PREDICTIVE_ROUTING_MODEL_VIEW","PREDICTIVE_ROUTING_IMPACT_VIEW","DATA_ACTIONS_PERFORMANCE_SUMMARY_VIEW","DATA_ACTIONS_PERFORMANCE_DETAIL_VIEW","AGENT_TIMELINE_SUMMARY_VIEW","AGENT_TIMELINE_DETAIL_VIEW","AGENT_LOGIN_LOGOUT_SUMMARY_VIEW","AGENT_LOGIN_LOGOUT_DETAIL_VIEW","CAMPAIGN_PERFORMANCE_SUMMARY_VIEW","CAMPAIGN_PERFORMANCE_DETAIL_VIEW","KNOWLEDGE_PERFORMANCE_VIEW","AGENT_SCORECARD_INSIGHTS_SUMMARY_VIEW","AGENT_SCORECARD_INSIGHTS_DETAIL_VIEW","QUEUE_WRAPUP_DETAIL_VIEW","INTERACTION_DETAIL_VIEW","CAMPAIGN_INTERACTION_DETAIL_VIEW","CAMPAIGN_ATTEMPT_DETAIL_VIEW","WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_ASSIST_PERFORMANCE_VIEW","CONTACT_CENTER_PERFORMANCE_VIEW","QUEUE_ROUTING_PERFORMANCE_VIEW","AGENT_WORKITEM_PERFORMANCE_SUMMARY_VIEW","AGENT_WORKITEM_PERFORMANCE_DETAIL_VIEW","QUEUE_WORKITEM_PERFORMANCE_SUMMARY_VIEW","QUEUE_WORKITEM_PERFORMANCE_DETAIL_VIEW","EMAIL_AGENT_PERFORMANCE_SUMMARY_VIEW","EMAIL_AGENT_PERFORMANCE_DETAIL_VIEW","MESSAGING_AGENT_PERFORMANCE_SUMMARY_VIEW","MESSAGING_AGENT_PERFORMANCE_DETAIL_VIEW","EMAIL_QUEUE_PERFORMANCE_SUMMARY_VIEW","EMAIL_QUEUE_PERFORMANCE_DETAIL_VIEW","MESSAGING_QUEUE_PERFORMANCE_SUMMARY_VIEW","MESSAGING_QUEUE_PERFORMANCE_DETAIL_VIEW"]},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"locale":{"type":"string","description":"The locale used for localization of the exported data, i.e. en-US, es"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"includeDurationFormatInHeader":{"type":"boolean","description":"Indicates whether to include selected duration format to the column headers"},"durationFormat":{"type":"string","description":"Indicates the duration format for the exports","enum":["Seconds","Milliseconds","Hhmmss","Hms"]}}},"FieldList":{"type":"object","properties":{"customLabels":{"type":"boolean"},"instructionText":{"type":"string"},"key":{"type":"string"},"labelKeys":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":{"type":"object"}},"repeatable":{"type":"boolean"},"state":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"gdpr":{"type":"boolean"}}},"Section":{"type":"object","properties":{"fieldList":{"type":"array","items":{"$ref":"#/definitions/FieldList"}},"instructionText":{"type":"string"},"key":{"type":"string"},"state":{"type":"string"}}},"KnowledgeBaseReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge base."},"languageCode":{"type":"string","description":"Language of the knowledge base","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditQueryEntity":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Entity"},"actions":{"type":"array","description":"List of Actions","items":{"type":"string"}}}},"AuditQueryService":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Service"},"entities":{"type":"array","description":"List of Entities","items":{"$ref":"#/definitions/AuditQueryEntity"}}}},"AuditQueryServiceMapping":{"type":"object","properties":{"services":{"type":"array","description":"List of Services","items":{"$ref":"#/definitions/AuditQueryService"}}}},"AuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIp":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message."},"level":{"type":"string","description":"Level of this audit message, USER or SYSTEM.","enum":["USER","SYSTEM","GENESYS_INTERNAL"]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"message":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place."},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted."},"status":{"type":"string","description":"Status of the event being audited","enum":["SUCCESS","FAILURE","WARNING"]},"application":{"type":"string","description":"Name of the application used to perform the audit's action"},"initiatingAction":{"description":"Id and action of the audit initiating the transaction","$ref":"#/definitions/InitiatingAction"},"transactionInitiator":{"type":"boolean","description":"Whether the current audit is the initiator of the transaction"},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}},"entityChanges":{"type":"array","description":"List of entities that were changed and changes made to those entities.","items":{"$ref":"#/definitions/EntityChange"}}}},"AuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"EntityChange":{"type":"object","properties":{"entityId":{"type":"string","description":"Id of the entity that was changed"},"entityName":{"type":"string","description":"Name of the entity that was changed"},"entityType":{"type":"string","description":"Type of the entity that was changed"},"oldValues":{"type":"array","description":"Previous values for the entity.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the entity.","items":{"type":"string"}}}},"InitiatingAction":{"type":"object","properties":{"transactionId":{"type":"string","description":"Id of the audit initiating the transaction"},"actionContext":{"type":"string","description":"Action of the audit initiating the transaction"}}},"MessageInfo":{"type":"object","properties":{"localizableMessageCode":{"type":"string","description":"Key that can be used to localize the message."},"message":{"type":"string","description":"Description of the message."},"messageWithParams":{"type":"string","description":"Message with template fields for variable replacement."},"messageParams":{"type":"object","description":"Map with fields for variable replacement.","additionalProperties":{"type":"string"}}}},"PropertyChange":{"type":"object","properties":{"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"Previous values for the property.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the property.","items":{"type":"string"}}}},"AuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"]},"startDate":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Service name for the audit query."},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","ClientId","Action","EntityType","EntityId"]},"value":{"type":"string","description":"Value of the property to filter."}}},"AuditQuerySort":{"type":"object","required":["name","sortOrder"],"properties":{"name":{"type":"string","description":"Name of the property to sort.","enum":["Timestamp"]},"sortOrder":{"type":"string","description":"Sort Order","enum":["ascending","descending"]}}},"AuditQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ"},"serviceName":{"type":"string","description":"Name of the service to query audits for."},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditRealtimeQueryResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"AuditRealtimeQueryRequest":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ"},"serviceName":{"type":"string","description":"Name of the service to query audits for."},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}},"pageNumber":{"type":"integer","format":"int32","description":"Page number"},"pageSize":{"type":"integer","format":"int32","description":"Page size"}}},"AuditRealtimeRelatedResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"AuditRealtimeRelatedRequest":{"type":"object","required":["auditId"],"properties":{"auditId":{"type":"string","description":"The id of the audit of which related audits will be retrieved."},"trustorOrgId":{"type":"string","description":"The id of the trustor org to which the audit belongs. Used when searching for audits performed by a trustee user within a trustor org."},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuthzGrant":{"type":"object","properties":{"subjectId":{"type":"string"},"division":{"$ref":"#/definitions/AuthzDivision"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"version":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivisionGrants":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","description":"A list containing pairs of role and division IDs","items":{"$ref":"#/definitions/RoleDivisionPair"}}}},"RoleDivisionPair":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"The ID of the role"},"divisionId":{"type":"string","description":"The ID of the division"}}},"UserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzDivisionGrantEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DivsPermittedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"allDivsPermitted":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthorizationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"analysisEnabled":{"type":"boolean","description":"Boolean showing if organization is opted in or not to unused role/perm analysis"},"analysisDays":{"type":"integer","format":"int32","description":"Integer number of days to analyze user usage"},"dateLastCalculated":{"type":"string","format":"date-time","description":"The date and time of the most recent unused role calculation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateLastActive":{"type":"string","format":"date","description":"The date of the most recent org activity used for analysis. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT","AGENT_REQUESTED"]},"timeoutMs":{"type":"integer","format":"int32","description":"The amount of time the agent can stay in ACW (Min: 1 sec, Max: 15 min). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT."}}},"AgentOwnedRouting":{"type":"object","properties":{"enableAgentOwnedCallbacks":{"type":"boolean","description":"Indicates if Agent Owned Callbacks are enabled for the queue"},"maxOwnedCallbackHours":{"type":"integer","format":"int32","description":"The max amount of time a callback can be owned (in hours); Allowable range 1 - 168 hour(s) (inclusive)"},"maxOwnedCallbackDelayHours":{"type":"integer","format":"int32","description":"The max amount of time a callback can be scheduled out into the future (in hours); Allowable range 1 - 720 hour(s) (inclusive)"}}},"BaseMediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","description":"The bullseye rings configured for this queue.","items":{"$ref":"#/definitions/Ring"}}}},"CallbackMediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."},"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"The alerting timeout for the media type, in seconds"},"serviceLevel":{"description":"The targeted service level for the media type","$ref":"#/definitions/ServiceLevel"},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for an auto-answer interaction"},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for a manual-answer interaction"},"subTypeSettings":{"type":"object","description":"Map of media subtype to media subtype specific settings.","additionalProperties":{"$ref":"#/definitions/BaseMediaSettings"}},"enableAutoDialAndEnd":{"type":"boolean","description":"Flag to enable Auto-Dial and Auto-End automation for callbacks on this queue."},"autoDialDelaySeconds":{"type":"integer","format":"int32","description":"Time in seconds after agent connects to callback before outgoing call is auto-dialed. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds."},"autoEndDelaySeconds":{"type":"integer","format":"int32","description":"Time in seconds after agent disconnects from the outgoing call before the encasing callback is auto-ended. Allowable values in range 0 - 1200 seconds. Defaults to 300 seconds."}}},"CannedResponseLibraries":{"type":"object","properties":{"libraryIds":{"type":"array","description":"Set of canned response library IDs associated with the queue only when mode is SelectedOnly.","uniqueItems":true,"items":{"type":"string"}},"mode":{"type":"string","description":"The association mode of canned response libraries to queue","enum":["All","SelectedOnly","None"]}}},"ConditionalGroupRouting":{"type":"object","properties":{"rules":{"type":"array","description":"The set of rules to be executed for each conversation","items":{"$ref":"#/definitions/ConditionalGroupRoutingRule"}}}},"ConditionalGroupRoutingRule":{"type":"object","properties":{"queue":{"description":"The queue being evaluated for this rule. If null, the current queue will be used.","$ref":"#/definitions/DomainEntityRef"},"metric":{"type":"string","description":"The queue metric being evaluated","enum":["EstimatedWaitTime","ServiceLevel"]},"operator":{"type":"string","description":"The operator that compares the actual value against the condition value","enum":["GreaterThan","GreaterThanOrEqualTo","LessThan","LessThanOrEqualTo"]},"conditionValue":{"type":"number","format":"double","description":"The limit value, beyond which a rule evaluates as true"},"groups":{"type":"array","description":"The group(s) to activate if the rule evaluates as true","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"waitSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait in this rule, if it evaluates as true, before evaluating the next rule. For the final rule, this is ignored, so need not be specified."}}},"DirectRouting":{"type":"object","properties":{"callMediaSettings":{"description":"Direct Routing Settings specific to Call media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"emailMediaSettings":{"description":"Direct Routing Settings specific to Email media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"messageMediaSettings":{"description":"Direct Routing Settings specific to Message media.","$ref":"#/definitions/DirectRoutingMediaSettings"},"backupQueueId":{"type":"string","description":"ID of another queue to be used as the default backup if an agent does not have their Backup Settings configured. If not set, the current queue will be used as backup, but with Direct Routing criteria removed from the conversation."},"waitForAgent":{"type":"boolean","description":"Flag indicating if Direct Routing interactions should wait for Direct Routing agent or go immediately to selected backup."},"agentWaitSeconds":{"type":"integer","format":"int32","description":"Time (in seconds) that a Direct Routing interaction will wait for Direct Routing agent before going to selected backup. Valid range [60, 864000]."}}},"DirectRoutingMediaSettings":{"type":"object","properties":{"useAgentAddressOutbound":{"type":"boolean","description":"Toggle that enables using an agent's Direct Routing address outbound on behalf of queue for this media type."}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"]}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"InboundRoute":{"type":"object","required":["fromName","pattern"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/DomainEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/DomainEntityRef"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"flow":{"description":"The flow to use for processing the email.","$ref":"#/definitions/DomainEntityRef"},"replyEmailAddress":{"description":"The route to use for email replies.","$ref":"#/definitions/QueueEmailAddress"},"autoBcc":{"type":"array","description":"The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.","items":{"$ref":"#/definitions/EmailAddress"}},"spamFlow":{"description":"The flow to use for processing inbound emails that have been marked as spam.","$ref":"#/definitions/DomainEntityRef"},"signature":{"description":"The configuration for the canned response signature that will be appended to outbound emails sent via this route","$ref":"#/definitions/Signature"},"historyInclusion":{"type":"string","description":"The configuration to indicate how the history of a conversation has to be included in a draft","enum":["Include","Exclude","Optional"]},"allowMultipleActions":{"type":"boolean","description":"Control if multiple actions are allowed on this route. When true the disconnect has to be done manually. When false a conversation will be disconnected by the system after every action"},"imapFolder":{"type":"string","description":"Imap folder routed to this route"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaSettings":{"type":"object","properties":{"enableAutoAnswer":{"type":"boolean","description":"Indicates if auto-answer is enabled for the given media type or subtype (default is false). Subtype settings take precedence over media type settings."},"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"The alerting timeout for the media type, in seconds"},"serviceLevel":{"description":"The targeted service level for the media type","$ref":"#/definitions/ServiceLevel"},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for an auto-answer interaction"},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"How long to play the alerting tone for a manual-answer interaction"},"subTypeSettings":{"type":"object","description":"Map of media subtype to media subtype specific settings.","additionalProperties":{"$ref":"#/definitions/BaseMediaSettings"}}}},"MemberGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","description":"The group type","enum":["TEAM","GROUP","SKILLGROUP"]},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this group","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PredictiveRouting":{"type":"object","properties":{"respectSkills":{"type":"boolean","description":"A switch used to determine if agent skills will be considered."},"enableConversationScoreBiasing":{"type":"boolean","description":"A switch used to determine if conversations are weighted by conversation score when the system attempts to assign an agent a new conversation."}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueEmailAddress":{"type":"object","properties":{"domain":{"$ref":"#/definitions/DomainEntityRef"},"route":{"$ref":"#/definitions/InboundRoute"}}},"QueueMediaSettings":{"type":"object","properties":{"call":{"description":"The queue media settings for call interactions.","$ref":"#/definitions/MediaSettings"},"callback":{"description":"The queue media settings for callback interactions.","$ref":"#/definitions/CallbackMediaSettings"},"chat":{"description":"The queue media settings for chat interactions.","$ref":"#/definitions/MediaSettings"},"email":{"description":"The queue media settings for email interactions.","$ref":"#/definitions/MediaSettings"},"message":{"description":"The queue media settings for message interactions.","$ref":"#/definitions/MediaSettings"}}},"QueueMessagingAddresses":{"type":"object","properties":{"smsAddress":{"$ref":"#/definitions/DomainEntityRef"},"openMessagingRecipient":{"$ref":"#/definitions/DomainEntityRef"},"whatsAppRecipient":{"$ref":"#/definitions/DomainEntityRef"}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","description":"The conditions that will trigger conversations to move to the next bullseye ring.","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"description":"The actions that will be performed just before moving conversations to the next bullseye ring.","$ref":"#/definitions/Actions"},"memberGroups":{"type":"array","description":"The groups of agents associated with the ring, if any. Ring membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}}}},"RoutingRule":{"type":"object","properties":{"operator":{"type":"string","description":"matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score.","enum":["MEETS_THRESHOLD","ANY"]},"threshold":{"type":"integer","format":"int32","description":"threshold required for routing attempt (generally an agent score). may be null for operator ANY."},"waitSeconds":{"type":"number","format":"double","description":"seconds to wait in this rule before moving to the next"}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double","description":"The desired Service Level. A value between 0 and 1."},"durationMs":{"type":"integer","format":"int64","description":"Service Level target in milliseconds."}}},"Signature":{"type":"object","properties":{"enabled":{"type":"boolean","description":"A toggle to enable the signature on email send."},"cannedResponseId":{"type":"string","description":"The identifier referring to an email signature canned response."},"alwaysIncluded":{"type":"boolean","description":"A toggle that defines if a signature is always included or only set on the first email in an email chain."},"inclusionType":{"type":"string","description":"The configuration to indicate when the signature of a conversation has to be included","enum":["Draft","Send","SendOnce"]}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"SubjectDivisions":{"type":"object","required":["divisionIds","subjectIds"],"properties":{"subjectIds":{"type":"array","description":"A collection of subject IDs to associate with the given divisions","items":{"type":"string"}},"divisionIds":{"type":"array","description":"A collection of division IDs to associate with the given subjects","items":{"type":"string"}}}},"DomainOrganizationRoleUpdate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string","description":"The name of the role"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainOrganizationRoleCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"role id"},"name":{"type":"string","description":"The role name"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"allowsConditions":{"type":"boolean"},"divisionAware":{"type":"boolean"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"OrganizationProductEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"SubjectDivisionGrants":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"divisions":{"type":"array","items":{"$ref":"#/definitions/Division"}},"type":{"type":"string","enum":["PC_USER","PC_GROUP","PC_OAUTH_CLIENT","PC_TRUSTEE_USER","PC_TRUSTEE_GROUP","UNKNOWN"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubjectDivisionGrantsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SubjectDivisionGrants"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"ErrorBody":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}},"limit":{"$ref":"#/definitions/Limit"}}},"Limit":{"type":"object","properties":{"key":{"type":"string"},"namespace":{"type":"string","enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","social.media","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"value":{"type":"integer","format":"int64"}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["COUNT","SUM","AVERAGE","TERM","CONTAINS","STARTS_WITH","ENDS_WITH"]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"SearchSort":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"}}},"SignedData":{"type":"object","properties":{"jwt":{"type":"string"}}},"ScreenRecordingUserAuthenticatedInfo":{"type":"object","required":["backgroundAssistantId"],"properties":{"backgroundAssistantId":{"type":"string","description":"Id of Genesys Cloud Background Assistant"}}},"UrlResponse":{"type":"object","properties":{"url":{"type":"string"}}},"BillingUsage":{"type":"object","required":["name","resources","totalUsage"],"properties":{"name":{"type":"string","description":"Identifies the billable usage."},"totalUsage":{"type":"string","description":"The total amount of usage, expressed as a decimal number in string format."},"resources":{"type":"array","description":"The resources for which usage was observed (e.g. license users, devices).","items":{"$ref":"#/definitions/BillingUsageResource"}}}},"BillingUsageReport":{"type":"object","required":["endDate","startDate","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"Generation status of report","enum":["InProgress","Complete"]},"usages":{"type":"array","description":"The usages for the given period.","items":{"$ref":"#/definitions/BillingUsage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingUsageResource":{"type":"object","required":["date","name"],"properties":{"name":{"type":"string","description":"Identifies the resource (e.g. license user, device)."},"date":{"type":"string","format":"date-time","description":"The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"SubscriptionOverviewUsage":{"type":"object","required":["grouping","name","partNumber","prepayQuantity","unitOfMeasureType","usageQuantity"],"properties":{"name":{"type":"string","description":"Product charge name"},"partNumber":{"type":"string","description":"Product part number"},"grouping":{"type":"string","description":"UI grouping key"},"unitOfMeasureType":{"type":"string","description":"UI unit of measure"},"usageQuantity":{"type":"string","description":"Usage count for specified period"},"overagePrice":{"type":"string","description":"Price for usage / overage charge"},"prepayQuantity":{"type":"string","description":"Items prepaid for specified period"},"prepayPrice":{"type":"string","description":"Price for prepay charge"},"usageNotes":{"type":"string","description":"Notes about the usage/charge item"},"isCancellable":{"type":"boolean","description":"Indicates whether the item is cancellable"},"bundleQuantity":{"type":"string","description":"Quantity multiplier for this charge"},"isThirdParty":{"type":"boolean","description":"A charge from a third party entity"}}},"TrusteeBillingOverview":{"type":"object","required":["currency","enabledProducts","organization","subscriptionType","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"organization":{"description":"Organization","$ref":"#/definitions/NamedEntity"},"currency":{"type":"string","description":"The currency type."},"enabledProducts":{"type":"array","description":"The charge short names for products enabled during the specified period.","items":{"type":"string"}},"subscriptionType":{"type":"string","description":"The subscription type.","enum":["ININ","MONTH_TO_MONTH","FREE_TRIAL_MONTH_TO_MONTH","PREPAY_MONTHLY_COMMITMENT","PREPAY","DEV_ORG_MONTH_TO_MONTH","DEV_ORG_PREPAY_MONTHLY_COMMITMENT","DEV_ORG_PREPAY"]},"rampPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rampPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"usages":{"type":"array","description":"Usages for the specified period.","items":{"$ref":"#/definitions/SubscriptionOverviewUsage"}},"contractAmendmentDate":{"type":"string","format":"date-time","description":"Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEndDate":{"type":"string","format":"date-time","description":"Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"minimumMonthlyAmount":{"type":"string","description":"Minimum amount that will be charged for the month"},"inRampPeriod":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","description":"Whether or not CallForwarding is enabled"},"phoneNumber":{"type":"string","description":"This property is deprecated. Please use the calls property"},"calls":{"type":"array","description":"An ordered list of CallRoutes to be executed when CallForwarding is enabled","items":{"$ref":"#/definitions/CallRoute"}},"voicemail":{"type":"string","description":"The type of voicemail to use with the callForwarding configuration","enum":["PURECLOUD","LASTCALL","NONE"]},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallRoute":{"type":"object","properties":{"targets":{"type":"array","description":"A list of CallTargets to be called when the CallRoute is executed","items":{"$ref":"#/definitions/CallTarget"}}}},"CallTarget":{"type":"object","properties":{"type":{"type":"string","description":"The type of call","enum":["STATION","PHONENUMBER"]},"value":{"type":"string","description":"The id of the station or an E.164 formatted phone number"}}},"EmergencyLocation":{"type":"object","required":["address","did","source"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"address":{"description":"Emergency address","$ref":"#/definitions/LocationAddress"},"did":{"type":"string","description":"Phone number in E164 format"},"source":{"type":"string","description":"source","enum":["Admin","User"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"Organization":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"defaultLanguage":{"type":"string","description":"The default language for this organization. Example: 'en'"},"defaultCountryCode":{"type":"string","description":"The default country code for this organization. Example: 'US'"},"thirdPartyOrgName":{"type":"string","description":"The short name for the organization. This field is globally unique and cannot be changed.","readOnly":true},"thirdPartyURI":{"type":"string","format":"uri"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","description":"The current state. Examples are active, inactive, deleted.","enum":["active","inactive","deleted"]},"defaultSiteId":{"type":"string"},"supportURI":{"type":"string","description":"Email address where support tickets are sent to."},"voicemailEnabled":{"type":"boolean"},"productPlatform":{"type":"string","description":"Organizations Originating Platform.","readOnly":true,"enum":["GenesysCloud","PureCloud","PureEngage","PureEngageCloud","PureConnect","PureConnectCloud","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"features":{"type":"object","description":"The state of features available for the organization.","readOnly":true,"additionalProperties":{"type":"boolean"}}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object"}}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise."},"valid":{"type":"boolean"},"signatureValid":{"type":"boolean"}},"description":"Represents the details of a parsed certificate."},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"ChatSettings":{"type":"object","properties":{"messageRetentionPeriodDays":{"type":"integer","format":"int32","description":"Retention time for messages in days"}}},"ChatMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatMessageResponse"}}}},"ChatMessageResponse":{"type":"object","required":["body","dateCreated","id","jid","thread","toJid"],"properties":{"id":{"type":"string","description":"The id of the message"},"dateCreated":{"type":"string","format":"date-time","description":"Message's created time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Message's last updated time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toJid":{"type":"string","description":"Jid of message's recipient (roomJid or userJid)"},"jid":{"type":"string","description":"Jid of message's sender (userJid)"},"body":{"type":"string","description":"Message's body"},"mentions":{"type":"object","description":"Message's mentions","additionalProperties":{"type":"string"}},"edited":{"type":"boolean","description":"If message was edited"},"attachmentDeleted":{"type":"boolean","description":"If message's attachment was deleted"},"fileUri":{"type":"string","description":"URI of file attachment"},"thread":{"description":"The id for a thread this message corresponds to","$ref":"#/definitions/Entity"},"parentThread":{"description":"Parent thread id for thread replies","$ref":"#/definitions/Entity"},"user":{"description":"The user who sent the message","$ref":"#/definitions/AddressableEntityRef"},"toUser":{"description":"The receiving user of the message","$ref":"#/definitions/AddressableEntityRef"},"reactions":{"type":"array","description":"The emoji reactions to this message","items":{"$ref":"#/definitions/ChatReaction"}}}},"ChatReaction":{"type":"object","required":["emoji","users"],"properties":{"emoji":{"type":"string","description":"The emoji string for the reaction"},"users":{"type":"array","description":"The users that reacted with an emoji","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"MetadataItem":{"type":"object","properties":{"text":{"type":"string","description":"The text contents of the metadata"},"attributes":{"type":"object","description":"The custom attributes for the metadata","additionalProperties":{"type":"string"}}}},"ChatReactionUpdate":{"type":"object","required":["reactions"],"properties":{"reactions":{"type":"array","description":"Reactions to update","items":{"type":"string"}}}},"ChatSendMessageResponse":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the created message"}}},"SendMessageBody":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The body of the message"},"mentions":{"type":"array","description":"user ids to be notified","items":{"type":"string"}},"threadId":{"type":"string","description":"The thread id of the message"}}},"PinnedMessageRequest":{"type":"object","required":["pinnedMessageIds"],"properties":{"pinnedMessageIds":{"type":"array","description":"Ids of the messages to pin","items":{"type":"string"}}}},"RoomParticipant":{"type":"object","required":["participantJid"],"properties":{"participantJid":{"type":"string","description":"participantJid"}}},"RoomParticipantResponse":{"type":"object","properties":{"jid":{"type":"string","description":"jid of the participant"},"user":{"description":"User id of the participant","$ref":"#/definitions/AddressableEntityRef"}}},"RoomParticipantsResponse":{"type":"object","properties":{"participants":{"type":"array","description":"list of room participants","items":{"$ref":"#/definitions/RoomParticipantResponse"}}}},"Room":{"type":"object","properties":{"id":{"type":"string","description":"The jid of the room","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Room's created time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomType":{"type":"string","description":"The type of room","enum":["adhoc","acd","group","oneOnOne","supervisorAssistance"]},"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"participantLimit":{"type":"integer","format":"int32","description":"Room's size limit"},"owners":{"type":"array","description":"Room's owners","items":{"$ref":"#/definitions/UserReference"}},"pinnedMessages":{"type":"array","description":"Room's pinned messages","items":{"$ref":"#/definitions/AddressableEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoomUpdateRequest":{"type":"object","properties":{"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"pinnedMessageIds":{"type":"array","description":"Room's pinned messages","items":{"type":"string"}},"ownerIds":{"type":"array","description":"Room's owners","items":{"type":"string"}}}},"CreateRoomResponse":{"type":"object","required":["jid"],"properties":{"jid":{"type":"string","description":"The jid of the room"}}},"CreateRoomRequest":{"type":"object","required":["subject"],"properties":{"description":{"type":"string","description":"Room's description"},"subject":{"type":"string","description":"Room's subject"},"userIds":{"type":"array","description":"Users to add to the room","items":{"type":"string"}}}},"CobrowseWebMessagingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"joinCode":{"type":"string","description":"Cobrowse session join code","readOnly":true},"websocketUrl":{"type":"string","description":"WebSocket URL for the JS client","readOnly":true},"dateOfferEnds":{"type":"string","format":"date-time","description":"Date when Cobrowse Offer Expires. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"communicationType":{"type":"string","description":"CommunicationType for Cobrowse Session","readOnly":true,"enum":["Call","Message","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExportScriptResponse":{"type":"object","properties":{"url":{"type":"string"}}},"ExportScriptRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"The final file name (no extension) of the script download: .script"},"versionId":{"type":"string","description":"The UUID version of the script to be exported. Defaults to the current editable version."}},"description":"Creating an exported script via Download Service"},"ImportScriptStatusResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"succeeded":{"type":"boolean"},"message":{"type":"string"}}},"ScriptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishScriptRequestData":{"type":"object","required":["scriptId"],"properties":{"scriptId":{"type":"string","description":"The id of the script to publish"},"versionId":{"type":"string"}}},"ConversationEncryptionConfiguration":{"type":"object","required":["keyConfigurationType","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"keyConfigurationType is always KmsSymmetric, and should be the arn to the key alias for the master key"},"keyConfigurationType":{"type":"string","description":"Type should be 'KmsSymmetric' when create or update Key configurations, 'None' to disable configuration.","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"lastError":{"description":"The error message related to the configuration","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ConversationEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"AiScoringSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if AI scoring feature is configured, false if not."},"prompt":{"type":"string","description":"The prompt text that would be used by a LLM."}}},"AnswerOption":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"value":{"type":"integer","format":"int32"},"assistanceConditions":{"type":"array","description":"List of assistance conditions which are combined together with a logical AND operator. Eg ( assistanceCondtion1 && assistanceCondition2 ) wherein assistanceCondition could be ( EXISTS topic1 || topic2 || ... ) or (NOTEXISTS topic3 || topic4 || ...).","items":{"$ref":"#/definitions/AssistanceCondition"}}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"]}}},"AssistanceCondition":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for the assistance condition. The operator defines whether the listed topicIds should EXIST or NOTEXIST for the condition to be evaluated as true.","enum":["EXISTS","NOTEXISTS"]},"topicIds":{"type":"array","description":"List of topicIds within the assistance condition which would be combined together using logical OR operator. Eg ( topicId_1 || topicId_2 ) .","items":{"type":"string"}}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"},"durationMode":{"type":"string","enum":["Between","Over","Under"]}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","enum":["YES","NO"]}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"EvaluationForm":{"type":"object","required":["name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"publishedVersions":{"description":"A list of the published versions of this form. Not populated by default, its availability depends on the endpoint. Use the 'expand=publishHistory' query parameter to retrieve this data where applicable (refer to the endpoint description to see if it is applicable).","$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"isKill":{"type":"boolean"},"isCritical":{"type":"boolean"}}},"EvaluationQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"EvaluationSettings":{"type":"object","properties":{}},"EvaluationSettingsAssignee":{"type":"object","properties":{}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean"},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"IntegrationExport":{"type":"object","required":["integration"],"properties":{"integration":{"description":"The aws-s3-recording-bulk-actions-integration that the policy uses for exports.","$ref":"#/definitions/DomainEntityRef"},"shouldExportScreenRecordings":{"type":"boolean","description":"True if the policy should export screen recordings in addition to the other conversation media. Default = true"}}},"Language":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The language name."},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["active","inactive","deleted"]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/MessageMediaPolicy"}}},"MediaTranscription":{"type":"object","properties":{"displayName":{"type":"string"},"transcriptionProvider":{"type":"string","enum":["VOCI","CALLJOURNEY"]},"integrationId":{"type":"string"}}},"MessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"MessageMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","enum":["YES","NO"]}}},"MeteredAssignmentByAgent":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"timeInterval":{"$ref":"#/definitions/TimeInterval"},"timeZone":{"type":"string"}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean"},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"assignSurveys":{"type":"array","items":{"$ref":"#/definitions/SurveyAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"teams":{"type":"array","description":"Teams to match conversations against","items":{"$ref":"#/definitions/Team"}},"customerParticipation":{"type":"string","description":"This condition is to filter out conversation with and without customer participation.","enum":["YES","NO"]}}},"PolicyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"PublishedSurveyFormReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contextId":{"type":"string","description":"The context id of this form."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"StarrableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyAssignment":{"type":"object","required":["sendingDomain"],"properties":{"surveyForm":{"description":"The survey form used for this survey.","$ref":"#/definitions/PublishedSurveyFormReference"},"flow":{"description":"The URI reference to the flow associated with this survey.","$ref":"#/definitions/DomainEntityRef"},"inviteTimeInterval":{"type":"string","description":"An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days."},"sendingUser":{"type":"string","description":"User together with sendingDomain used to send email, null to use no-reply"},"sendingDomain":{"type":"string","description":"Validated email domain, required"}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean"}}},"TimeInterval":{"type":"object","properties":{"months":{"type":"integer","format":"int32"},"weeks":{"type":"integer","format":"int32"},"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string","description":"start time in xx:xx:xx.xxx format"},"stopTime":{"type":"string","description":"stop time in xx:xx:xx.xxx format"},"day":{"type":"integer","format":"int32","description":"Day for this time slot, Monday = 1 ... Sunday = 7"}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"UserReferenceWithName":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VisibilityCondition":{"type":"object","properties":{"combiningOperation":{"type":"string","enum":["AND","OR"]},"predicates":{"type":"array","description":"A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based","items":{"type":"object"}}}},"WrapupCode":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/StarrableDivision"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","description":"The ID of the user that created the wrap-up code."},"modifiedBy":{"type":"string","description":"The ID of the user that modified the wrap-up code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformCallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CrossPlatformChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"CrossPlatformEmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"CrossPlatformMediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CrossPlatformCallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/CrossPlatformChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/CrossPlatformEmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/CrossPlatformMessageMediaPolicy"}}},"CrossPlatformMessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"CrossPlatformPolicy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"CrossPlatformPolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyUpdate":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"PolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyUpdate":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"keydataSummary":{"type":"string","description":"key data summary (base 64 encoded public key)"},"user":{"description":"user that requested generation of public key","$ref":"#/definitions/User"},"localEncryptionConfiguration":{"description":"Local configuration","$ref":"#/definitions/LocalEncryptionConfiguration"},"keyConfigurationType":{"type":"string","description":"Key type used in this configuration","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"kmsKeyArn":{"type":"string","description":"ARN of internal key to be wrapped by AWS KMS Symmetric key"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocalEncryptionConfiguration":{"type":"object","required":["apiId","apiKey","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The url for decryption. This must specify the path to where Purecloud can requests decryption"},"apiId":{"type":"string","description":"The api id for Hawk Authentication."},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocalEncryptionKeyRequest":{"type":"object","required":["configId","keypairId","publicKey"],"properties":{"configId":{"type":"string","description":"The local configuration id that contains metadata on private local service"},"publicKey":{"type":"string","description":"Base 64 encoded public key, generated by the local service."},"keypairId":{"type":"string","description":"The key pair id from the local service."}}},"RecordingEncryptionConfiguration":{"type":"object","required":["keyConfigurationType","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"When keyConfigurationType is LocalKeyManager, this should be the url for decryption and must specify the path to where GenesysCloud can requests decryption. When keyConfigurationType is KmsSymmetric, this should be the arn to the key alias for the master key"},"apiId":{"type":"string","description":"The api id for Hawk Authentication. Null if keyConfigurationType is KmsSymmetric"},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication. Null if keyConfigurationType is KmsSymmetric"},"keyConfigurationType":{"type":"string","description":"Type should be LocalKeyManager or KmsSymmetric when create or update Key configurations; 'Native' for disabling configuration.","enum":["KmsSymmetric","LocalKeyManager","Native","None"]},"lastError":{"description":"The error message related to the configuration","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"BulkDeleteResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultVoidEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkError":{"type":"object","properties":{"message":{"type":"string","description":"Error message of the bulk operation result."},"code":{"type":"string","description":"Error code of the bulk operation result."}}},"BulkErrorDetail":{"type":"object","properties":{"fieldName":{"type":"string"},"value":{"type":"string"},"message":{"type":"string"}}},"BulkErrorEntity":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Entity"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkResponseResultVoidEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Void"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"Void":{"type":"object"},"BulkIdsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContactsEntity"}}}},"ExternalContactsEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"BulkContactsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalContactExternalContact"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkErrorExternalContact":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkResponseResultExternalContactExternalContact":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"error":{"$ref":"#/definitions/BulkErrorExternalContact"}}},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"ContactAddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ContactIdentifier":{"type":"object","required":["type","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of this identifier","enum":["SocialLine","SocialFacebook","SocialTwitter","SocialWhatsapp","Email","Phone","Cookie","ExternalId"]},"value":{"type":"string","description":"The string value of the identifier. Will vary in syntax by type."},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataSchema":{"type":"object","required":["jsonSchema","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The schema's version, a positive integer. Required for updates."},"appliesTo":{"type":"array","description":"One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","EXTERNAL_ORGANIZATION","OPEN_ACTION","WORKITEM"]}},"enabled":{"type":"boolean","description":"The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."},"createdBy":{"description":"The URI of the user that created this schema.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"jsonSchema":{"example":"{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}","description":"A JSON schema defining the extension to the built-in entity type.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalContact":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"firstName":{"type":"string","description":"The first name of the contact."},"middleName":{"type":"string"},"lastName":{"type":"string","description":"The last name of the contact."},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"twitterId":{"$ref":"#/definitions/TwitterId"},"lineId":{"$ref":"#/definitions/LineId"},"whatsAppId":{"$ref":"#/definitions/WhatsAppId"},"facebookId":{"$ref":"#/definitions/FacebookId"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"surveyOptOut":{"type":"boolean"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"type":{"type":"string","description":"The type of contact","readOnly":true,"enum":["Ephemeral","Identified","Curated"]},"canonicalContact":{"description":"The contact at the head of the merge tree. If null, this contact is not a part of any merge.","readOnly":true,"$ref":"#/definitions/ContactAddressableEntityRef"},"mergeSet":{"type":"array","description":"The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.","readOnly":true,"items":{"$ref":"#/definitions/ContactAddressableEntityRef"}},"mergeOperation":{"description":"Information about the merge history of this contact. If null, this contact is not a part of any merge.","readOnly":true,"$ref":"#/definitions/MergeOperation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string","description":"The platform that was the source of the data. Example: a CRM like SALESFORCE.","enum":["SALESFORCE"]},"url":{"type":"string","description":"An URL that links to the source record that contributed data to the associated entity."}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"ExternalId":{"type":"object","properties":{"externalSource":{"$ref":"#/definitions/ExternalSource"},"value":{"type":"string"}}},"ExternalOrganization":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the company."},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"twitterId":{"$ref":"#/definitions/TwitterId"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"trustor":{"$ref":"#/definitions/Trustor"},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalSource":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the external source."},"active":{"type":"boolean"},"linkConfiguration":{"$ref":"#/definitions/LinkConfiguration"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/FacebookScopedId"}},"displayName":{"type":"string","description":"The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API."}},"description":"User information for a Facebook user interacting with a page or app"},"FacebookScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for a Facebook user interacting with a page or app"},"InstagramId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to an Instagram page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/InstagramScopedId"}},"displayName":{"type":"string","description":"The displayName of the person who owns this Instagram account"}},"description":"User information for an Instagram account"},"InstagramScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for an Instagram user interacting with a page or app"},"JsonSchemaDocument":{"type":"object","properties":{"id":{"type":"string"},"$schema":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"additionalProperties":{"type":"object"}},"description":"A JSON Schema document."},"LineId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/LineUserId"}},"displayName":{"type":"string","description":"The displayName of this person's account in Line"}},"description":"User information for a Line account"},"LineUserId":{"type":"object","properties":{"userId":{"type":"string","description":"The unique channel-specific userId for the user"}},"description":"Channel-specific User ID for Line accounts"},"LinkConfiguration":{"type":"object","properties":{"uriTemplate":{"type":"string"}}},"MergeOperation":{"type":"object","properties":{"sourceContact":{"description":"The source contact for the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"targetContact":{"description":"The target contact for the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"resultingContact":{"description":"The contact created as a result of the merge operation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"OrgUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"organization":{"$ref":"#/definitions/Organization"}}},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string","description":"The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field."},"extension":{"type":"integer","format":"int64","description":"An optional extension for the provided phone number."},"acceptsSMS":{"type":"boolean","description":"Whether this phone number can accept SMS messages."},"normalizationCountryCode":{"type":"string","description":"The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."},"userInput":{"type":"string","description":"The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."},"e164":{"type":"string","description":"The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."},"countryCode":{"type":"string","description":"The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"TrusteeAuthorization":{"type":"object","properties":{"permissions":{"type":"array","description":"Permissions that the trustee user has in the trustor organization","readOnly":true,"items":{"type":"string"}}}},"Trustor":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"authorization":{"description":"Authorization for the trustee user has in this trustor organization","readOnly":true,"$ref":"#/definitions/TrusteeAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterId":{"type":"object","properties":{"id":{"type":"string","description":"twitter user.id_str"},"name":{"type":"string","description":"twitter user.name"},"screenName":{"type":"string","description":"twitter user.screen_name"},"verified":{"type":"boolean","description":"whether this data has been verified using the twitter API","readOnly":true},"profileUrl":{"type":"string","description":"url of user's twitter profile","readOnly":true}},"description":"User information for a twitter account"},"WhatsAppId":{"type":"object","properties":{"phoneNumber":{"description":"The phone number associated with this WhatsApp account","$ref":"#/definitions/PhoneNumber"},"displayName":{"type":"string","description":"The displayName of this person's account in WhatsApp"}},"description":"User information for a WhatsApp account"},"WritableStarrableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkContactsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}}}},"BulkFetchContactsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalContactEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalContactEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalContact"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"BulkErrorNote":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkNotesResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultNoteNote"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultNoteNote":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"error":{"$ref":"#/definitions/BulkErrorNote"}}},"Note":{"type":"object","required":["createdBy"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"entityId":{"type":"string","description":"The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs."},"entityType":{"type":"string","description":"This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.","enum":["contact","organization"]},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"When creating or updating a note, only User.id is required. User object is fully populated when expanding a note.","$ref":"#/definitions/User"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkNotesRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}}}},"BulkFetchNotesResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultNoteEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultNoteEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Note"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"BulkErrorExternalOrganization":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkOrganizationsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalOrganizationExternalOrganization"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalOrganizationExternalOrganization":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"error":{"$ref":"#/definitions/BulkErrorExternalOrganization"}}},"BulkOrganizationsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"BulkFetchOrganizationsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultExternalOrganizationEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultExternalOrganizationEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/ExternalOrganization"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"BulkFetchRelationshipsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultRelationshipEntity"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultRelationshipEntity":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"error":{"$ref":"#/definitions/BulkErrorEntity"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with the external organization. When creating or updating a relationship, only User.id is required. User object is fully populated when expanding a note.","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BulkErrorRelationship":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"status":{"type":"integer","format":"int32"},"retryable":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"details":{"type":"array","items":{"$ref":"#/definitions/BulkErrorDetail"}}}},"BulkRelationshipsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BulkResponseResultRelationshipRelationship"}},"errorCount":{"type":"integer","format":"int32"},"errorIndexes":{"type":"array","items":{"type":"integer","format":"int32"}}}},"BulkResponseResultRelationshipRelationship":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean"},"entity":{"$ref":"#/definitions/Relationship"},"error":{"$ref":"#/definitions/BulkErrorRelationship"}}},"BulkRelationshipsRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}}}},"NoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IdentifierClaimRequest":{"type":"object","required":["identifier","operation"],"properties":{"operation":{"type":"string","description":"The operation to perform claim/release","enum":["Claim","Release"]},"identifier":{"description":"The identifier that should be claimed/released from a contact","$ref":"#/definitions/ContactIdentifier"}}},"DataSchemaListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DataSchema"}},"selfUri":{"type":"string","format":"uri"}}},"MergeRequest":{"type":"object","required":["sourceContactId","targetContactId"],"properties":{"sourceContactId":{"type":"string","description":"The ID of the source contact for the merge operation"},"targetContactId":{"type":"string","description":"The ID of the target contact for the merge operation"}}},"ContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CursorContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"Cursors":{"type":"object","properties":{"before":{"type":"string"},"after":{"type":"string"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"externalContactId":{"type":"string","description":"An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact."},"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}}},"RelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExternalOrganizationTrustorLink":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"externalOrganizationId":{"type":"string","description":"The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org"},"trustorOrgId":{"type":"string","description":"The id of a PureCloud organization that has granted trust to this PureCloud organization"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganizationUri":{"type":"string","format":"uri","description":"The URI for the External Organization that is linked to the trustor org","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"partialResults":{"type":"boolean"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CursorOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"AchievedOutcome":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the outcome achieved."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssignedSegment":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the segment assigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Browser":{"type":"object","required":["family","featuresFlash","featuresJava","featuresPdf","featuresWebrtc","version"],"properties":{"family":{"type":"string","description":"Browser family (e.g. Chrome, Safari, Firefox)."},"version":{"type":"string","description":"Browser version (e.g. 68.0.3440.84)."},"lang":{"type":"string","description":"Language the browser is set to. Must conform to BCP 47."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual browser features."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"viewHeight":{"type":"integer","format":"int32","description":"Browser's viewport height."},"viewWidth":{"type":"integer","format":"int32","description":"Browser's viewport width."},"featuresFlash":{"type":"boolean","description":"Whether Flash is installed."},"featuresJava":{"type":"boolean","description":"Whether Java is installed."},"featuresPdf":{"type":"boolean","description":"Whether the browser recognizes PDFs."},"featuresWebrtc":{"type":"boolean","description":"Whether WebRTC is supported."}}},"ConnectedQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConnectedUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChannel":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type or category of this channel.","enum":["Unknown","Call","Callback","Email","GenericObject","Messaging","Social","Webchat","Voice","Chat","Cobrowse","Video","Screenshare","Message"]},"messageType":{"type":"string","description":"Message type for messaging conversations.","enum":["Unknown","Sms","Twitter","Facebook","Line","WhatsApp","WebMessaging","Open","Instagram"]},"platform":{"type":"string","description":"The source provider for the conversation (e.g. Edge, PureCloud Messaging, PureCloud Email)."}}},"ConversationUserDisposition":{"type":"object","required":["code","user"],"properties":{"code":{"type":"string","description":"User-defined wrap-up code for the conversation."},"notes":{"type":"string","description":"Text entered by the user to describe the call or disposition."},"user":{"description":"The user that wrapped up the conversation.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"CustomEventAttribute":{"type":"object","required":["dataType","value"],"properties":{"dataType":{"type":"string","description":"The data type of the custom attribute."},"value":{"type":"string","description":"The value of the custom attribute."}}},"CustomEventAttributeList":{"type":"object","required":["dataType","values"],"properties":{"dataType":{"type":"string","description":"The data type of the custom attributes."},"values":{"type":"array","description":"The list of custom event attribute values.","items":{"type":"string"}}}},"Device":{"type":"object","required":["category","isMobile","osFamily","osVersion","type"],"properties":{"category":{"type":"string","description":"Device category.","enum":["desktop","mobile","tablet","other"]},"type":{"type":"string","description":"Device type (e.g. iPad, iPhone, Other)."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"screenHeight":{"type":"integer","format":"int32","description":"Device's screen height."},"screenWidth":{"type":"integer","format":"int32","description":"Device's screen width."},"screenDensity":{"type":"integer","format":"int32","description":"Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual device features."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"JourneyApp":{"type":"object","required":["buildNumber","name","namespace","version"],"properties":{"name":{"type":"string","description":"Name of the application (e.g. mybankingapp)."},"namespace":{"type":"string","description":"Namespace of the application (e.g. com.genesys.bancodinero)."},"version":{"type":"string","description":"Version of the application (e.g. 5.9.27)."},"buildNumber":{"type":"string","description":"Build number of the application (e.g. 701)."}}},"JourneyCampaign":{"type":"object","properties":{"content":{"type":"string","description":"Differentiate ads or links that point to the same URL (e.g. textlink)."},"medium":{"type":"string","description":"Identify a medium such as email or cost-per-click (e.g. CPC)."},"name":{"type":"string","description":"Identify a specific product promotion or strategic campaign (e.g. 320banner)."},"source":{"type":"string","description":"Identify a search engine, newsletter name, or other source (e.g. Google)."},"term":{"type":"string","description":"Note the keywords for this ad (e.g. running+shoes)."},"clickId":{"type":"string","description":"The click ID (unique number that is generated when a potential customer clicks on an affiliate link)."},"network":{"type":"string","description":"The ad network to which the click ID belongs."}}},"JourneyGeolocation":{"type":"object","properties":{"country":{"type":"string","description":"Geolocation's ISO 3166-1 alpha-2 country code."},"countryName":{"type":"string","description":"Geolocation's country name."},"latitude":{"type":"number","format":"double","description":"Geolocation's latitude."},"longitude":{"type":"number","format":"double","description":"Geolocation's longitude."},"locality":{"type":"string","description":"Geolocation's locality or city."},"postalCode":{"type":"string","description":"Geolocation's postal code or ZIP code."},"region":{"type":"string","description":"Geolocation's ISO-3166-2 region code."},"regionName":{"type":"string","description":"Geolocation's region name."},"source":{"type":"string","description":"The source that was used to determine the geolocation information."},"timezone":{"type":"string","description":"Geolocation's timezone."}}},"JourneyPage":{"type":"object","required":["breadcrumb","domain","hostname","pathname","url"],"properties":{"url":{"type":"string","description":"The page URL."},"title":{"type":"string","description":"Title of the page."},"domain":{"type":"string","description":"Domain of the page's URL."},"fragment":{"type":"string","description":"Fragment or hash of the page's URL."},"hostname":{"type":"string","description":"Hostname of the page's URL."},"keywords":{"type":"string","description":"Keywords from the HTML {@code } tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the {@code } tag."},"pathname":{"type":"string","description":"Path name of the page for the event."},"queryString":{"type":"string","description":"Query string that is passed to the page in the current event."},"breadcrumb":{"type":"array","description":"Hierarchy of the current page in relation to the website's structure.","items":{"type":"string"}}}},"NetworkConnectivity":{"type":"object","required":["bluetoothEnabled","cellularEnabled","wifiEnabled"],"properties":{"carrier":{"type":"string","description":"The name of the network carrier."},"bluetoothEnabled":{"type":"boolean","description":"Whether Bluetooth is enabled."},"cellularEnabled":{"type":"boolean","description":"Whether Cellular is enabled."},"wifiEnabled":{"type":"boolean","description":"Whether Wi-Fi is enabled."}}},"OutcomeAchievement":{"type":"object","required":["achievedDate","outcome"],"properties":{"outcome":{"description":"The outcome that was achieved.","$ref":"#/definitions/AchievedOutcome"},"achievedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Referrer":{"type":"object","required":["domain","hostname","medium","pathname","url"],"properties":{"url":{"type":"string","description":"Referrer URL."},"domain":{"type":"string","description":"Referrer URL domain."},"hostname":{"type":"string","description":"Referrer URL hostname."},"keywords":{"type":"string","description":"Referrer keywords."},"pathname":{"type":"string","description":"Referrer URL pathname."},"queryString":{"type":"string","description":"Referrer URL querystring."},"fragment":{"type":"string","description":"Referrer URL fragment."},"name":{"type":"string","description":"Name of referrer (e.g. Yahoo!, Google, InfoSpace)."},"medium":{"type":"string","description":"Type of referrer (e.g. search, social).","enum":["internal","search","social","email","unknown","paid"]}}},"SdkLibrary":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the SDK."},"version":{"type":"string","description":"The version of the SDK."}}},"Session":{"type":"object","required":["authenticated","createdDate","eventCount","id","lastEvent","type"],"properties":{"id":{"type":"string","description":"The ID of the session."},"customerId":{"type":"string","description":"Primary identifier of the customer in the source where the events for the session originate from."},"customerIdType":{"type":"string","description":"Type of source customer identifier (e.g. cookie, email, phone)."},"type":{"type":"string","description":"Session types indicate the type or category of sessions (e.g. web, app)."},"externalId":{"type":"string","description":"Unique identifier in the external system where the events for the session originate from."},"externalUrl":{"type":"string","description":"A URL that identifies an external system-of-record resource that may have more detailed information on the session."},"shortId":{"type":"string","description":"Shortened numeric identifier of 4-6 digits."},"outcomeAchievements":{"type":"array","description":"List of the outcome achievements by the customer in this session.","items":{"$ref":"#/definitions/OutcomeAchievement"}},"segmentAssignments":{"type":"array","description":"List of the segment assignments to the customer in this session.","items":{"$ref":"#/definitions/SessionSegmentAssignment"}},"attributes":{"type":"object","description":"Attributes projected from the session's event stream.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"attributeLists":{"type":"object","description":"List-type attributes projected from the session's event stream.","additionalProperties":{"$ref":"#/definitions/CustomEventAttributeList"}},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Customer's IP address."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"lastPage":{"description":"The webpage where the customer's last web interaction occurred.","$ref":"#/definitions/JourneyPage"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"referrer":{"description":"Identifies the page URL that originally generated the request for the current page being viewed.","$ref":"#/definitions/Referrer"},"app":{"description":"Application that the customer is interacting with (for app sessions).","$ref":"#/definitions/JourneyApp"},"sdkLibrary":{"description":"SDK library used to generate the events for the session (for app and web sessions).","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity (for app sessions).","$ref":"#/definitions/NetworkConnectivity"},"searchTerms":{"type":"array","description":"Search terms associated with the session.","items":{"type":"string"}},"userAgentString":{"type":"string","description":"String identifying the user agent."},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the session has been active (valid for an individual device)."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events performed during the session."},"pageviewCount":{"type":"integer","format":"int32","description":"The count of all pageviews performed during the session."},"screenviewCount":{"type":"integer","format":"int32","description":"The count of all screenviews performed during the session."},"lastEvent":{"description":"Information about the most recent event in this session.","$ref":"#/definitions/SessionLastEvent"},"lastConnectedQueue":{"description":"The last queue connected to this session.","$ref":"#/definitions/ConnectedQueue"},"lastConnectedUser":{"description":"The last user connected to this session.","$ref":"#/definitions/ConnectedUser"},"lastUserDisposition":{"description":"The last user disposition connected to this session.","$ref":"#/definitions/ConversationUserDisposition"},"conversationChannels":{"type":"array","description":"Represents the channels used for this conversation.","items":{"$ref":"#/definitions/ConversationChannel"}},"originatingDirection":{"type":"string","description":"The original direction of the conversation.","enum":["Unknown","Inbound","Outbound"]},"conversationSubject":{"type":"string","description":"The subject for the conversation, for example an email subject."},"lastUserDisconnectType":{"type":"string","description":"Disconnect reason for the last user connected to the conversation.","enum":["Unknown","Endpoint","Client","System","Transfer","Error","Peer","Other","Spam","Timeout","TransportFailure","ConferenceTransfer","ConsultTransfer","ForwardTransfer","NoAnswerTransfer","NotAvailableTransfer","Uncallable","DoNotDisturbEndpoint","DoNotDisturbTransfer"]},"lastAcdOutcome":{"type":"string","description":"Last ACD outcome for the conversation.","enum":["Unknown","Abandon","Answered","FlowOut"]},"authenticated":{"type":"boolean","description":"Indicates whether or not the session is authenticated."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalContact":{"description":"The external contact associated with this session.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"awayDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the visitor should be considered as away. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"idleDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the visitor should be considered as idle. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"description":"The conversation for this session.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SessionLastEvent":{"type":"object","required":["createdDate","eventName","id"],"properties":{"id":{"type":"string","description":"The ID of the last event."},"eventName":{"type":"string","description":"The name of the event."},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the event was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"SessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Session"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SessionSegmentAssignment":{"type":"object","required":["assignedDate","segment"],"properties":{"segment":{"description":"The segment that was assigned.","$ref":"#/definitions/AssignedSegment"},"assignedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was assigned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CursorNoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"CursorRelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"cursors":{"description":"The cursor that points to the next set of entities being returned.","$ref":"#/definitions/Cursors"}}},"ReverseWhitepagesLookupResult":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"externalOrganizations":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"Attribute":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The attribute name."},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"uploadedBy":{"$ref":"#/definitions/DomainEntityRef"},"sharingUri":{"type":"string","format":"uri"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"]},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"]}}},"TagValue":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The workspace tag name."},"inUse":{"type":"boolean"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpdate":{"type":"object","required":["name"],"properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the document"},"read":{"type":"boolean"},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"DocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DocumentUpload":{"type":"object","required":["name","workspace"],"properties":{"name":{"type":"string","description":"The name of the document"},"workspace":{"description":"The workspace the document will be uploaded to","$ref":"#/definitions/DomainEntityRef"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"DomainEntityListingQueryResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"]},"values":{"type":"array","items":{"type":"string"}}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SecurityProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareRequest":{"type":"object","required":["sharedEntity","sharedEntityType"],"properties":{"sharedEntityType":{"type":"string","description":"The share entity type","enum":["DOCUMENT"]},"sharedEntity":{"description":"The entity that will be shared","$ref":"#/definitions/SharedEntity"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"description":"The member that will have access to this share. Only required if a list of members is not provided.","$ref":"#/definitions/SharedEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"]},"member":{"$ref":"#/definitions/MemberEntity"}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"ShareEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommandStatusEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagValueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"WorkspaceMember":{"type":"object","required":["memberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","description":"The workspace member type.","enum":["USER","GROUP"]},"member":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Workspace":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The current name of the workspace."},"type":{"type":"string","enum":["USER","GROUP"]},"isCurrentUserWorkspace":{"type":"boolean"},"user":{"$ref":"#/definitions/DomainEntityRef"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"WorkspaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The workspace name"},"bucket":{"type":"string"},"description":{"type":"string"}}},"Address":{"type":"object","properties":{"name":{"type":"string","description":"This will be nameRaw if present, or a locality lookup of the address field otherwise."},"nameRaw":{"type":"string","description":"The name as close to the bits on the wire as possible."},"addressNormalized":{"type":"string","description":"The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."},"addressRaw":{"type":"string","description":"The address as close to the bits on the wire as possible."},"addressDisplayable":{"type":"string","description":"The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."}}},"AdjustableLiveSpeakerDetection":{"type":"object","properties":{"mode":{"type":"string","description":"Modes to tune between speed to live speaker detection vs accuracy.","enum":["unknown","disabled","low","medium","high"]},"preconnectDuration":{"type":"string","description":"ISO 8601 formatted relative duration (e.g., PT30.8427419S for 30.8 seconds), calculated on line connect."},"eventName":{"type":"string","description":"The name of the event that triggered the ALSD evaluation (e.g., line.connect, speech.generic)."},"isPersonLikely":{"type":"boolean","description":"The output of the ALSD detector, evaluating whether there is likely a person on the call based on the above inputs, and if so, a person is detected early (person disposition name and speech.person analyzer result) and the associated action taken (e.g., speech.person postconnect entry in the disposition table has the action to transfer to a queue)."},"totalRingbacks":{"type":"integer","format":"int32","description":"Number of tone.ring.* analyzer events detected during the call (expected mostly during pre-connect but the last ringback tone detection could potentially complete after line connect, which will increment totalRingbacks still)."},"lineConnected":{"type":"boolean","description":"Protocol line connect received (answered by a person, machine, busy, fax)."}}},"AfterCallWork":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["unknown","notApplicable","skipped","pending","complete"]}}},"AiAnswer":{"type":"object","properties":{"answerId":{"type":"string","description":"The unique identifier of the suggested ai answer."},"explanation":{"type":"string","description":"An explanation providing the reasoning behind the suggested answer."},"failureType":{"type":"string","description":"Describes the type of error associated with the AI answer.","enum":["LowConfidenceError","ParsingError","ServiceError"]}}},"AiScoring":{"type":"object","properties":{}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"name":{"type":"string","description":"The name of the attachment."},"contentUri":{"type":"string","description":"The content uri of the attachment. If set, this is commonly a public api download location."},"contentType":{"type":"string","description":"The type of file the attachment is."},"contentLength":{"type":"integer","format":"int32","description":"The length of the attachment file."},"inlineImage":{"type":"boolean","description":"Whether or not the attachment was attached inline.,"}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","endpoint.donotdisturb","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"Callback":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"callerId":{"type":"string","description":"The phone number displayed to recipients of the phone call. The value should conform to the E164 format."},"callerIdName":{"type":"string","description":"The name displayed to recipients of the phone call."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"Cobrowsesession":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transport.failure","error","peer","other","spam","uncallable"]},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the co-browse session."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"externalTag":{"type":"string","description":"The external tag associated with the conversation."},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"]},"state":{"type":"string","description":"The conversation's state","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"roomId":{"type":"string","description":"The room id for the chat."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"direction":{"type":"string","description":"The direction of the chat","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","error","peer","other","uncallable","timeout"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"ConversationDivisionMembership":{"type":"object","properties":{"division":{"description":"A division the conversation belongs to.","$ref":"#/definitions/DomainEntityRef"},"entities":{"type":"array","description":"The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"ConversationMessageMetadata":{"type":"object","properties":{"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"events":{"type":"array","description":"List of events metadata","items":{"$ref":"#/definitions/ConversationMessageMetadataEvent"}},"content":{"type":"array","description":"List of message content","items":{"$ref":"#/definitions/ConversationMessageMetadataContent"}}},"description":"Metadata information about a message."},"ConversationMessageMetadataContent":{"type":"object","properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","Unknown"]},"subType":{"type":"string","description":"Content subtype","enum":["Image","Video","Audio","File","Link","Mention","Reply","Button","QuickReply","Postback","Unknown"]}},"description":"Metadata information about a message content."},"ConversationMessageMetadataEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Typing","Presence","Video","Unknown"]},"subType":{"type":"string","description":"Event subtype","enum":["On","Join","Offering","OfferingExpired","OfferingAccepted","OfferingRejected","Disconnect","Clear","SignIn","Unknown"]}},"description":"Metadata information about a message event."},"ConversationQueueMediaSettings":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"autoAnswerAlertToneSeconds":{"type":"number","format":"double","description":"Specifies the duration of the alerting sound to be played for auto answered interactions."},"manualAnswerAlertToneSeconds":{"type":"number","format":"double","description":"Specifies the duration of the alerting sound to be played for manually answered interactions."},"enableAutoAnswer":{"type":"boolean","description":"Flag to indicate if auto answer is enabled for the given media type or media subtype."}}},"ConversationReference":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"ConversationRoutingData":{"type":"object","properties":{"queue":{"description":"The queue to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"language":{"description":"The language to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority of the conversation to use for routing decisions"},"skills":{"type":"array","description":"The skills to use for routing decisions","items":{"$ref":"#/definitions/AddressableEntityRef"}},"scoredAgents":{"type":"array","description":"A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents","items":{"$ref":"#/definitions/ScoredAgent"}},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string","description":"The contact associated with this preview data pop"},"contactListId":{"type":"string","description":"The contactList associated with this preview data pop."},"campaignId":{"type":"string","description":"The campaignId associated with this preview data pop."},"phoneNumberColumns":{"type":"array","description":"The phone number columns associated with this campaign","items":{"$ref":"#/definitions/PhoneNumberColumn"}},"callbackAutoAnswer":{"type":"boolean","description":"Whether or not to auto answer the callback"}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","description":"Disconnect reason protocol type.","enum":["q850","sip"]},"code":{"type":"integer","format":"int32","description":"Protocol specific reason code. See the Q.850 and SIP specs."},"phrase":{"type":"string","description":"Human readable English description of the disconnect reason."}}},"Disposition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the disposition. Either a platform predefined value, or the name of the disposition in the disposition table.."},"analyzer":{"type":"string","description":"The final media analyzer result that triggered the disposition result, if any."},"dispositionParameters":{"description":"Contains various parameters related to call analysis.","$ref":"#/definitions/DispositionParameters"},"detectedSpeechStart":{"type":"string","format":"date-time","description":"Absolute time when the speech started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"detectedSpeechEnd":{"type":"string","format":"date-time","description":"Absolute time when the speech ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"DispositionParameters":{"type":"object","properties":{"adjustableLiveSpeakerDetection":{"description":"ALSD evaluation inputs and output (isPersonalLikely) of the ALSD detector the last time it ran on the call (could be multiple times)","$ref":"#/definitions/AdjustableLiveSpeakerDetection"}}},"Email":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected","none","parked","transmitting"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","connected","disconnected","none","parked","transmitting"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"subject":{"type":"string","description":"The subject for the initial email that started this conversation."},"messagesSent":{"type":"integer","format":"int32","description":"The number of email messages sent by this participant."},"segments":{"type":"array","description":"The time line of the participant's email, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the email","enum":["inbound","outbound"]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"assignee":{"$ref":"#/definitions/User"},"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable."},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"revisionCreatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"assigned":{"type":"boolean","description":"Set to false to unassign the evaluation. This cannot be set to false when assignee is also set."},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"agentTeam":{"description":"Team of the evaluation agent","$ref":"#/definitions/Team"},"isScoringIndex":{"type":"boolean"},"authorizedActions":{"type":"array","description":"List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit","items":{"type":"string"}},"hasAssistanceFailed":{"type":"boolean","description":"Is true when evaluation assistance didn't execute successfully"},"evaluationSource":{"description":"The source that created the evaluation.","readOnly":true,"$ref":"#/definitions/EvaluationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float","description":"Score of all questions in the group"},"maxTotalScore":{"type":"number","format":"float","description":"Maximum possible score of all questions in the group"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"totalCriticalScore":{"type":"number","format":"float","description":"Score of only the critical questions in the group"},"maxTotalCriticalScore":{"type":"number","format":"float","description":"Maximum possible score of only the critical questions in the group"},"totalNonCriticalScore":{"type":"number","format":"float","description":"Score of only the non critical questions in the group"},"maxTotalNonCriticalScore":{"type":"number","format":"float","description":"Maximum possible score of only the non critical questions in the group"},"totalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of all questions in the group"},"maxTotalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of all questions in the group"},"totalCriticalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of only the critical questions in the group"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of only the critical questions in the group"},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"Unweighted score of only the non critical questions in the group"},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"Maximum possible unweighted score of only the non critical questions in the group"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionScore"}}}},"EvaluationQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32","description":"Unweighted score of the question"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"assistedAnswerId":{"type":"string","description":"AnswerId found with evaluation assistance conditions"},"failedKillQuestion":{"type":"boolean","description":"Applicable only on fatal questions. Indicates that the answer selected was not the highest score available for the question"},"comments":{"type":"string","description":"Comments from the evaluator specific to this question"}}},"EvaluationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float","description":"Score of all questions"},"totalCriticalScore":{"type":"number","format":"float","description":"Score of only the critical questions"},"totalNonCriticalScore":{"type":"number","format":"float","description":"Score of only the non-critical questions"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean","description":"Indicates that at least one fatal question was answered without having the highest score available for the question"},"comments":{"type":"string","description":"Overall comments from the evaluator"},"privateComments":{"type":"string","description":"Overall private comments from the evaluator"},"agentComments":{"type":"string","description":"Comments from the agent while reviewing evaluation results"},"transcriptTopics":{"type":"array","description":"List of topics found within the conversation's transcripts","items":{"$ref":"#/definitions/TranscriptTopic"}}}},"EvaluationSource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Type of the evaluation source.","enum":["Policy","User","Unknown"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxStatus":{"type":"object","properties":{"direction":{"type":"string","description":"The fax direction, either \"send\" or \"receive\"."},"expectedPages":{"type":"integer","format":"int64","description":"Total number of expected pages, if known."},"activePage":{"type":"integer","format":"int64","description":"Active page of the transmission."},"linesTransmitted":{"type":"integer","format":"int64","description":"Number of lines that have completed transmission."},"bytesTransmitted":{"type":"integer","format":"int64","description":"Number of bytes that have competed transmission."},"baudRate":{"type":"integer","format":"int64","description":"Current signaling rate of transmission, baud rate."},"pageErrors":{"type":"integer","format":"int64","description":"Number of page errors."},"lineErrors":{"type":"integer","format":"int64","description":"Number of line errors."}}},"JourneyAction":{"type":"object","required":["actionMap","id"],"properties":{"id":{"type":"string","description":"The ID of an action from the Journey System (an action is spawned from an actionMap)"},"actionMap":{"description":"Details about the action map from the Journey System which triggered this action","$ref":"#/definitions/JourneyActionMap"}}},"JourneyActionMap":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The ID of the actionMap in the Journey System which triggered this action"},"version":{"type":"integer","format":"int32","description":"The version number of the actionMap in the Journey System at the time this action was triggered"}}},"JourneyContext":{"type":"object","required":["customer"],"properties":{"customer":{"description":"A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomerSession"},"triggeringAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"}}},"JourneyCustomer":{"type":"object","required":["id","idType"],"properties":{"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable."},"idType":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie)."}}},"JourneyCustomerSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"An ID of a Customer/User's session within the Journey System at a point-in-time"},"type":{"type":"string","description":"The type of the Customer/User's session within the Journey System (e.g. web, app)"}}},"Message":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","connected","disconnected"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"segments":{"type":"array","description":"The time line of the participant's message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this message."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the message."},"authenticated":{"type":"boolean","description":"If true, the participant member is authenticated."},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging","open","instagram"]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"toAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/MessageDetails"}},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"byoSmsIntegrationId":{"type":"string","description":"The internal id representing the customer supplied sms integration message."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"MessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the message media."},"messageURI":{"type":"string","format":"uri","description":"A URI for this message entity."},"messageStatus":{"type":"string","description":"Indicates the delivery status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read","removed","published"]},"messageSegmentCount":{"type":"integer","format":"int32","description":"The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits."},"messageTime":{"type":"string","format":"date-time","description":"The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"media":{"type":"array","description":"The media (images, files, etc) associated with this message, if any","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"One or more stickers associated with this message, if any","items":{"$ref":"#/definitions/MessageSticker"}},"messageMetadata":{"description":"Information that describes the content of the message, if any","$ref":"#/definitions/ConversationMessageMetadata"},"errorInfo":{"description":"Provider specific error information for a communication.","$ref":"#/definitions/ErrorBody"}}},"MessageMedia":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object. If null then the media type should be dictated by the url"},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The optional name of the the media object."},"id":{"type":"string","description":"The optional id of the the media object."}}},"MessageSticker":{"type":"object","properties":{"url":{"type":"string","description":"The location of the sticker, useful for retrieving it"},"id":{"type":"string","description":"The unique id of the the sticker object."}}},"PagelessDomainEntityListingEvaluationVersion":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationVersion"}},"selfUri":{"type":"string","format":"uri"}}},"Participant":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc.","items":{"type":"string"}},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."}}},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"ScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/DomainEntityRef"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"Screenshare":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"sharing":{"type":"boolean","description":"Indicates whether this participant is sharing their screen."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the screen share."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Segment":{"type":"object","required":["endTime","startTime"],"properties":{"startTime":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The activity taking place for the participant in the segment."},"howEnded":{"type":"string","description":"A description of the event that ended the segment."},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment"}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"socialMediaId":{"type":"string","description":"A globally unique identifier for the social media."},"socialMediaHub":{"type":"string","description":"The social network of the communication"},"socialUserName":{"type":"string","description":"The user name for the communication."},"previewText":{"type":"string","description":"The text preview of the communication contents"},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the social expression."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"TopicDuration":{"type":"object","properties":{"totalMilliseconds":{"type":"integer","format":"int64","description":"The total duration of the topic phrase within the conversation","readOnly":true}}},"TopicOffset":{"type":"object","properties":{"wordCount":{"type":"integer","format":"int64","description":"Count of words before the topic ","readOnly":true},"characterCount":{"type":"integer","format":"int64","description":"Count of characters before the topic ","readOnly":true}}},"TranscriptTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"topicPhrase":{"type":"string","description":"The phrase which detected the topic. ","readOnly":true},"transcriptPhrase":{"type":"string","description":"The transcript phrase which detected the topic.","readOnly":true},"confidence":{"type":"integer","format":"int32","description":"The detection confidence of the topic.","readOnly":true},"startTimeMilliseconds":{"type":"integer","format":"int64","description":"The start time of the topic phrase.","readOnly":true},"duration":{"$ref":"#/definitions/TopicDuration"},"offset":{"description":"Location of the phrase","readOnly":true,"$ref":"#/definitions/TopicOffset"},"recordingLocation":{"type":"integer","format":"int64","description":"Location of the phrase in the recording in milliseconds","readOnly":true}}},"TransferDestination":{"type":"object","properties":{"userId":{"type":"string","description":"The id of the user if the command destination is a user."},"address":{"type":"string","description":"The destination address if the command destination is an endpoint."}}},"TransferInitiator":{"type":"object","properties":{"userId":{"type":"string","description":"The id of the user who initiated the command if it was initiated by a user."}}},"TransferResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the command."},"state":{"type":"string","description":"The state of the command.","enum":["Pending","Active","Complete","Canceled","Failed","Timeout","Unknown"]},"dateIssued":{"type":"string","format":"date-time","description":"The date/time that this command was issued. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiator":{"description":"The initiator of the command.","$ref":"#/definitions/TransferInitiator"},"modifiedBy":{"description":"The user or entity that modified the command.","$ref":"#/definitions/TransferResponseModifiedBy"},"destination":{"description":"The destination of the command.","$ref":"#/definitions/TransferDestination"},"transferType":{"type":"string","description":"The type of transfer to perform.","enum":["Attended","Unattended"]}}},"TransferResponseModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Video":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"audioMuted":{"type":"boolean","description":"Indicates whether this participant has muted their outgoing audio."},"videoMuted":{"type":"boolean","description":"Indicates whether this participant has muted/paused their outgoing video."},"sharingScreen":{"type":"boolean","description":"Indicates whether this participant is sharing their screen to the session."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the video."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"msids":{"type":"array","description":"List of media stream ids","items":{"type":"string"}},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Voicemail":{"type":"object","properties":{"id":{"type":"string","description":"The voicemail id"},"uploadStatus":{"type":"string","description":"current state of the voicemail upload","enum":["pending","complete","failed","timeout","none"]}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."}}},"ArrayNode":{"type":"object"},"JsonCursorSearchResponse":{"type":"object","required":["results","types"],"properties":{"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"},"cursor":{"type":"string","description":"The page cursor"}}},"ConversationParticipantSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/ConversationParticipantSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","DATE_RANGE"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"ConversationParticipantSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/ConversationParticipantSearchCriteria"}},"cursor":{"type":"string"}}},"ConversationUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"ConversationTagsUpdate":{"type":"object","required":["externalTag"],"properties":{"externalTag":{"type":"string","description":"The external tag associated with the conversation."}}},"ConversationSecureAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The version used to detect conflicting updates when using PUT. Not used for PATCH."}}},"ConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"]},"headers":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"FaxSendRequest":{"type":"object","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$ref":"#/definitions/CoverSheet"},"timeZoneOffsetMinutes":{"type":"integer","format":"int32","description":"Time zone offset minutes from GMT"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Settings":{"type":"object","properties":{"communicationBasedACW":{"type":"boolean","description":"Communication Based ACW"},"includeNonAgentConversationSummary":{"type":"boolean","description":"Display communication summary"},"allowCallbackQueueSelection":{"type":"boolean","description":"Allow Callback Queue Selection"},"callbacksInheritRoutingFromInboundCall":{"type":"boolean","description":"Inherit callback routing data from inbound calls"},"completeAcwWhenAgentTransitionsOffline":{"type":"boolean","description":"Complete ACW When Agent Transitions Offline"},"totalActiveCallback":{"type":"boolean","description":"Exclude the 'interacting' duration from the handle calculations of callbacks"}}},"AfterCallWorkUpdate":{"type":"object","required":["afterCallWorkRequired"],"properties":{"afterCallWorkRequired":{"type":"boolean","description":"Indicates whether or not after-call work must be completed for the communication. Can only be updated for connected communications."}}},"BulkCallbackPatchResponse":{"type":"object","properties":{"results":{"type":"array","description":"A list of the results from the bulk operation.","items":{"$ref":"#/definitions/BulkResult"}},"errorCount":{"type":"integer","format":"int32","description":"The number of errors from the bulk operation."},"errorIndexes":{"type":"array","description":"An index of where the errors are in the listing.","items":{"type":"integer","format":"int32"}}}},"BulkResult":{"type":"object","properties":{"error":{"description":"Error details if the operation failed.","$ref":"#/definitions/BulkError"},"entity":{"type":"object","description":"The result of the operation if it succeeded."}}},"BulkCallbackPatchRequest":{"type":"object","required":["patchCallbackRequests"],"properties":{"patchCallbackRequests":{"type":"array","description":"The list of requests to update callbacks in bulk","items":{"$ref":"#/definitions/PatchCallbackRequest"}}}},"PatchCallbackRequest":{"type":"object","required":["agentId","conversationId"],"properties":{"conversationId":{"type":"string","description":"The conversationId."},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback."},"agentId":{"type":"string","description":"The agentId."},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BulkCallbackDisconnectRequest":{"type":"object","required":["callbackDisconnectIdentifiers"],"properties":{"callbackDisconnectIdentifiers":{"type":"array","description":"The list of requests to disconnect callbacks in bulk","items":{"$ref":"#/definitions/CallbackDisconnectIdentifier"}}}},"CallbackDisconnectIdentifier":{"type":"object","required":["callbackId","conversationId"],"properties":{"conversationId":{"type":"string","description":"The Conversation Id."},"callbackId":{"type":"string","description":"The callback id."}}},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"recordingState":{"type":"string","enum":["none","active","paused"]},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"muted":{"type":"boolean","description":"Value is true when the call is muted."},"confined":{"type":"boolean","description":"Value is true when the call is confined."},"recording":{"type":"boolean","description":"Value is true when the call is being recorded."},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["none","active","paused"]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/DomainEntityRef"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"faxStatus":{"description":"Extra fax information if the call is a fax.","$ref":"#/definitions/FaxStatus"},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"coachedParticipantId":{"type":"string","description":"The ID of the participant being coached when performing a call coach."},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."},"uuiData":{"type":"string","description":"User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567."},"bargedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the barge conference in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"TransferRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"CreateCallResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callerId":{"type":"string","description":"The caller id phone number for this outbound call."},"callerIdName":{"type":"string","description":"The caller id name for this outbound call."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"externalContactId":{"type":"string","description":"The external contact with which to associate the call."},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"}}},"Destination":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"}}},"SetRecordingState":{"type":"object","properties":{"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings.","enum":["ACTIVE","PAUSED","NONE"]}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}}}},"AssignedWrapupCode":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The duration in seconds of the wrap-up segment."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/WrapupInput"},"state":{"type":"string","description":"The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording."},"muted":{"type":"boolean","description":"True to mute this conversation participant."},"confined":{"type":"boolean","description":"True to confine this conversation participant. Should only be used for ad-hoc conferences"},"held":{"type":"boolean","description":"True to hold this conversation participant."},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant."}}},"WrapupInput":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."},"disableEndTimeUpdates":{"type":"boolean","description":"Prevent updates to wrapup end time when set to true."}}},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32","description":"The maximum number of participants that are allowed on a conversation."}}},"ConsultTransfer":{"type":"object","required":["destination","speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"ConsultTransferToAgent":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"userId":{"type":"string","description":"The id of the internal user."},"userDisplayName":{"type":"string","description":"The name of the internal user."}}},"ConsultTransferToQueue":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"queueId":{"type":"string","description":"The id of the queue."},"queueName":{"type":"string","description":"The name of the queue."}}},"ConsultTransferToExternal":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH","CONFERENCE"]},"consultingUserId":{"type":"string","description":"The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"},"address":{"type":"string","description":"The address (like phone number) of the external contact."}}},"CallCommand":{"type":"object","required":["callNumber"],"properties":{"callNumber":{"type":"string","description":"The phone number to dial for this call."},"phoneColumn":{"type":"string","description":"For a dialer preview or scheduled callback, the phone column associated with the phone number"}}},"CallHistoryConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallHistoryParticipant"}},"direction":{"type":"string","description":"The direction of the call relating to the current user","enum":["inbound","outbound"]},"wentToVoicemail":{"type":"boolean","description":"Did the call end in the current user's voicemail"},"missedCall":{"type":"boolean","description":"Did the user not answer this conversation"},"startTime":{"type":"string","format":"date-time","description":"The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"wasConference":{"type":"boolean","description":"Was this conversation a conference"},"wasCallback":{"type":"boolean","description":"Was this conversation a callback"},"hadScreenShare":{"type":"boolean","description":"Did this conversation have a screen share session"},"hadCobrowse":{"type":"boolean","description":"Did this conversation have a cobrowse session"},"wasOutboundCampaign":{"type":"boolean","description":"Was this conversation associated with an outbound campaign"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallHistoryConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallHistoryConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallHistoryParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/User"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/Queue"},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/Group"},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"externalContact":{"description":"The PureCloud external contact","$ref":"#/definitions/ExternalContact"},"externalOrganization":{"description":"The PureCloud external organization","$ref":"#/definitions/ExternalOrganization"},"didInteract":{"type":"boolean","description":"Indicates whether the contact ever connected"},"sipResponseCodes":{"type":"array","description":"Indicates SIP Response codes associated with the participant","items":{"type":"integer","format":"int64"}},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"outboundCampaign":{"description":"The outbound campaign associated with the participant","$ref":"#/definitions/Campaign"}}},"Campaign":{"type":"object","required":["callerAddress","callerName","contactList","dialingMode","name","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The ContactList for this Campaign to dial.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"dialingMode":{"type":"string","description":"The strategy this Campaign will use for dialing.","enum":["agentless","preview","power","predictive","progressive","external"]},"script":{"description":"The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The EdgeGroup that will place the calls. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"site":{"description":"The identifier of the site to be used for dialing; can be set in place of an edge group.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.","enum":["on","stopping","off","complete","invalid","forced_off","forced_stopping"]},"phoneColumns":{"type":"array","description":"The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"The targeted compliance abandon rate percentage. Required for power and predictive campaigns."},"dncLists":{"type":"array","description":"DncLists for this Campaign to check before placing a call.","items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"The callable time set for this campaign to check before placing a call.","$ref":"#/definitions/DomainEntityRef"},"callAnalysisResponseSet":{"description":"The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"errors":{"type":"array","description":"A list of current error conditions associated with the campaign.","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"The caller id name to be displayed on the outbound call."},"callerAddress":{"type":"string","example":"(555) 555-5555","description":"The caller id phone number to be displayed on the outbound call."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."},"ruleSets":{"type":"array","description":"Rule sets to be applied while this campaign is dialing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"skipPreviewDisabled":{"type":"boolean","description":"Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."},"alwaysRunning":{"type":"boolean","description":"Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."},"contactSort":{"description":"The order in which to sort contacts for dialing, based on a column.","$ref":"#/definitions/ContactSort"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"noAnswerTimeout":{"type":"integer","format":"int32","description":"How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."},"callAnalysisLanguage":{"type":"string","description":"The language the edge will use to analyze the call."},"priority":{"type":"integer","format":"int32","description":"The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."},"contactListFilters":{"type":"array","description":"Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.","items":{"$ref":"#/definitions/DomainEntityRef"}},"division":{"description":"The division this campaign belongs to.","$ref":"#/definitions/DomainEntityRef"},"dynamicContactQueueingSettings":{"description":"Settings for dynamic queueing of contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on this campaign"},"callbackAutoAnswer":{"type":"boolean","description":"The option manages the auto-answer callback calls"},"dynamicLineBalancingSettings":{"description":"Dynamic line balancing settings","$ref":"#/definitions/DynamicLineBalancingSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","description":"The direction in which to sort contacts.","enum":["ASC","DESC"]},"numeric":{"type":"boolean","description":"Whether or not the column contains numeric data."}}},"DynamicContactQueueingSettings":{"type":"object","properties":{"sort":{"type":"boolean","description":"Whether to sort contacts dynamically"}}},"DynamicLineBalancingSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates that this campaign is subject of dynamic line balancing"},"relativeWeight":{"type":"integer","format":"int32","description":"Relative weight of this campaign in dynamic line balancing"}}},"PhoneColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"The type of the phone column. For example, 'cell' or 'home'."}}},"RestErrorDetail":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"SetUuiDataRequest":{"type":"object","properties":{"uuiData":{"type":"string","description":"The value of the uuiData to set."}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outboundPreview":{"description":"The outbound preview associated with this callback.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail associated with this callback.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The list of phone number to use for this callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the callback target."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"If true, the callback can be skipped."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Duration in seconds before the callback will be auto-dialed."},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal."},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"]},"id":{"type":"string","description":"The identifier of the callback"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"CreateCallbackCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}},"callerId":{"type":"string","description":"The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."},"callerIdName":{"type":"string","description":"The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."}}},"RoutingData":{"type":"object","required":["queueId"],"properties":{"queueId":{"type":"string","description":"The identifier of the routing queue"},"languageId":{"type":"string","description":"The identifier of a language to be considered in routing"},"label":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"priority":{"type":"integer","format":"int32","description":"The priority for routing"},"skillIds":{"type":"array","description":"A list of skill identifiers to be considered in routing","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"A list of agents to be preferred in routing","items":{"type":"string"}},"scoredAgents":{"type":"array","description":"A list of scored agents for routing decisions. For Agent Owned Callbacks use one scored agent with a score of 100.","items":{"$ref":"#/definitions/ScoredAgent"}},"routingFlags":{"type":"array","description":"An array of flags indicating how the conversation should be routed. Use \"AGENT_OWNED_CALLBACK\" when creating an Agent Owned Callback.","items":{"type":"string"}}}},"PatchCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"WebChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMemberInfo":{"type":"object","required":["role"],"properties":{"id":{"type":"string","description":"The communicationId of this member."},"displayName":{"type":"string","description":"The display name of the member."},"firstName":{"type":"string","description":"The first name of the member."},"lastName":{"type":"string","description":"The last name of the member."},"email":{"type":"string","description":"The email address of the member."},"phoneNumber":{"type":"string","description":"The phone number of the member."},"avatarImageUrl":{"type":"string","format":"uri","description":"The url to the avatar image of the member."},"role":{"type":"string","description":"The role of the member, one of [agent, customer, acd, workflow]","enum":["AGENT","CUSTOMER","WORKFLOW","ACD"]},"joinDate":{"type":"string","format":"date-time","description":"The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"leaveDate":{"type":"string","format":"date-time","description":"The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"authenticatedGuest":{"type":"boolean","description":"If true, the guest member is an authenticated guest."},"customFields":{"type":"object","description":"Any custom fields of information pertaining to this member.","additionalProperties":{"type":"string"}},"state":{"type":"string","description":"The connection state of this member.","enum":["CONNECTED","DISCONNECTED","ALERTING"]}}},"WebChatMessage":{"type":"object","required":["body","bodyType","conversation","sender","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"body":{"type":"string","description":"The message body."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMessageEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMessage"}},"previousPage":{"type":"string"},"next":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"CreateWebChatMessageRequest":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message body. Note that message bodies are limited to 4,000 characters."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"]}}},"WebChatTyping":{"type":"object","required":["conversation","id","sender","timestamp"],"properties":{"id":{"type":"string","description":"The event identifier of this typing indicator event (useful to guard against event re-delivery"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"}}},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomId":{"type":"string","description":"The ID of the chat room."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."}}},"CreateWebChatRequest":{"type":"object","required":["provider","queueId"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the chat conversation."},"provider":{"type":"string","description":"The name of the provider that is sourcing the web chat."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the langauge to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"customerName":{"type":"string","description":"The name of the customer participating in the web chat."}}},"CobrowseConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CobrowseMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CobrowseConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CobrowseConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EmailMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"state":{"type":"string","description":"The state of the current draft.","enum":["Created","Ready","Edited"]},"draftType":{"type":"string","description":"The type of draft that need to be treated.","enum":["Reply","ReplyAll","Forward"]},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."}}},"CopyAttachmentsRequest":{"type":"object","required":["attachments","sourceMessage"],"properties":{"sourceMessage":{"description":"A reference to the email message within the current conversation that owns the attachments to be copied","$ref":"#/definitions/DomainEntityRef"},"attachments":{"type":"array","description":"A list of attachments that will be copied from the source message to the current draft","items":{"$ref":"#/definitions/Attachment"}}}},"EmailMessagePreview":{"type":"object","required":["from","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBodyPreview":{"type":"string","description":"A truncated version of the textBody"},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"state":{"type":"string","description":"The state of the current draft.","enum":["Created","Ready","Edited"]},"draftType":{"type":"string","description":"The type of draft that need to be treated.","enum":["Reply","ReplyAll","Forward"]},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessagePreviewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessagePreview"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateEmailRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"},"direction":{"type":"string","description":"Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.","enum":["OUTBOUND","INBOUND"]},"htmlBody":{"type":"string","description":"An HTML body content of the email."},"textBody":{"type":"string","description":"A text body content of the email."},"externalContactId":{"type":"string","description":"The external contact with which the email should be associated. This field is only valid for OUTBOUND email."}}},"EmailsSettings":{"type":"object","properties":{"sendingSizeLimit":{"type":"integer","format":"int32"}}},"DraftManipulationRequest":{"type":"object","properties":{"translate":{"description":"A set of definitions to translate email attributes and correctly display date and time, for a given language","$ref":"#/definitions/HistoryHeadersTranslation"},"draftType":{"type":"string","description":"The kind of draft that as to be treated. Used to prefix response subject or auto-include information","enum":["Reply","ReplyAll","Forward"]}}},"HistoryHeadersTranslation":{"type":"object","required":["cc","forwardPrefix","from","language","replyPrefix","sent","subject","to"],"properties":{"from":{"type":"string","description":"A translation for the word \"from\", for the expected language"},"to":{"type":"string","description":"A translation for the word \"to\", for the expected language"},"cc":{"type":"string","description":"A translation for the word \"cc\", for the expected language"},"subject":{"type":"string","description":"A translation for the word \"subject\", for the expected language"},"replyPrefix":{"type":"string","description":"A translation for the subject prefix \"Reply\", for the expected language"},"forwardPrefix":{"type":"string","description":"A translation for the subject prefix \"Forward\", for the expected language"},"sent":{"type":"string","description":"A translation for the word \"sent\", for the expected language"},"language":{"type":"string","description":"The code of the expected language"},"timeZone":{"type":"string","description":"Timezone used by the agent, used to format the sent email date and time. If not defined, will default to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"}}},"EmailMessageReply":{"type":"object","required":["from","textBody","to"],"properties":{"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"replyTo":{"description":"The receiver of the reply email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"emailSizeBytes":{"type":"integer","format":"int32","description":"Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.","readOnly":true},"maxEmailSizeBytes":{"type":"integer","format":"int32","description":"Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration","readOnly":true}}},"InboundMessageRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the email such as Oracle, Salesforce, etc."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"}}},"AgentlessEmailSendResponseDto":{"type":"object","required":["conversationId","dateCreated","fromAddress","senderType","toAddresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"senderType":{"type":"string","description":"The identifier of the external participant of the given conversation.","enum":["Outbound","Inbound","Integration"]},"fromAddress":{"description":"The sender of the message.","$ref":"#/definitions/EmailAddress"},"toAddresses":{"type":"array","description":"The recipient of the message. We currently support one recipient only.","items":{"$ref":"#/definitions/EmailAddress"}},"replyToAddress":{"description":"The address to use for reply.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the message."},"dateCreated":{"type":"string","format":"date-time","description":"The message creation timestamp. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentlessEmailSendRequestDto":{"type":"object","required":["fromAddress","senderType","toAddresses"],"properties":{"senderType":{"type":"string","description":"The direction of the message.","enum":["Outbound","Inbound","Integration"]},"conversationId":{"type":"string","description":"The identifier of the conversation. This must be an email interaction."},"fromAddress":{"description":"The sender of the message.","$ref":"#/definitions/EmailAddress"},"toAddresses":{"type":"array","description":"The recipient of the message. We currently support one recipient only.","items":{"$ref":"#/definitions/EmailAddress"}},"replyToAddress":{"description":"The address to use for reply.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the message."},"textBody":{"type":"string","description":"The Content of the message, in plain text."},"htmlBody":{"type":"string","description":"The Content of the message, in HTML. Links, images and styles are allowed"}}},"EmailSettings":{"type":"object","properties":{"multipleRouteDestinationsOnInboundEmailEnabled":{"type":"boolean","description":"This setting allows a single inbound email that contains multiple routes configured in Genesys Cloud to create a conversation per route. When this setting is disabled only a single conversation will be created"}}},"CachedMediaItem":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the cached media.","readOnly":true},"url":{"type":"string","description":"The URL that represents the external media that has been cached","readOnly":true},"downloadUrl":{"type":"string","description":"A URL to fetch the cached media","readOnly":true},"mediaType":{"type":"string","description":"The media type for the URL","readOnly":true},"contentLengthBytes":{"type":"integer","format":"int32","description":"The content length of the media represented by the URL, in bytes.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the cached item was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateExpires":{"type":"string","format":"date-time","description":"The date the cached item expires and will be removed from the cache. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines an external media that has been ingested and cached by Genesys Cloud for conversation messaging"},"CachedMediaItemEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CachedMediaItem"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationChannelMetadata":{"type":"object","properties":{},"description":"Information about the channel."},"ConversationContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, a LINE sticker ID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."},"contentSizeBytes":{"type":"integer","format":"int64","description":"Size in bytes of the attachment content."}},"description":"Attachment object."},"ConversationContentButtonResponse":{"type":"object","required":["payload","text"],"properties":{"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"ConversationContentCard":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"defaultAction":{"description":"The default button action.","$ref":"#/definitions/ConversationContentCardAction"},"actions":{"type":"array","description":"An array of action objects.","items":{"$ref":"#/definitions/ConversationContentCardAction"}}},"description":"Card content object."},"ConversationContentCardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback","Unknown"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."},"url":{"type":"string","description":"A URL of a web page to direct the user to."}},"description":"A card action that a user can take."},"ConversationContentCarousel":{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","description":"An array of card objects.","items":{"$ref":"#/definitions/ConversationContentCard"}}},"description":"Carousel content object."},"ConversationContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"URL of the Location."},"address":{"type":"string","description":"Location postal address."},"text":{"type":"string","description":"Location name."},"latitude":{"type":"number","format":"double","description":"Latitude of the location."},"longitude":{"type":"number","format":"double","description":"Longitude of the location."}},"description":"Location object."},"ConversationContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The identifier of the message template in 'your-namespace@your-template-id/name' format. For External vendor (e.g WhatsApp), 'your-namespace@your-template-name'. For GenesysCloud canned response message template use 'cannedresponse' as your-namespace and use response ID as your-template-id (e.g. response ID=1234 then 'cannedresponse@1234')"},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/ConversationNotificationTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/ConversationNotificationTemplateBody"},"footer":{"description":"The template footer.","$ref":"#/definitions/ConversationNotificationTemplateFooter"}},"description":"Template notification object."},"ConversationContentQuickReply":{"type":"object","required":["payload","text"],"properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object."},"ConversationContentQuickReplyV2":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show as the title of the quick reply."},"actions":{"type":"array","description":"An array of quick reply objects.","items":{"$ref":"#/definitions/ConversationContentQuickReply"}}},"description":"Quick reply object V2."},"ConversationContentStory":{"type":"object","properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"An ephemeral story."},"ConversationContentText":{"type":"object","required":["body"],"properties":{"type":{"type":"string","description":"Type of text content (Deprecated).","enum":["Text"]},"body":{"type":"string","description":"Text to be shown for this content element."}},"description":"Message content element containing text only."},"ConversationEventCoBrowse":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of CoBrowse event.","enum":["Offering","OfferingExpired","OfferingAccepted","OfferingRejected"]},"sessionId":{"type":"string","description":"The CoBrowse session ID."},"sessionJoinToken":{"type":"string","description":"The CoBrowse session join token."}},"description":"A CoBrowse event."},"ConversationEventPresence":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Presence event.","enum":["Join","Disconnect","Clear","SignIn"]}},"description":"A Presence event."},"ConversationEventTyping":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Typing event.","enum":["On"]},"duration":{"type":"integer","format":"int64","description":"The duration of the Typing event in milliseconds.","readOnly":true}},"description":"A Typing event."},"ConversationEventVideo":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Video event.","enum":["Offering","OfferingExpired","OfferingAccepted","OfferingRejected"]},"offeringId":{"type":"string","description":"The Video offering ID."},"jwt":{"type":"string","description":"The Video offering JWT token."}},"description":"A Video event."},"ConversationMessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","Unknown"]},"location":{"description":"Location content.","$ref":"#/definitions/ConversationContentLocation"},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ConversationContentAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/ConversationContentQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ConversationContentButtonResponse"},"template":{"description":"Template notification content.","$ref":"#/definitions/ConversationContentNotificationTemplate"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/ConversationContentStory"},"card":{"description":"Card content","$ref":"#/definitions/ConversationContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ConversationContentCarousel"},"text":{"description":"Text content.","$ref":"#/definitions/ConversationContentText"},"quickReplyV2":{"description":"Quick reply V2 content.","$ref":"#/definitions/ConversationContentQuickReplyV2"}},"description":"Message content element. If contentType = \"Attachment\" only one item is allowed."},"ConversationMessageEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Typing","Presence","Video","Unknown"]},"coBrowse":{"description":"CoBrowse event.","$ref":"#/definitions/ConversationEventCoBrowse"},"typing":{"description":"Typing event.","$ref":"#/definitions/ConversationEventTyping"},"presence":{"description":"Presence event.","$ref":"#/definitions/ConversationEventPresence"},"video":{"description":"Video event.","$ref":"#/definitions/ConversationEventVideo"}},"description":"Message event element. Examples include: system messages, typing indicators, cobrowse offerings."},"ConversationMessagingChannel":{"type":"object","properties":{"id":{"type":"string","description":"The integration ID.","readOnly":true},"platform":{"type":"string","description":"The provider type.","readOnly":true,"enum":["Twitter","Facebook","Instagram","Line","Whatsapp","WebMessaging","Open","Sms"]},"messageId":{"type":"string","description":"Unique provider ID of the message such as a Facebook message ID.","readOnly":true},"to":{"description":"Information about the recipient the message is sent to.","readOnly":true,"$ref":"#/definitions/ConversationMessagingToRecipient"},"from":{"description":"Information about the recipient the message is received from.","readOnly":true,"$ref":"#/definitions/ConversationMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Time the message was edited. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateDeleted":{"type":"string","format":"date-time","description":"Time the message was deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Channel-specific information that describes the message and the message channel/provider."},"ConversationMessagingFromRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient."},"firstName":{"type":"string","description":"First name of the recipient."},"lastName":{"type":"string","description":"Last name of the recipient."},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/ConversationRecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is received from."},"ConversationMessagingToRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/ConversationRecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to."},"ConversationNormalizedMessage":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"Unique ID of the message. Message receipts will have the same ID as the message they reference.","readOnly":true},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","readOnly":true,"$ref":"#/definitions/ConversationMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/ConversationMessageContent"}},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/ConversationMessageEvent"}},"status":{"type":"string","description":"Message receipt status, only used with type Receipt.","readOnly":true,"enum":["Sent","Delivered","Read","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","readOnly":true,"items":{"$ref":"#/definitions/ConversationReason"}},"originatingEntity":{"type":"string","description":"Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.","enum":["Human","Bot"]},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected.","readOnly":true},"direction":{"type":"string","description":"The direction of the message.","readOnly":true,"enum":["Inbound","Outbound"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}},"byoSmsIntegrationId":{"type":"string","description":"The internal id representing the customer supplied sms integration message."}},"description":"General rich media message structure with normalized feature support across many messaging channels."},"ConversationNotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored."},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template body object."},"ConversationNotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored."}},"description":"Template footer object."},"ConversationNotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored."},"media":{"description":"Media template header image.","$ref":"#/definitions/ConversationContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template header object."},"ConversationNotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name."},"text":{"type":"string","description":"Parameter text value."}},"description":"Template parameters for placeholders in template."},"ConversationReason":{"type":"object","required":["message"],"properties":{"code":{"type":"string","description":"The reason code for the failed message receipt.","enum":["MessageExpired","RateLimited","MessageNotAllowed","GeneralError","UnsupportedMessage","UnknownMessage","InvalidMessageStructure","InvalidDestination","ServerError","MediaTypeNotAllowed","InvalidMediaContentLength","RecipientOptedOut"]},"message":{"type":"string","description":"Description of the reason for the failed message receipt."}},"description":"Reasons for a failed message receipt."},"ConversationRecipientAdditionalIdentifier":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the Identifier","readOnly":true,"enum":["Deployment","Subject","Unknown"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"MessageData":{"type":"object","required":["status","textBody","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerMessageId":{"type":"string","description":"The unique identifier of the message from provider"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"]},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"textBody":{"type":"string","description":"The body of the text message. (Deprecated - Instead use normalizedMessage.text)"},"status":{"type":"string","description":"The status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read","removed","published"]},"media":{"type":"array","description":"The media details associated to a message. (Deprecated - Instead use normalizedMessage.content[index].attachment)","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"The sticker details associated to a message. (Deprecated - Instead use normalizedMessage.content[index].attachment","items":{"$ref":"#/definitions/MessageSticker"}},"normalizedMessage":{"description":"The message into normalized format","readOnly":true,"$ref":"#/definitions/ConversationNormalizedMessage"},"normalizedReceipts":{"type":"array","description":"The delivery event associated with this message in normalized format, if the message direction was outbound","readOnly":true,"items":{"$ref":"#/definitions/ConversationNormalizedMessage"}},"createdBy":{"description":"User who sent this message.","$ref":"#/definitions/User"},"conversationId":{"type":"string","description":"The id of the conversation of this message."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/MessageMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recentTransfers":{"type":"array","description":"The list of the most recent 20 transfer commands applied to this conversation.","items":{"$ref":"#/definitions/TransferResponse"}},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","endpoint.donotdisturb","client","system","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc","items":{"type":"string"}},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toAddress":{"description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"Message instance details on the communication.","items":{"$ref":"#/definitions/MessageDetails"}},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging","open","instagram"]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"authenticated":{"type":"boolean","description":"If true, the participant member is authenticated."},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a message monitor."},"monitoredParticipant":{"description":"The participant being monitored when performing a message monitor.","$ref":"#/definitions/AddressableEntityRef"}}},"AdditionalMessage":{"type":"object","required":["textBody"],"properties":{"textBody":{"type":"string","description":"The body of the text message. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."},"mediaIds":{"type":"array","description":"The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.","items":{"type":"string"}},"stickerIds":{"type":"array","description":"The sticker ids associated with the text message.","items":{"type":"string"}},"messagingTemplate":{"description":"The messaging template use to send a predefined canned response with the message","$ref":"#/definitions/MessagingTemplateRequest"}}},"MessagingTemplateRequest":{"type":"object","properties":{"responseId":{"type":"string","description":"A Response Management response identifier for a messaging template defined response"},"parameters":{"type":"array","description":"A list of Response Management response substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}}}},"TemplateParameter":{"type":"object","properties":{"id":{"type":"string","description":"Response substitution identifier"},"value":{"type":"string","description":"Response substitution value"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}}}},"OpenMessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","enum":["Attachment"]},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ConversationContentAttachment"}},"description":"Message content element."},"OpenMessagingChannel":{"type":"object","required":["from","time","to"],"properties":{"id":{"type":"string","description":"The Messaging Platform integration ID.","readOnly":true},"platform":{"type":"string","description":"The provider type.","readOnly":true,"enum":["Open"]},"type":{"type":"string","description":"Specifies if this message is part of a private or public conversation.","enum":["Private"]},"messageId":{"type":"string","description":"Unique provider ID of the message such as a Facebook message ID."},"to":{"description":"Information about the recipient the message is sent to.","$ref":"#/definitions/OpenMessagingToRecipient"},"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Information about the channel.","$ref":"#/definitions/ConversationChannelMetadata"}},"description":"Channel-specific information that describes the message and the message channel/provider."},"OpenMessagingFromRecipient":{"type":"object","required":["id","idType"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient."},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","enum":["Email","Phone","Opaque"]},"firstName":{"type":"string","description":"First name of the recipient."},"lastName":{"type":"string","description":"Last name of the recipient."},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient."}},"description":"Information about the recipient the message is received from."},"OpenMessagingToRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","readOnly":true,"enum":["Email","Phone","Opaque"]},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient."}},"description":"Information about the recipient the message is sent to."},"OpenNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference, as such should only be set when sending a message receipt."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Receipt"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenMessageContent"}},"status":{"type":"string","description":"Message receipt status, only used with type Receipt.","enum":["Sent","Delivered","Read","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."},"direction":{"type":"string","description":"The direction of the message.","enum":["Inbound","Outbound"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"CreateOutboundMessagingConversationRequest":{"type":"object","required":["queueId","toAddress","toAddressMessengerType"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to be associated with the message. This will determine the fromAddress of the message."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. For whatsapp messenger type, use a Whatsapp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a Whatsapp ID would be 13175555555"},"toAddressMessengerType":{"type":"string","description":"The messaging address messenger type.","enum":["sms","open","whatsapp"]},"useExistingConversation":{"type":"boolean","description":"An override to use an existing conversation. \nIf set to true, an existing conversation will be used if there is one within the conversation window. \nIf set to false, create request fails if there is a conversation within the conversation window."},"externalContactId":{"type":"string","description":"The external contact with which the message will be associated."}}},"MessageMediaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The detected internet media type of the the media object. If null then the media type should be dictated by the url."},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"uploadUrl":{"type":"string","description":"The URL returned to upload an attachment"},"status":{"type":"string","description":"The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid","readOnly":true,"enum":["uploading","valid","invalid"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SendAgentlessOutboundMessageResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"fromAddress":{"type":"string","description":"The sender of the message."},"toAddress":{"type":"string","description":"The recipient of the message."},"messengerType":{"type":"string","description":"Type of messenger.","enum":["sms","whatsapp","open"]},"textBody":{"type":"string","description":"The body of the text message."},"messagingTemplate":{"description":"The messaging template sent","$ref":"#/definitions/MessagingTemplateRequest"},"useExistingActiveConversation":{"type":"boolean","description":"Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false"},"message":{"description":"Sent agentless outbound message in normalized format","$ref":"#/definitions/MessageData"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SendAgentlessOutboundMessageRequest":{"type":"object","required":["fromAddress","toAddress","toAddressMessengerType"],"properties":{"fromAddress":{"type":"string","description":"The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID"},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555"},"toAddressMessengerType":{"type":"string","description":"The recipient messaging address messenger type.","enum":["sms","whatsapp","open"]},"textBody":{"type":"string","description":"The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."},"messagingTemplate":{"description":"The messaging template to use in the case of WhatsApp messenger type. This field is required when using WhatsApp messenger type","$ref":"#/definitions/MessagingTemplateRequest"},"useExistingActiveConversation":{"type":"boolean","description":"Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false"}}},"OpenEventNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message generated by Messaging Platform."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Event"]},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/OpenMessageEvent"}}},"description":"Open Messaging rich media message structure"},"OpenMessageEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["Typing"]},"typing":{"description":"Typing event.","$ref":"#/definitions/ConversationEventTyping"}},"description":"Message event element."},"OpenEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["Typing"]}},"description":"Message event element."},"OpenInboundMessagingChannel":{"type":"object","required":["from","time"],"properties":{"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Open Channel-specific information that describes the message and the message channel/provider."},"OpenInboundNormalizedEvent":{"type":"object","required":["channel","events"],"properties":{"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessagingChannel"},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/OpenEvent"}}},"description":"Open Event Messaging rich media message structure"},"OpenMessageNormalizedMessage":{"type":"object","required":["channel","type"],"properties":{"id":{"type":"string","description":"Unique ID of the message generated by Messaging Platform."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenMessageContent"}},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"OpenContentAttachment":{"type":"object","required":["mediaType","mime","url"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, middleware media UUID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."}},"description":"Attachment object."},"OpenInboundMessageContent":{"type":"object","properties":{"attachment":{"description":"Attachment content.","$ref":"#/definitions/OpenContentAttachment"}},"description":"Message content element."},"OpenInboundMessageMessagingChannel":{"type":"object","required":["from","time"],"properties":{"from":{"description":"Information about the recipient the message is received from.","$ref":"#/definitions/OpenMessagingFromRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageId":{"type":"string","description":"Unique provider ID of the message."},"metadata":{"description":"Additional Custom Information about the channel.","$ref":"#/definitions/ConversationChannelMetadata"}},"description":"Open Channel-specific information that describes the message and the message channel/provider, with additional message information"},"OpenInboundNormalizedMessage":{"type":"object","required":["channel"],"properties":{"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessageMessagingChannel"},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/OpenInboundMessageContent"}},"metadata":{"type":"object","description":"Additional metadata about this message to capture non-channel specific data.","additionalProperties":{"type":"string"}}},"description":"Open Messaging rich media message structure"},"ContentButtonResponse":{"type":"object","required":["payload","text","type"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"OpenReceiptNormalizedMessage":{"type":"object","required":["channel","direction","id","status","type"],"properties":{"id":{"type":"string","description":"The original unique message Id generated by the messaging platform, that this receipt message is referencing."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Receipt"]},"status":{"type":"string","description":"Message receipt status.","enum":["Sent","Delivered","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."},"direction":{"type":"string","description":"The direction of the message.","enum":["Inbound","Outbound"]}},"description":"Open Messaging rich media message structure"},"OpenInboundMessagingReceiptChannel":{"type":"object","required":["time","to"],"properties":{"to":{"description":"Information about the recipient the message is intended for.","$ref":"#/definitions/OpenMessagingToRecipient"},"time":{"type":"string","format":"date-time","description":"Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Open Channel-specific information that describes the message and the message channel/provider."},"OpenInboundNormalizedReceipt":{"type":"object","required":["channel","id","status"],"properties":{"id":{"type":"string","description":"The original unique message Id generated by the messaging platform, that this receipt message is referencing."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/OpenInboundMessagingReceiptChannel"},"status":{"type":"string","description":"Message receipt status.","enum":["Sent","Delivered","Failed","Published","Removed"]},"reasons":{"type":"array","description":"List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.","items":{"$ref":"#/definitions/ConversationReason"}},"isFinalReceipt":{"type":"boolean","description":"Indicates if this is the last message receipt for this message, or if another message receipt can be expected."}},"description":"Open Messaging rich media message structure"},"MessageTypingEventRequest":{"type":"object","required":["typing"],"properties":{"typing":{"description":"Typing event","$ref":"#/definitions/ConversationEventTyping"},"dateSent":{"type":"string","format":"date-time","description":"The time when the message typing event was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ContentSetting":{"type":"object","properties":{"story":{"description":"Settings relating to facebook and instagram stories feature","$ref":"#/definitions/StorySetting"}}},"EventSetting":{"type":"object","properties":{"typing":{"description":"Settings regarding typing events","$ref":"#/definitions/TypingSetting"}}},"InboundOnlySetting":{"type":"object","properties":{"inbound":{"type":"string","enum":["Enabled","Disabled"]}}},"MediaType":{"type":"object","properties":{"type":{"type":"string","description":"The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types."}},"description":"Media type definition"},"MediaTypeAccess":{"type":"object","properties":{"inbound":{"type":"array","description":"List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.","items":{"$ref":"#/definitions/MediaType"}},"outbound":{"type":"array","description":"List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.","items":{"$ref":"#/definitions/MediaType"}}},"description":"Media type access definitions"},"MediaTypes":{"type":"object","properties":{"allow":{"description":"Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.","$ref":"#/definitions/MediaTypeAccess"}},"description":"Media types"},"MessagingIntegration":{"type":"object","required":["id","messengerType","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Integration","readOnly":true},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"status":{"type":"string","description":"The status of the Integration","readOnly":true,"enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"recipient":{"description":"The recipient associated to the Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSettingReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration"},"name":{"type":"string","description":"The messaging Setting profile name","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The messaging Setting profile URI","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Date this messaging Setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this messaging Setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"string","description":"Version number"},"createdBy":{"description":"User reference that created this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"updatedBy":{"description":"User reference that modified this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"}},"description":"Messaging Setting for messaging platform integrations"},"SettingDirection":{"type":"object","properties":{"inbound":{"type":"string","description":"Status for the Inbound Direction","enum":["Enabled","Disabled"]},"outbound":{"type":"string","description":"Status for the Outbound Direction","enum":["Enabled","Disabled"]}}},"StorySetting":{"type":"object","properties":{"mention":{"description":"Setting relating to Story Mentions","$ref":"#/definitions/InboundOnlySetting"},"reply":{"description":"Setting relating to Story Replies","$ref":"#/definitions/InboundOnlySetting"}}},"SupportedContentReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The SupportedContent unique identifier associated with this integration"},"name":{"type":"string","description":"The SupportedContent profile name","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The SupportedContent profile URI","readOnly":true},"mediaTypes":{"description":"Media types definition for the supported content","readOnly":true,"$ref":"#/definitions/MediaTypes"}},"description":"Reference to supported content profile associated with the integration"},"TypingSetting":{"type":"object","properties":{"on":{"description":"Should typing indication Events be sent","$ref":"#/definitions/SettingDirection"}}},"ConversationThreadingWindow":{"type":"object","required":["settings"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"settings":{"type":"array","description":"The conversation threading window timeout (Minutes) for each messaging type","items":{"$ref":"#/definitions/ConversationThreadingWindowSetting"}},"defaultTimeoutMinutes":{"type":"integer","format":"int64","description":"The default conversation threading window timeout (Minutes)","readOnly":true}}},"ConversationThreadingWindowSetting":{"type":"object","required":["messengerType","timeoutInMinutes"],"properties":{"messengerType":{"type":"string","description":"The type of messenger","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"timeoutInMinutes":{"type":"integer","format":"int64","description":"The conversation threading window timeout (Minutes) of specified messenger type"}}},"FacebookAppCredentials":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Genesys Cloud Facebook App Id","readOnly":true}}},"FacebookIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"appId":{"type":"string","description":"The App Id from Facebook messenger"},"pageId":{"type":"string","description":"The Page Id from Facebook messenger"},"pageName":{"type":"string","description":"The name of the Facebook page","readOnly":true},"pageProfileImageUrl":{"type":"string","description":"The url of the profile image of the Facebook page","readOnly":true},"status":{"type":"string","description":"The status of the Facebook Integration"},"recipient":{"description":"The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingSettingRequestReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration"}},"description":"Messaging Setting for messaging platform integrations"},"FacebookIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Facebook user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page Id of Facebook page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app Id of Facebook app. The appId is required when a customer wants to use their own approved Facebook app."},"appSecret":{"type":"string","description":"The app Secret of Facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacebookPermission":{"type":"object","properties":{"name":{"type":"string","description":"Facebook permission name","readOnly":true},"type":{"type":"string","description":"Facebook permission type","readOnly":true,"enum":["FacebookPrivate","FacebookPublic","InstagramPrivate","WhatsAppPrivate"]}},"description":"Facebook Permissions Model"},"FacebookPermissionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookPermission"}}}},"InstagramIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration ID.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"appId":{"type":"string","description":"The App ID from Facebook"},"pageId":{"type":"string","description":"The Page ID from Instagram messenger"},"instagramId":{"type":"string","description":"The ID from Instagram messenger"},"instagramUsername":{"type":"string","description":"The Username from Instagram messenger"},"instagramName":{"type":"string","description":"The name from Instagram messenger"},"instagramProfileImageUrl":{"type":"string","description":"The url of the profile image from Instagram messenger"},"status":{"type":"string","description":"The status of the Instagram Integration"},"recipient":{"description":"The recipient reference associated to the Instagram Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InstagramIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the Instagram user logged into the Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InstagramIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InstagramIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InstagramIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Instagram Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of Instagram page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of Instagram user logged into Facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page ID of Instagram page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app ID of Facebook app. The appId is required when a customer wants to use their own approved Facebook app."},"appSecret":{"type":"string","description":"The app Secret of Facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegration":{"type":"object","required":["id","name","outboundNotificationWebhookSignatureSecretToken","outboundNotificationWebhookUrl"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"status":{"type":"string","description":"The status of the Open Integration"},"recipient":{"description":"The recipient associated to the Open messaging Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationUpdateRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationRequest":{"type":"object","required":["name","outboundNotificationWebhookSignatureSecretToken","outboundNotificationWebhookUrl"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Open messaging integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"outboundNotificationWebhookUrl":{"type":"string","description":"The outbound notification webhook URL for the Open messaging integration."},"outboundNotificationWebhookSignatureSecretToken":{"type":"string","description":"The outbound notification webhook signature secret token. This token must be longer than 15 characters."},"webhookHeaders":{"type":"object","description":"The user specified headers for the Open messaging integration.","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OpenIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OpenIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSetting":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The messaging Setting unique identifier associated with this integration","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"dateCreated":{"type":"string","format":"date-time","description":"Date this messaging setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this messaging setting was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"string","description":"Version number","readOnly":true},"createdBy":{"description":"User reference that created this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"updatedBy":{"description":"User reference that modified this Setting","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"content":{"description":"Configuration relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Configuration relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"MessagingSettingDefaultRequest":{"type":"object","required":["settingId"],"properties":{"settingId":{"type":"string","description":"Messaging Setting ID to be used as the default for this Organization."}}},"MessagingConfigListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingSetting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingSettingRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"MessagingSettingPatchRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The messaging Setting profile name"},"content":{"description":"Settings relating to message contents","$ref":"#/definitions/ContentSetting"},"event":{"description":"Settings relating to events which may occur","$ref":"#/definitions/EventSetting"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Messaging setting for messaging platform integrations"},"SupportedContent":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"A unique supported content Id.","readOnly":true},"name":{"type":"string","description":"The name of the supported content profile"},"dateCreated":{"type":"string","format":"date-time","description":"Date this supported content profile was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this supported content profile was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this supported content profile","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that modified this supported content profile","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number","readOnly":true},"mediaTypes":{"description":"Defines the allowable media that may be accepted for an inbound message or to be sent in an outbound message. The following is an example of allowing all inbound media, and for outbound all images and only mpeg video: {\n \"mediaTypes\": {\n \"allow\": {\n \"inbound\": [{\"type\": \"*/*\"}],\n \"outbound\": [{\"type\": \"image/*\"}, {\"type\": \"video/mpeg\"}]\n }\n }\n}","$ref":"#/definitions/MediaTypes"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Supported content profile for inbound and outbound messages"},"SupportedContentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SupportedContent"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppAvailablePhoneNumberDetails":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","description":"The verified name associated with this phone number.","readOnly":true},"phoneNumber":{"type":"string","description":"The display name associated with this phone number. It's typically the E.164 representation of the number.","readOnly":true},"status":{"type":"string","description":"The status of this phone number.","readOnly":true}}},"WhatsAppAvailablePhoneNumberDetailsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppAvailablePhoneNumberDetails"}}}},"WhatsAppIntegration":{"type":"object","required":["id","name","phoneNumber","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp integration."},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"$ref":"#/definitions/MessagingSettingReference"},"phoneNumber":{"type":"string","description":"The phone number associated to the WhatsApp integration."},"availablePhoneNumbers":{"description":"The list of available WhatsApp phone numbers for this account. Please select one phone number from this list to use with the created integration.","readOnly":true,"$ref":"#/definitions/WhatsAppAvailablePhoneNumberDetailsListing"},"status":{"type":"string","description":"The status of the WhatsApp Integration","enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"]},"recipient":{"description":"The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"activationStatusCode":{"type":"string","description":"The status code of WhatsApp Integration activation process","readOnly":true,"enum":["CodeSent","WaitRequired","ActivationFailed","CodeConfirmed","ConfirmationFailed","ResendCode"]},"activationErrorInfo":{"description":"The error information of WhatsApp Integration activation process","readOnly":true,"$ref":"#/definitions/ErrorBody"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppEmbeddedSignupIntegrationActivationRequest":{"type":"object","required":["phoneNumber","pin"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name","readOnly":true},"phoneNumber":{"type":"string","description":"Phone number to associate with the WhatsApp integration"},"pin":{"type":"string","description":"Specify the two-step verification PIN for that phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppEmbeddedSignupIntegrationRequest":{"type":"object","required":["embeddedSignupAccessToken","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"embeddedSignupAccessToken":{"type":"string","description":"The access token returned from the embedded signup flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationRequest":{"type":"object","required":["name","phoneNumber","wabaCertificate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"supportedContent":{"description":"Defines the SupportedContent profile configured for an integration","$ref":"#/definitions/SupportedContentReference"},"messagingSetting":{"description":"Defines the message settings to be applied for this integration","$ref":"#/definitions/MessagingSettingRequestReference"},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration"},"wabaCertificate":{"type":"string","description":"The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Digits":{"type":"object","properties":{"digits":{"type":"string","description":"A string representing the digits pressed on phone."}}},"CreateCallbackOnConversationCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}},"callerId":{"type":"string","description":"The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."},"callerIdName":{"type":"string","description":"The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."}}},"TransferToAgentRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"userId":{"type":"string","description":"The id of the internal user."},"userName":{"type":"string","description":"The userName (like user’s email) of the internal user."},"userDisplayName":{"type":"string","description":"The name of the internal user."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"TransferToQueueRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"queueId":{"type":"string","description":"The id of the queue."},"queueName":{"type":"string","description":"The name of the queue."}}},"TransferToExternalRequest":{"type":"object","properties":{"transferType":{"type":"string","description":"The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.","enum":["Attended","Unattended"]},"address":{"type":"string","description":"The address (like phone number) of the external contact."}}},"SecureSession":{"type":"object","required":["flow","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"The flow to execute securely","$ref":"#/definitions/DomainEntityRef"},"userData":{"type":"string","description":"Customer-provided data"},"state":{"type":"string","description":"The current state of a secure session","enum":["PENDING","COMPLETED","FAILED"]},"sourceParticipantId":{"type":"string","description":"Unique identifier for the participant initiating the secure session."},"disconnect":{"type":"boolean","description":"If true, disconnect the agent after creating the session"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateSecureSession":{"type":"object","required":["flowId","userData"],"properties":{"sourceParticipantId":{"type":"string","description":"requesting participant"},"flowId":{"type":"string","description":"the flow id to execute in the secure session"},"userData":{"type":"string","description":"user data for the secure session"},"disconnect":{"type":"boolean","description":"if true, disconnect the agent after creating the session"}}},"SecureSessionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecureSession"}}}},"FeedbackAddRequest":{"type":"object","required":["summary"],"properties":{"summary":{"type":"string","example":"Customer wants to cancel the ticket and he is happy with the service.","description":"Agent's summary for the conversation"},"rating":{"type":"string","description":"Agent’s rating for the system-generated summary.","enum":["Positive","Negative"]}}},"Credential":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"description":"The type of credential.","$ref":"#/definitions/CredentialType"},"credentialFields":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"properties":{"type":"object","description":"Properties describing credentials of this type.","readOnly":true},"displayOrder":{"type":"array","description":"Order in which properties should be displayed in the UI.","readOnly":true,"items":{"type":"string"}},"required":{"type":"array","description":"Properties that are required fields.","readOnly":true,"items":{"type":"string"}}}},"CredentialInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date the credentials were created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date credentials were last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"description":"Type of the credentials.","$ref":"#/definitions/CredentialType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialTypeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialInfoListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UploadUrlResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"LearningCoverArtUploadUrlRequest":{"type":"object","required":["contentType"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"contentType":{"type":"string","description":"The content type of the file to upload.","enum":["image/bmp","image/gif","image/jpeg","image/jpg","image/png"]},"serverSideEncryption":{"type":"string","enum":["AES256"]}}},"UploadUrlRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"contentType":{"type":"string","description":"The content type of the file to upload. Allows all MIME types"},"serverSideEncryption":{"type":"string","enum":["AES256"]}}},"Coretype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"A positive integer denoting the core type's version"},"dateCreated":{"type":"string","format":"date-time","description":"The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schema":{"description":"The core type's built-in schema","$ref":"#/definitions/Schema"},"current":{"type":"boolean","description":"A boolean indicating if the core type's version is the current one in use by the system"},"validationFields":{"type":"array","description":"An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type.","items":{"type":"string"}},"validationLimits":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/ValidationLimits"},"itemValidationFields":{"type":"array","description":"Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation","items":{"type":"string"}},"itemValidationLimits":{"example":"\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.","$ref":"#/definitions/ItemValidationLimits"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ItemValidationLimits":{"type":"object","required":["maxLength","minLength"],"properties":{"minLength":{"example":"\"minLength\": {\"min\": 0, \"max\": 100}","description":"A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MinLength"},"maxLength":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MaxLength"}}},"Items":{"type":"object","properties":{"type":{"type":"string"},"pattern":{"type":"string"}}},"MaxLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance."}}},"MinLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance."}}},"Schema":{"type":"object","properties":{"title":{"type":"string","description":"A core type's title","readOnly":true},"description":{"type":"string","description":"A core type's description","readOnly":true},"type":{"type":"array","example":"[\"string\"] for a text-based core type, [\"integer\"] for a numeric core type, or [\"boolean\", \"null\"] for the checkbox core type","description":"An array of fundamental JSON Schema primitive types on which the core type is based","readOnly":true,"items":{"type":"string"}},"items":{"example":"{\ntype\": \"string\",\n\"pattern\": \"^[\\\\S]+$\"\n}","description":"Denotes the type and pattern of the items in an enum core type","readOnly":true,"$ref":"#/definitions/Items"},"pattern":{"type":"string","description":"For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format","readOnly":true}}},"ValidationLimits":{"type":"object","properties":{"minLength":{"$ref":"#/definitions/MinLength"},"maxLength":{"$ref":"#/definitions/MaxLength"},"minItems":{"$ref":"#/definitions/MinLength"},"maxItems":{"$ref":"#/definitions/MaxLength"},"minimum":{"$ref":"#/definitions/MinLength"},"maximum":{"$ref":"#/definitions/MaxLength"}}},"CoretypeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Coretype"}},"selfUri":{"type":"string","format":"uri"}}},"SchemaQuantityLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":1","description":"The minimum number of schema field name characters allowed.","readOnly":true},"maxFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":100","description":"The maximum number of schema field name characters allowed.","readOnly":true},"minFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minFieldDescriptionCharacters\":0","description":"The minimum number of schema field description characters allowed.","readOnly":true},"maxFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxFieldDescriptionCharacters\":200","description":"The maximum number of schema field description characters allowed.","readOnly":true},"minSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"minSchemaNameCharacters\":1","description":"The minimum number of schema name characters allowed.","readOnly":true},"maxSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaNameCharacters\":50","description":"The maximum number of schema name characters allowed.","readOnly":true},"minSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minSchemaDescriptionCharacters\":0","description":"The minimum number of schema description characters allowed.","readOnly":true},"maxSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaDescriptionCharacters\":200","description":"The maximum number of schema description characters allowed.","readOnly":true},"maxNumberOfSchemasPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfSchemasPerOrg\":20","description":"The maximum number of schema allowed per org.","readOnly":true},"maxNumberOfFieldsPerSchema":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerSchema\":25","description":"The maximum number of schema fields allowed per schema.","readOnly":true},"maxNumberOfFieldsPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerOrg\":500","description":"The maximum number of schema fields allowed per organization across all of their schemas.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataTable":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The description from the JSON schema (equates to the Description field on the JSON schema.)"},"schema":{"description":"the schema as stored in the system.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself"},"DataTableExportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the export job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the export job","enum":["Processing","Failed","Succeeded"]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"downloadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can download the export file, when available"},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an export job of rows from a datatable"},"DataTableImportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the import job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the import job","enum":["WaitingForUpload","Processing","Failed","Succeeded"]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can upload the file to be imported"},"importMode":{"type":"string","description":"The indication of whether the processing should remove rows that don't appear in the import file","enum":["ReplaceAll","Append"]},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsUpdated":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"countRecordsDeleted":{"type":"integer","format":"int32","description":"The current count of the number of records deleted"},"countRecordsFailed":{"type":"integer","format":"int32","description":"The current count of the number of records that failed to import"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an import job of rows to a datatable"},"DataTableImportEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTableImportJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"DataTablesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTable"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataTableRowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string","description":"The current stage for this agent"}}},"AttemptLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxAttemptsPerContact":{"type":"integer","format":"int32","description":"The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."},"maxAttemptsPerNumber":{"type":"integer","format":"int32","description":"The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."},"timeZoneId":{"type":"string","description":"If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY."},"resetPeriod":{"type":"string","description":"After how long the number of attempts will be set back to 0. Defaults to NEVER.","enum":["NEVER","TODAY"]},"recallEntries":{"type":"object","description":"Configuration for recall attempts.","additionalProperties":{"$ref":"#/definitions/RecallEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecallEntry":{"type":"object","properties":{"nbrAttempts":{"type":"integer","format":"int32"},"minutesBetweenAttempts":{"type":"integer","format":"int32"}}},"AttemptLimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttemptLimits"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Reaction":{"type":"object","required":["reactionType"],"properties":{"data":{"type":"string","description":"Parameter for this reaction. For transfer_flow, this would be the outbound flow id."},"name":{"type":"string","description":"Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name."},"reactionType":{"type":"string","description":"The reaction to take for a given call analysis result.","enum":["hangup","transfer","transfer_flow","play_file"]}}},"ResponseSet":{"type":"object","required":["name","responses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the ResponseSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}.","additionalProperties":{"$ref":"#/definitions/Reaction"}},"beepDetectionEnabled":{"type":"boolean","description":"Whether to enable answering machine beep detection"},"amdSpeechDistinguishEnabled":{"type":"boolean","description":"Whether to enable answering machine detection"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallableTime":{"type":"object","required":["timeSlots","timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"The time intervals for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the time slots; for example, Africa/Abidjan"}}},"CallableTimeSet":{"type":"object","required":["callableTimes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CallableTimeSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"The list of CallableTimes for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignTimeSlot":{"type":"object","required":["day","startTime","stopTime"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"stopTime":{"type":"string","example":"08:00:00","description":"The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"day":{"type":"integer","format":"int32","example":1,"description":"The day of the interval. Valid values: [1-7], representing Monday through Sunday"}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactCallbackRequest":{"type":"object","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"CampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"securePause":{"type":"boolean","description":"True when the recording of this call is in secure pause status."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","endpoint.donotdisturb","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.donotdisturb","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"},"disposition":{"description":"Call resolution data for Dialer bulk make calls commands.","$ref":"#/definitions/Disposition"}}},"CallbackBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"initialState":{"type":"string","description":"The initial connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"callerId":{"type":"string","description":"The phone number displayed to recipients of the phone call. The value should conform to the E164 format."},"callerIdName":{"type":"string","description":"The name displayed to recipients of the phone call."},"queueMediaSettings":{"description":"Represents the queue settings for this media type.","$ref":"#/definitions/ConversationQueueMediaSettings"}}},"CampaignInteraction":{"type":"object","properties":{"id":{"type":"string"},"campaign":{"$ref":"#/definitions/DomainEntityRef"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"contact":{"$ref":"#/definitions/DomainEntityRef"},"destinationAddress":{"type":"string"},"activePreviewCall":{"type":"boolean","description":"Boolean value if there is an active preview call on the interaction"},"lastActivePreviewWrapupTime":{"type":"string","format":"date-time","description":"The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callPlacedTime":{"type":"string","format":"date-time","description":"The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callRoutedTime":{"type":"string","format":"date-time","description":"The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"previewConnectedTime":{"type":"string","format":"date-time","description":"The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/DomainEntityRef"},"script":{"$ref":"#/definitions/DomainEntityRef"},"disposition":{"type":"string","description":"Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer","enum":["DISCONNECT","LIVE_VOICE","BUSY","MACHINE","NO_ANSWER","SIT_CALLABLE","SIT_UNCALLABLE","FAX"]},"callerName":{"type":"string"},"callerAddress":{"type":"string"},"previewPopDeliveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"$ref":"#/definitions/ConversationBasic"},"dialerSystemParticipantId":{"type":"string","description":"conversation participant id that is the dialer system participant to monitor the call from dialer perspective"},"dialingMode":{"type":"string"},"skills":{"type":"array","description":"Any skills that are attached to the call for routing","uniqueItems":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignInteractions":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/DomainEntityRef"},"pendingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"proceedingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"previewingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"interactingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"scheduledInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}}}},"ConversationBasic":{"type":"object","required":["startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"externalTag":{"type":"string","description":"The external tag associated with the conversation."},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"securePause":{"type":"boolean","description":"True when the recording of this conversation is in secure pause status."},"utilizationLabelId":{"type":"string","description":"An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"participants":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ParticipantBasic"}}}},"ParticipantBasic":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"mediaRoles":{"type":"array","description":"List of roles this participant's media has had on the conversation, ie monitor, coach, etc.","items":{"type":"string"}},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/CallBasic"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/CallbackBasic"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"bargedParticipantId":{"type":"string","description":"If this participant barged in a participant's call, then this will be the id of the targeted participant."}}},"CampaignOutboundLinesAllocation":{"type":"object","properties":{"campaign":{"description":"The Campaign","$ref":"#/definitions/DomainEntityRef"},"campaignWeight":{"type":"integer","format":"int32","description":"The relative weight of the campaign"},"linesAssigned":{"type":"integer","format":"int32","description":"The number of lines dynamically assigned to the campaign"},"legacyWeight":{"type":"boolean","description":"true if relative weight of the campaign is not explicitly specified, false otherwise"}}},"CampaignOutboundLinesDistribution":{"type":"object","properties":{"campaign":{"description":"The Campaign for which dialing group distribution information was requested","$ref":"#/definitions/AddressableEntityRef"},"maxOutboundLineCount":{"type":"integer","format":"int32","description":"Maximum outbound calls that can be placed for Campaign's Edge Group or Site"},"maxLineUtilization":{"type":"number","description":"Maximum ratio of dialer calls to Campaign's Edge Group or Site capacity"},"availableOutboundLines":{"type":"integer","format":"int32","description":"Number of available outbound lines in Campaign's Edge Group or Site"},"reservedLines":{"type":"integer","format":"int32","description":"Number of reserved outbound lines in Campaign's Edge Group or Site"},"campaignsWithReservedLines":{"type":"array","description":"Information about campaigns with reserving lines in Campaign's Edge Group or Site","items":{"$ref":"#/definitions/CampaignOutboundLinesReservation"}},"campaignsWithDynamicallyAllocatedLines":{"type":"array","description":"Information about campaigns using dynamic lines allocation in Campaign's Edge Group or Site","items":{"$ref":"#/definitions/CampaignOutboundLinesAllocation"}}},"description":"Lines distribution information or Campaign's Edge Group or Site"},"CampaignOutboundLinesReservation":{"type":"object","properties":{"campaign":{"description":"The Campaign","$ref":"#/definitions/DomainEntityRef"},"linesReserved":{"type":"integer","format":"int32","description":"The number of lines reserved for the campaign"}}},"CampaignProgress":{"type":"object","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/DomainEntityRef"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts called during the campaign","readOnly":true},"numberOfContactsMessaged":{"type":"integer","format":"int64","description":"Number of contacts messaged during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true},"numberOfContactsSkipped":{"type":"object","description":"Number of contacts skipped during the campaign","readOnly":true,"additionalProperties":{"type":"integer","format":"int32"}}}},"AgentOwnedMappingPreview":{"type":"object","properties":{"agentOwnedColumn":{"type":"string","description":"The raw value of the agent-owned column","readOnly":true},"email":{"type":"string","description":"The email address of the user, if it exists","readOnly":true},"userId":{"type":"string","description":"The id of the user, if it exists","readOnly":true},"exists":{"type":"boolean","description":"Whether the user exists","readOnly":true},"isQueueMember":{"type":"boolean","description":"Whether the user is a member of the campaign's queue","readOnly":true},"recordCount":{"type":"integer","format":"int32","description":"The number of contact records whose agent-owned column matches the raw value","readOnly":true}}},"AgentOwnedMappingPreviewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentOwnedMappingPreview"}}}},"CallableContactsDiagnostic":{"type":"object","properties":{"attemptLimits":{"description":"Attempt limits for the campaign's contact list","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"ruleSetDiagnostics":{"type":"array","description":"Information regarding the campaign's rule sets","readOnly":true,"items":{"$ref":"#/definitions/RuleSetDiagnostic"}},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","readOnly":true},"scheduledInteractionsCount":{"type":"integer","format":"int32","description":"Current number of scheduled interactions on the campaign","readOnly":true},"timeZoneRescheduledCallsCount":{"type":"integer","format":"int32","description":"Current number of time zone rescheduled calls on the campaign","readOnly":true},"campaignSkillStatistics":{"description":"Information regarding the campaign's skills","readOnly":true,"$ref":"#/definitions/CampaignSkillStatistics"}}},"CampaignSkillStatistics":{"type":"object","properties":{"skillCombinations":{"type":"integer","format":"int32","description":"Number of available skill combinations for the campaign","readOnly":true},"eligibleSkilledAgents":{"type":"integer","format":"int32","description":"Number of eligible agents with skills for campaign","readOnly":true}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"RuleSetDiagnostic":{"type":"object","properties":{"ruleSet":{"description":"A campaign rule set","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"warnings":{"type":"array","description":"Diagnostic warnings for the rule set","readOnly":true,"items":{"type":"string","enum":["WRAPUP_CODE_NOT_IN_QUEUE","CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST","NO_DNC_LIST_FOR_APPEND","PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"]}}}},"CampaignRule":{"type":"object","required":["campaignRuleActions","campaignRuleConditions","campaignRuleEntities","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CampaignRule."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaignRuleEntities":{"description":"The list of entities that this CampaignRule monitors.","$ref":"#/definitions/CampaignRuleEntities"},"campaignRuleConditions":{"type":"array","description":"The list of conditions that are evaluated on the entities.","items":{"$ref":"#/definitions/CampaignRuleCondition"}},"campaignRuleActions":{"type":"array","description":"The list of actions that are executed if the conditions are satisfied.","items":{"$ref":"#/definitions/CampaignRuleAction"}},"matchAnyConditions":{"type":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this CampaignRule is currently enabled. Required on updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignRuleAction":{"type":"object","required":["actionType","campaignRuleActionEntities"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleAction. Required for certain actionTypes.","$ref":"#/definitions/CampaignRuleParameters"},"actionType":{"type":"string","description":"The action to take on the campaignRuleActionEntities.","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode","setCampaignAbandonRate","setCampaignNumberOfLines","setCampaignWeight","setCampaignMaxCallsPerAgent","changeCampaignQueue"]},"campaignRuleActionEntities":{"description":"The list of entities that this action will apply to.","$ref":"#/definitions/CampaignRuleActionEntities"}}},"CampaignRuleActionEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}},"useTriggeringEntity":{"type":"boolean","description":"If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition."}}},"CampaignRuleCondition":{"type":"object","required":["conditionType","parameters"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleCondition.","$ref":"#/definitions/CampaignRuleParameters"},"conditionType":{"type":"string","description":"The type of condition to evaluate.","enum":["campaignProgress","campaignAgents"]}}},"CampaignRuleEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignRuleParameters":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for comparison. Required for a CampaignRuleCondition.","enum":["equals","greaterThan","greaterThanEqualTo","lessThan","lessThanEqualTo"]},"value":{"type":"string","description":"The value for comparison. Required for a CampaignRuleCondition."},"priority":{"type":"string","description":"The priority to set a campaign to. Required for the 'setCampaignPriority' action.","enum":["1","2","3","4","5"]},"dialingMode":{"type":"string","description":"The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action.","enum":["agentless","preview","power","predictive","progressive","external"]}}},"CampaignRuleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Alteration":{"type":"object","properties":{"type":{"type":"string","description":"Range type (Exclusion: used to exclude a specific time within the recurrence. Inclusion: used to include a specific time within the recurrence which will execute in addition to the normal recurrence. If both an exclusion and inclusion are specified, the inclusion will take precedence over the exclusion.)","enum":["Exclusion","Inclusion"]},"start":{"type":"string","example":"2023-12-21T16:30:25","description":"The start date of an alteration range as an ISO-8601 string"},"end":{"type":"string","example":"2023-12-21T16:30:25","description":"The end date of an alteration range as an ISO-8601 string"}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this CampaignSchedule. For example, Africa/Abidjan."},"campaign":{"description":"The Campaign that this CampaignSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NextOccurrenceDetails":{"type":"object","properties":{"startOccurrenceDetails":{"description":"The details for the next start occurrence for the recurrence.","$ref":"#/definitions/OccurrenceDetails"},"endOccurrenceDetails":{"description":"The details for the next end occurrence for the recurrence.","$ref":"#/definitions/OccurrenceDetails"}}},"OccurrenceDetails":{"type":"object","properties":{"dateOfNextOccurrence":{"type":"string","format":"date-time","example":"2023-12-21T16:30:25.00Z","description":"The date of the next start or end occurrence for the recurrence as an ISO-8601 string"},"numberOfOccurrences":{"type":"integer","format":"int32","description":"The number of start or end occurrences that have been processed for the recurrence."}}},"Pattern":{"type":"object","required":["interval","type"],"properties":{"type":{"type":"string","description":"Pattern type (Daily/Weekly)","enum":["Daily","Weekly"]},"interval":{"type":"integer","format":"int32","description":"The interval of days between the occurrences for Daily pattern type, and weeks between the occurrences for Weekly"},"daysOfWeek":{"type":"array","description":"The day(s) of week the occurrence should be repeated. Required to set for Weekly pattern type. E.g. [\"Monday\", \"Wednesday\"]","items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"Range":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Range type (NoEnd: without an end date. EndDate: with an end date. Numbered: with a specific number of occurrences)","enum":["NoEnd","EndDate","Numbered"]},"end":{"type":"string","example":"2023-12-21T16:30:25","description":"The end date time of the last occurrence of the range as an ISO-8601 string. Required for EndDate range type."},"numberOfOccurrences":{"type":"integer","format":"int32","description":"The number of times the schedule will be repeated, e.g: 2. Required to set for Numbered range type."}}},"Reoccurrence":{"type":"object","required":["end","pattern","range","start","timeZone"],"properties":{"id":{"type":"string"},"start":{"type":"string","example":"2023-11-21T16:30:25","description":"The start date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"},"end":{"type":"string","example":"2023-11-21T16:30:25","description":"The end date time of the initial occurrence as an ISO-8601 string in the format YYYY-MM-DDThh:mm:ss"},"timeZone":{"type":"string","description":"The time zone of the schedule e.g.: America/New_York"},"pattern":{"description":"The schedule pattern e.g.: Daily/Weekly","$ref":"#/definitions/Pattern"},"range":{"description":"The schedule range e.g.: EndDate/NoEnd/Numbered","$ref":"#/definitions/Range"},"alterations":{"type":"array","description":"Modifications to the original recurrence schedule (Exclusions/Inclusions)","items":{"$ref":"#/definitions/Alteration"}},"nextOccurrenceDetails":{"description":"The next occurrence details for the next start and end occurrences for the recurrence","readOnly":true,"$ref":"#/definitions/NextOccurrenceDetails"}}},"ScheduleInterval":{"type":"object","required":["end","start"],"properties":{"start":{"type":"string","description":"The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"CampaignLinesUtilization":{"type":"object","properties":{"assignedOutboundLines":{"type":"integer","format":"int32","description":"Number of outbound lines assigned to the campaign"},"totalAvailableOutboundLines":{"type":"integer","format":"int32","description":"Total number of available outbound lines in Campaign's Edge Group or Site"}}},"CampaignStats":{"type":"object","properties":{"contactRate":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"effectiveIdleAgents":{"type":"number","format":"double","description":"Number of effective available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true},"scheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently scheduled","readOnly":true},"timeZoneRescheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently timezone rescheduled","readOnly":true},"linesUtilization":{"description":"Information on the campaign's lines utilization","readOnly":true,"$ref":"#/definitions/CampaignLinesUtilization"}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"CampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommonCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["email","sms","voice"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommonCampaign":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["email","sms","voice"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListDivisionView":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses.","items":{"$ref":"#/definitions/EmailColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"Indicates the type of the phone column. For example, 'cell' or 'home'."},"callableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."}}},"EmailColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the email column."},"type":{"type":"string","description":"Indicates the type of the email column. For example, 'work' or 'personal'."},"contactableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking contactable times."}}},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true},"targetContactListIds":{"type":"array","description":"The contact list Ids for target contact lists.","readOnly":true,"items":{"type":"string"}},"listNamePrefix":{"type":"string","description":"The prefix for the contact list name","readOnly":true}}},"ContactListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactBulkSearchCriteria":{"type":"object","properties":{"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"]}}},"ContactListFilterClause":{"type":"object","properties":{"filterType":{"type":"string","description":"How to join predicates together.","enum":["AND","OR"]},"predicates":{"type":"array","description":"Conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterPredicate"}}}},"ContactListFilterPredicate":{"type":"object","properties":{"column":{"type":"string","description":"Contact list column from the ContactListFilter's contactList."},"columnType":{"type":"string","description":"The type of data in the contact column.","enum":["numeric","alphabetic"]},"operator":{"type":"string","description":"The operator for this ContactListFilterPredicate.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","BETWEEN","IN"]},"value":{"type":"string","description":"Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."},"range":{"description":"A range of values. Required for operators BETWEEN and IN.","$ref":"#/definitions/ContactListFilterRange"},"inverted":{"type":"boolean","description":"Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."}}},"ContactListFilterRange":{"type":"object","properties":{"min":{"type":"string","description":"The minimum value of the range. Required for the operator BETWEEN."},"max":{"type":"string","description":"The maximum value of the range. Required for the operator BETWEEN."},"minInclusive":{"type":"boolean","description":"Whether or not to include the minimum in the range."},"maxInclusive":{"type":"boolean","description":"Whether or not to include the maximum in the range."},"inSet":{"type":"array","description":"A set of values that the contact data should be in. Required for the IN operator.","uniqueItems":true,"items":{"type":"string"}}}},"ContactsExportRequest":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"contactIds":{"type":"array","description":"Contact IDs to be exported.","items":{"type":"string"}}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","readOnly":true}}},"ColumnStatus":{"type":"object","properties":{"contactable":{"type":"boolean","description":"Indicates whether or not an individual contact method column is contactable."}}},"ConfigurationOverrides":{"type":"object","properties":{"priority":{"type":"boolean","description":"Indicates whether or not the contact will be placed in front of the queue or at the end of the queue."}}},"ContactColumnTimeZone":{"type":"object","properties":{"timeZone":{"type":"string","description":"Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"columnType":{"type":"string","description":"Column Type will be either PHONE or ZIP","readOnly":true,"enum":["PHONE","ZIP"]}}},"ContactableStatus":{"type":"object","properties":{"contactable":{"type":"boolean","description":"Indicates whether or not the entire contact is contactable for the associated media type."},"columnStatus":{"type":"object","description":"A map of individual contact method columns to whether the individual column is contactable for the associated media type.","additionalProperties":{"$ref":"#/definitions/ColumnStatus"}}}},"DialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","example":"{ 'firstname': 'name', 'surname': 'name2', 'phone': '123456789'}","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"string"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"latestSmsEvaluations":{"type":"object","description":"A map of SMS records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"latestEmailEvaluations":{"type":"object","description":"A map of email records for the contact email columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactableStatus":{"type":"object","description":"A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type.","additionalProperties":{"$ref":"#/definitions/ContactableStatus"}},"contactColumnTimeZones":{"type":"object","description":"Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip","readOnly":true,"additionalProperties":{"$ref":"#/definitions/ContactColumnTimeZone"}},"configurationOverrides":{"description":"the priority property within ConfigurationOverides indicates whether or not the contact to be placed in front of the queue or at the end of the queue","readOnly":true,"$ref":"#/definitions/ConfigurationOverrides"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FilterPreviewResponse":{"type":"object","properties":{"filteredContacts":{"type":"integer","format":"int64"},"totalContacts":{"type":"integer","format":"int64"},"preview":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}}},"MessageEvaluation":{"type":"object","properties":{"contactColumn":{"type":"string","description":"The name of the contact column that was wrapped up"},"contactAddress":{"type":"string","description":"The address (phone or email) that was wrapped up"},"messageType":{"type":"string","description":"The type of message sent","enum":["Sms","Email"]},"wrapupCodeId":{"type":"string","description":"The id of the wrap-up code"},"timestamp":{"type":"string","format":"date-time","description":"The time that the wrap-up was applied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"Indicates whether or not a phone number is callable."}}},"ContactListFilter":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the list."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The contact list the filter is based on. Required if sourceType is ContactList","$ref":"#/definitions/DomainEntityRef"},"contactListTemplate":{"description":"The contact list template the filter is based on. Required if sourceType is ContactListTemplate","$ref":"#/definitions/DomainEntityRef"},"sourceType":{"type":"string","description":"The source type the filter is based on.","enum":["ContactList","ContactListTemplate"]},"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListFilterEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListFilterBulkRetrieveBody":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The IDs of the Contact List Filters to retrieve.","items":{"type":"string"}}}},"ColumnDataTypeSpecification":{"type":"object","properties":{"columnName":{"type":"string","description":"The column name of a column selected for dynamic queueing"},"columnDataType":{"type":"string","description":"The data type of the column selected for dynamic queueing (TEXT, NUMERIC or TIMESTAMP)","enum":["NUMERIC","TEXT","TIMESTAMP"]},"min":{"type":"integer","format":"int32","description":"The minimum length of the numeric column selected for dynamic queueing"},"max":{"type":"integer","format":"int32","description":"The maximum length of the numeric column selected for dynamic queueing"},"maxLength":{"type":"integer","format":"int32","description":"The maximum length of the text column selected for dynamic queueing"}}},"ContactList":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses","items":{"$ref":"#/definitions/EmailColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"attemptLimits":{"description":"AttemptLimits for this ContactList.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactList."},"zipCodeColumnName":{"type":"string","description":"The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"columnDataTypeSpecifications":{"type":"array","description":"The settings of the columns selected for dynamic queueing","items":{"$ref":"#/definitions/ColumnDataTypeSpecification"}},"trimWhitespace":{"type":"boolean","description":"Whether to trim white space when importing a contactlist csv file, default value = true"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneMappingPreview":{"type":"object","properties":{"contactList":{"description":"The associated ContactList","$ref":"#/definitions/DomainEntityRef"},"contactsPerTimeZone":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedUsingZipCode":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedToASingleZone":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone"},"contactsMappedToASingleZoneUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone and were mapped using the zip code column"},"contactsMappedToMultipleZones":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones"},"contactsMappedToMultipleZonesUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones and were mapped using the zip code column"},"contactsInDefaultWindow":{"type":"integer","format":"int64","description":"The total number of contacts that will be dialed during the default window"},"contactListSize":{"type":"integer","format":"int64","description":"The total number of contacts in the contact list"}}},"ContactListTemplate":{"type":"object","required":["columnNames"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"emailColumns":{"type":"array","description":"Indicates which columns are email addresses","items":{"$ref":"#/definitions/EmailColumn"}},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"attemptLimits":{"description":"AttemptLimits for this ContactListTemplate.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactListTemplate."},"zipCodeColumnName":{"type":"string","description":"The name of ContactListTemplate column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"columnDataTypeSpecifications":{"type":"array","description":"The settings of the columns selected for dynamic queueing","items":{"$ref":"#/definitions/ColumnDataTypeSpecification"}},"trimWhitespace":{"type":"boolean","description":"Whether to trim white space when importing a ContactListTemplate csv file, default value = true"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListTemplateBulkRetrieveBody":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"The IDs of the Contact List Templates to retrieve.","items":{"type":"string"}}}},"ContactListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactsBulkOperationJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique job identifier.","readOnly":true},"state":{"type":"string","description":"The job state.","readOnly":true,"enum":["InProgress","Complete","Failed"]},"type":{"type":"string","description":"The job type.","readOnly":true,"enum":["BulkDelete","BulkEdit"]},"totalRecords":{"type":"integer","format":"int64","description":"Total records that will be impacted by the bulk operation.","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"Amount of records that have been impacted by the bulk operation.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"Percentage of records that have been impacted by the bulk operation.","readOnly":true},"failureReason":{"description":"Information on failure reason.","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"downloadURI":{"type":"string","description":"URI to download the original backup contacts.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactBulkSearchParameters":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID. Either this property or criteria is required."},"criteria":{"description":"Criteria to filter the contacts by. Either this property or contactListFilterId is required.","$ref":"#/definitions/ContactBulkSearchCriteria"}}},"ContactBulkEditRequest":{"type":"object","properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"contactIds":{"type":"array","description":"Contact IDs to be bulk edited.","items":{"type":"string"}},"contact":{"description":"Contact object with details of fields used for patching.","$ref":"#/definitions/DialerContact"}}},"ContactListingResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"contactsCount":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListingRequest":{"type":"object","required":["pageNumber","pageSize"],"properties":{"contactListFilterId":{"type":"string","description":"Contact List Filter ID."},"criteria":{"description":"Criteria to filter the contacts by.","$ref":"#/definitions/ContactBulkSearchCriteria"},"pageNumber":{"type":"integer","format":"int32","description":"Page number."},"pageSize":{"type":"integer","format":"int32","description":"Page size. The max that will be returned is 100."},"contactSorts":{"type":"array","description":"The order in which to sort contacts.","items":{"$ref":"#/definitions/ContactSort"}}}},"WritableDialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","example":"{ 'firstname': 'name', 'surname': 'name2', 'phone': '123456789'}","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"string"}},"latestSmsEvaluations":{"type":"object","description":"A map of SMS records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"latestEmailEvaluations":{"type":"object","description":"A map of email records for the contact email columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MessageEvaluation"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactableStatus":{"type":"object","description":"A map of media types (Voice, SMS and Email) to ContactableStatus, which indicates if the contact can be contacted using the specified media type.","additionalProperties":{"$ref":"#/definitions/ContactableStatus"}},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp for when the contact was added. Contacts added prior to 2023 September 1 may be missing this value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"AuditEntity":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the entity the action of this AuditEntity targeted."},"id":{"type":"string","description":"The id of the entity the action of this AuditEntity targeted."},"name":{"type":"string","description":"The name of the entity the action of this AuditEntity targeted."},"selfUri":{"type":"string","description":"The selfUri for this entity."}}},"AuditMessage":{"type":"object","required":["id","level","receivedTimestamp","serviceName","status"],"properties":{"id":{"type":"string","description":"AuditMessage ID."},"user":{"$ref":"#/definitions/AuditUser"},"correlationId":{"type":"string","description":"Correlation ID."},"transactionId":{"type":"string","description":"Transaction ID."},"transactionInitiator":{"type":"boolean","description":"Whether or not this audit can be considered the initiator of the transaction it is a part of."},"application":{"type":"string","description":"The application through which the action of this AuditMessage was initiated."},"serviceName":{"type":"string","description":"The name of the service which sent this AuditMessage."},"level":{"type":"string","description":"The level of this audit. USER or SYSTEM."},"timestamp":{"type":"string","description":"The time at which the action of this AuditMessage was initiated."},"receivedTimestamp":{"type":"string","description":"The time at which this AuditMessage was received."},"status":{"type":"string","description":"The status of the action of this AuditMessage"},"actionContext":{"type":"string","description":"The context of a system-level action"},"action":{"type":"string","description":"A string representing the action that took place"},"changes":{"type":"array","description":"Details about any changes that occurred in this audit","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"},"serviceContext":{"description":"The service-specific context associated with this AuditMessage.","$ref":"#/definitions/ServiceContext"}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"Which page was returned."},"pageSize":{"type":"integer","format":"int32","description":"The number of results in a page."},"total":{"type":"integer","format":"int32","description":"The total number of results."},"pageCount":{"type":"integer","format":"int32","description":"The number of pages of results."},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"AuditUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the user who initiated the action of this AuditMessage."},"name":{"type":"string","description":"The full username of the user who initiated the action of this AuditMessage."},"display":{"type":"string","description":"The display name of the user who initiated the action of this AuditMessage."}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"The old values which were modified and/or removed by this action.","items":{"type":"string"}},"newValues":{"type":"array","description":"The new values which were modified and/or added by this action.","items":{"type":"string"}}}},"Entry":{"type":"object","properties":{"value":{"type":"string","description":"A value included in this facet."},"count":{"type":"integer","format":"int32","description":"The number of results with this value."}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that was faceted on."},"entries":{"type":"array","description":"The entries resulting from this facet.","items":{"$ref":"#/definitions/Entry"}}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string","description":"Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members."}}},"AuditFacet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"AuditFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"The word or words to search for."},"queryFields":{"type":"array","description":"The fields in which to search for the queryPhrase.","items":{"type":"string"}},"facets":{"type":"array","description":"The fields to facet on.","items":{"$ref":"#/definitions/AuditFacet"}},"filters":{"type":"array","description":"The fields to filter on.","items":{"$ref":"#/definitions/AuditFilter"}}}},"DncPatchCustomExclusionColumnsRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"customExclusionColumnEntries":{"type":"array","description":"The list of custom exclusion column entries to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC customExclusionColumnEntries in yyyy-MM-ddTHH:mmZ format"}}},"DncListDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncPatchEmailsRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"emailAddresses":{"type":"array","description":"The list of email addresses to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC email addresses in yyyy-MM-ddTHH:mmZ format"}}},"DncPatchPhoneNumbersRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform","enum":["Add","Remove"]},"phoneNumbers":{"type":"array","description":"The list of phone numbers to Add to / Remove from the DNC list ","items":{"type":"string"}},"expirationDateTime":{"type":"string","description":"Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format"}}},"DncList":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"campaignId":{"type":"string","description":"A dnc.com campaignId. Optional if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"customExclusionColumn":{"type":"string","description":"The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncListCreate":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","enum":["rds","rds_custom","dnc.com","gryphon"]},"contactMethod":{"type":"string","description":"The contact method. Required if dncSourceType is rds.","enum":["Email","Phone","Any"]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"campaignId":{"type":"string","description":"A dnc.com campaignId. Optional if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"customExclusionColumn":{"type":"string","description":"The column to evaluate exclusion against. Required if the dncSourceType is rds_custom."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventLog":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"errorEntity":{"$ref":"#/definitions/DomainEntityRef"},"relatedEntity":{"$ref":"#/definitions/DomainEntityRef"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"level":{"type":"string","enum":["INFO","WARNING","ERROR"]},"category":{"type":"string","enum":["CALLBACK","CALL_RESTRICTION","CALL_RULE","CAMPAIGN","CAMPAIGN_RULE","CONTACT","CONTACT_LIST_FILTER","DIGITAL_RULE","DNC_LIST","ENTITY_LIMIT","IMPORT_ERROR","MESSAGE_RESTRICTION","MESSAGING_CAMPAIGN","IMPORT_TEMPLATE","ORGANIZATION_CONFIGURATION","SCHEDULE","MESSAGING_CAMPAIGN_SCHEDULE","EMAIL_CAMPAIGN_SCHEDULE"]},"correlationId":{"type":"string"},"eventMessage":{"$ref":"#/definitions/EventMessage"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventMessage":{"type":"object","properties":{"code":{"type":"string","enum":["ACTIVE_CAMPAIGNS_LIMIT_EXCEEDED","ALL_CAMPAIGNS_BLACKLISTED","APPROACHING_CONTACT_LIMIT","APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT","APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT","APPROACHING_ENTITY_LIMIT","AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID","CAMPAIGN_BLACKLISTED","CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH","CAMPAIGN_EMAIL_BODY_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_EMAIL_SUBJECT_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_INVALIDATED","CAMPAIGN_FORCE_STOPPED","CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_START_ERROR","CAMPAIGN_RULE_START_ERROR","CAMPAIGN_SET_DIALING_MODE_ERROR","CAMPAIGN_STOPPED","CAMPAIGN_THROTTLED","CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED","INVALID_CALLABLE_TIME_ZONE","CALLBACK_CREATION_INVALID_NUMBER","CALL_RULE_INVALID_CONTACT_COLUMN","CALL_RULE_MISSING_DATA_ACTION_INPUT","CALL_RULE_MISMATCH_TYPE","CALL_RULE_INVALID_OPERATOR","CALL_RULE_NO_DNC_LISTS_CONFIGURED","CALL_RULE_UPDATED_PHONE_COLUMN","CONTACT_LIST_FILTER_EVALUATION_FAILED","CONTACT_LIST_FILTER_INTERNAL_ERROR","CONTACT_COLUMNS_LIMIT_EXCEEDED","CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED","CONTACT_ID_LENGTH_LIMIT_EXCEEDED","CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED","CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","DATA_ACTION_EXECUTION_FAILED","DATA_ACTION_AUTHENTICATION_FAILURE","DATA_ACTION_NOT_FOUND","DATA_ACTION_TOO_MANY_REQUESTS","DATA_ACTION_TOO_MANY_REQUESTS_REMOTE","ACTION_EXECUTION_FAILED","ACTION_EXECUTION_FAILED_INVALID_PARAMETER","DIGITAL_RULE_EVALUATION_FAILED","DIGITAL_RULE_INTERNAL_ERROR","DIGITAL_RULE_NO_DNC_LISTS_CONFIGURED","DIGITAL_RULE_UPDATED_CONTACT_ADDRESS","DIGITAL_RULE_SMS_PHONE_NUMBER_TYPE_MISMATCH","DIGITAL_RULE_ERROR_SKIPPED","DNC_AUTHENTICATION_FAILURE","EXCEEDED_CONTACT_LIMIT","EXCEEDED_DNC_RECORD_LIMIT","EXCEEDED_DNC_PHONE_NUMBER_LENGTH","INACTIVE_EDGES_FAILED_PLACE_CALLS","INACTIVE_EDGES_TURNED_CAMPAIGN_OFF","INVALID_AGENT","INVALID_EMAIL_ADDRESS","INVALID_PHONE_NUMBER","IMPORT_FAILED_TO_READ_HEADERS","IMPORT_COULD_NOT_PARSE_AN_ENTRY","IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT","IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS","IMPORT_INVALID_CUSTOM_ID","IMPORT_INVALID_DATA","IMPORT_INVALID_EMAIL_ADDRESSES","IMPORT_INVALID_PHONE_NUMBERS","IMPORT_INVALID_EXPIRATION_DATE","IMPORT_EXPIRATION_DATE_EXCEEDS_MAX_DAYS","IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT","IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT","IMPORT_MISSING_CUSTOM_ID","IMPORT_NO_COLUMNS_DEFINED","IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST","IMPORT_LIST_NO_LONGER_EXISTS","IMPORT_NO_LISTS_CREATED_NO_CONTACTS_MATCH_FILTER","IMPORT_TARGET_CONTACT_LIST_NAME_EXISTS","IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","IMPORT_FAILED_CONTACT_DATA_GREATER_THAN_MAX_LENGTH","IMPORT_FAILED_CONTACT_DATA_NOT_WITHIN_MIN_MAX_RANGE","IMPORT_FAILED_CONTACT_DATA_INVALID_DATATYPE","IMPORT_TOO_MANY_COLUMNS","IMPORT_TOO_MANY_EXTRA_COLUMNS","IMPORT_CONTACT_LIST_NAME_LENGTH_EXCEEDED","ORGANIZATION_HAS_NO_DOMAIN_SET","RECYCLE_CAMPAIGN","SCHEDULED_CAMPAIGN_INVALID","SCHEDULE_UNKNOWN_ERROR"]},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"object"}},"documentationUri":{"type":"string"},"resourceURIs":{"type":"array","items":{"type":"string"}}}},"DialerEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventLog"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Column":{"type":"object","properties":{"columnName":{"type":"string","description":"Column name. Mandatory for Fixed position/length file format."},"columnNumber":{"type":"integer","format":"int32","description":"0 based column number in delimited file format"},"startPosition":{"type":"integer","format":"int32","description":"Zero-based position of the first column's character. Mandatory for Fixed position/length file format."},"length":{"type":"integer","format":"int32","description":"Column width. Mandatory for Fixed position/length file format."}}},"FileSpecificationTemplate":{"type":"object","required":["format","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the File Specification template."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"description":{"type":"string","description":"Description of the file specification template"},"format":{"type":"string","description":"File format","enum":["FixedLength","Delimited"]},"numberOfHeadingLinesSkipped":{"type":"integer","format":"int32","description":"Number of heading lines to be skipped"},"numberOfTrailingLinesSkipped":{"type":"integer","format":"int32","description":"Number of trailing lines to be skipped"},"header":{"type":"boolean","description":"If true indicates that delimited file has a header row, which can provide column names"},"delimiter":{"type":"string","description":"Kind of delimiter","enum":["Comma","Pipe","Colon","Tab","Semicolon","Custom"]},"delimiterValue":{"type":"string","description":"Delimiter character, used only when delimiter=\"Custom\""},"columnInformation":{"type":"array","description":"Columns specification","items":{"$ref":"#/definitions/Column"}},"preprocessingRules":{"type":"array","description":"Preprocessing rules","items":{"$ref":"#/definitions/PreprocessingRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PreprocessingRule":{"type":"object","properties":{"find":{"type":"string","description":"The regular expression to which file lines are to be matched."},"replaceWith":{"type":"string","description":"The string to be substituted for each match."},"global":{"type":"boolean","description":"Replaces all matching substrings in every line."},"ignoreCase":{"type":"boolean","description":"Enables case-insensitive matching"}}},"FileSpecificationTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FileSpecificationTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ImportTemplate":{"type":"object","required":["contactListTemplate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the import template."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactListTemplate":{"description":"ContactListTemplate for this ImportTemplate.","$ref":"#/definitions/DomainEntityRef"},"contactListFilter":{"description":"ContactListFilter for this ImportTemplate.","$ref":"#/definitions/DomainEntityRef"},"useSplittingCriteria":{"type":"boolean","description":"Whether or not to use splitting criteria. Default is false."},"splittingInformation":{"description":"How to split contact records, required if useSplittingCriteria is true.","$ref":"#/definitions/SplittingInformation"},"listNameFormat":{"type":"string","description":"The list name format for target ContactLists. When Custom is provided, customListNameFormatValue is required.","enum":["ListNamePrefix","ListNamePrefixMonthDayYear","ListNamePrefixMonthDayYearHourMinuteSecond","ListNamePrefixPart","ListNamePrefixMonthDayYearPart","ListNamePrefixMonthDayYearHourMinuteSecondPart","Custom"]},"customListNameFormatValue":{"type":"string","description":"Custom value for the list name format, at least %N is required. Any character other than the specified tokens will be used as is. Available tokens: %N: ListNamePrefix; %P: Part number; %F: Filter name; %C: Column value; YYYY: year; MM: month; DD: day; hh: hour; mm: minute; ss: second."},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SplittingInformation":{"type":"object","properties":{"criteria":{"type":"string","description":"The splitting criteria type","enum":["Percentage","Quantity","Column","Custom"]},"criteriaValue":{"type":"string","description":"The criteria value for the specified criteria type"},"createRemainderContactList":{"type":"boolean","description":"Whether to create remainder contact list"},"useWaterfallRule":{"type":"boolean","description":"Whether to use waterfall rule"}}},"ImportTemplateEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ImportTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AtzmTimeSlot":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"}}},"AtzmTimeSlotWithTimeZone":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"},"timeZoneId":{"type":"string","example":"America/New York","description":"The time zone to use for contacts that cannot be mapped."}}},"AutomaticTimeZoneMappingSettings":{"type":"object","properties":{"callableWindows":{"type":"array","description":"The time intervals to use for automatic time zone mapping.","items":{"$ref":"#/definitions/CallableWindow"}},"supportedCountries":{"type":"array","description":"The countries that are supported for automatic time zone mapping.","items":{"type":"string"}}}},"CallableWindow":{"type":"object","properties":{"mapped":{"description":"The time interval to place outbound calls, for contacts that can be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlot"},"unmapped":{"description":"The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlotWithTimeZone"}}},"OutboundSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on any campaign"},"maxConfigurableCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be configured to be placed per agent on any campaign","readOnly":true},"maxLineUtilization":{"type":"number","format":"double","description":"The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]"},"abandonSeconds":{"type":"number","format":"double","description":"The number of seconds used to determine if a call is abandoned"},"complianceAbandonRateDenominator":{"type":"string","description":"The denominator to be used in determining the compliance abandon rate","enum":["ALL_CALLS","CALLS_THAT_REACHED_QUEUE"]},"automaticTimeZoneMapping":{"description":"The settings for automatic time zone mapping. Note that changing these settings will change them for both voice and messaging campaigns.","$ref":"#/definitions/AutomaticTimeZoneMappingSettings"},"rescheduleTimeZoneSkippedContacts":{"type":"boolean","description":"Whether or not to reschedule time-zone blocked contacts"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Condition":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition.","enum":["wrapupCondition","systemDispositionCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition","contactPropertyCondition","dataActionCondition"]},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Condition. Default is false."},"attributeName":{"type":"string","description":"An attribute name associated with this Condition. Required for a contactAttributeCondition."},"value":{"type":"string","description":"A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."},"valueType":{"type":"string","description":"The type of the value associated with this Condition. Not used for a DataActionCondition.","enum":["STRING","NUMERIC","DATETIME","PERIOD"]},"operator":{"type":"string","description":"An operation with which to evaluate the Condition. Not used for a DataActionCondition.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","IN"]},"codes":{"type":"array","description":"List of wrap-up code identifiers. Required for a wrapupCondition.","items":{"type":"string"}},"property":{"type":"string","description":"A value associated with the property type of this Condition. Required for a contactPropertyCondition."},"propertyType":{"type":"string","description":"The type of the property associated with this Condition. Required for a contactPropertyCondition.","enum":["LAST_ATTEMPT_BY_COLUMN","LAST_ATTEMPT_OVERALL","LAST_WRAPUP_BY_COLUMN","LAST_WRAPUP_OVERALL"]},"dataAction":{"description":"The Data Action to use for this condition. Required for a dataActionCondition.","$ref":"#/definitions/DomainEntityRef"},"dataNotFoundResolution":{"type":"boolean","description":"The result of this condition if the data action returns a result indicating there was no data. Required for a DataActionCondition."},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionCondition."},"callAnalysisResultField":{"type":"string","description":"The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionCondition."},"agentWrapupField":{"type":"string","description":"The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionCondition."},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionCondition.","items":{"$ref":"#/definitions/ContactColumnToDataActionFieldMapping"}},"predicates":{"type":"array","description":"A list of predicates defining the comparisons to use for this condition. Required for a dataActionCondition.","items":{"$ref":"#/definitions/DataActionConditionPredicate"}}}},"ContactColumnToDataActionFieldMapping":{"type":"object","required":["contactColumnName","dataActionField"],"properties":{"contactColumnName":{"type":"string","description":"The name of a contact column whose data will be passed to the data action"},"dataActionField":{"type":"string","description":"The name of an input field from the data action that the contact column data will be passed to"}}},"DataActionConditionPredicate":{"type":"object","required":["comparisonValue","inverted","outputField","outputFieldMissingResolution","outputOperator"],"properties":{"outputField":{"type":"string","description":"The name of an output field from the data action's output to use for this condition"},"outputOperator":{"type":"string","description":"The operation with which to evaluate this condition","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER"]},"comparisonValue":{"type":"string","description":"The value to compare against for this condition"},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Predicate. Default is false."},"outputFieldMissingResolution":{"type":"boolean","description":"The result of this predicate if the requested output field is missing from the data action's result"}}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"The type of this DialerAction.","enum":["Action","modifyContactAttribute","dataActionBehavior"]},"actionTypeName":{"type":"string","description":"Additional type specification for this DialerAction.","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","APPEND_CUSTOM_ENTRY_TO_DNC_LIST","SCHEDULE_CALLBACK","CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","SET_CALLER_ID","SET_SKILLS","DATA_ACTION"]},"updateOption":{"type":"string","description":"Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"]},"properties":{"type":"object","description":"A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).","additionalProperties":{"type":"string"}},"dataAction":{"description":"The Data Action to use for this action. Required for a dataActionBehavior.","$ref":"#/definitions/DomainEntityRef"},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields for this condition. Valid for a dataActionBehavior.","items":{"$ref":"#/definitions/ContactColumnToDataActionFieldMapping"}},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed to for this condition. Valid for a dataActionBehavior."},"callAnalysisResultField":{"type":"string","description":"The input field from the data action that the callAnalysisResult will be passed to for this condition. Valid for a wrapup dataActionBehavior."},"agentWrapupField":{"type":"string","description":"The input field from the data action that the agentWrapup will be passed to for this condition. Valid for a wrapup dataActionBehavior."}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["DIALER_PRECALL","DIALER_WRAPUP"]},"conditions":{"type":"array","description":"A list of Conditions. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of actions to be taken if the conditions are true.","items":{"$ref":"#/definitions/DialerAction"}}}},"RuleSet":{"type":"object","required":["name","rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the RuleSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DialerRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignSequence":{"type":"object","required":["campaigns","currentCampaign","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"The ordered list of Campaigns that this CampaignSequence will run.","items":{"$ref":"#/definitions/DomainEntityRef"}},"currentCampaign":{"type":"integer","format":"int32","description":"A zero-based index indicating which Campaign this CampaignSequence is currently on.","readOnly":true},"status":{"type":"string","description":"The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.","enum":["on","off","complete"]},"stopMessage":{"type":"string","description":"A message indicating if and why a CampaignSequence has stopped unexpectedly.","readOnly":true},"repeat":{"type":"boolean","description":"Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated CampaignSequence.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this SequenceSchedule. For example, Africa/Abidjan."},"sequence":{"description":"The CampaignSequence that this SequenceSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}},"mapping":{"type":"object","description":"A map from wrap-up code identifiers to a set of wrap-up flags.","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AppendToDncActionSettings":{"type":"object","required":["expire"],"properties":{"expire":{"type":"boolean","description":"Whether to expire the record appended to the DNC list."},"expirationDuration":{"type":"string","example":"P19DT15H13M","description":"If 'expire' is set to true, how long to keep the record."},"listType":{"type":"string","description":"The Dnc List Type to append entries to","enum":["Rds","RdsCustom"]}}},"ContactAddressConditionSettings":{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","description":"The operator to use when comparing address values.","enum":["Equals","Contains","BeginsWith","EndsWith"]},"value":{"type":"string","example":"+1555, outlook.com","description":"The value to compare against the contact's address."}}},"ContactAddressTypeConditionSettings":{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","description":"The operator to use when comparing the address types.","enum":["Equals","Contains","BeginsWith","EndsWith"]},"value":{"type":"string","description":"The type value to compare against the contact column type."}}},"ContactColumnConditionSettings":{"type":"object","required":["columnName","operator","value","valueType"],"properties":{"columnName":{"type":"string","description":"The name of the contact list column to evaluate."},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Equals","LessThan","LessThanEquals","GreaterThan","GreaterThanEquals","Contains","BeginsWith","EndsWith","Before","After"]},"value":{"type":"string","example":"For Numeric: '1234', '1234.56', '$1,234.56'. For DateTime: '2022-01-01T12:01:23.456-0000'. For Period: 'P1DT1H1M'. ","description":"The value to compare against the contact's data."},"valueType":{"type":"string","description":"The data type the value should be treated as.","enum":["DateTime","Numeric","Period","String"]}}},"DataActionConditionSettings":{"type":"object","required":["dataActionId","dataNotFoundResolution"],"properties":{"dataActionId":{"type":"string","description":"The Data Action Id to use for this condition."},"contactIdField":{"type":"string","description":"The input field from the data action that the contactId will be passed into."},"dataNotFoundResolution":{"type":"boolean","description":"The result of this condition if the data action returns a result indicating there was no data."},"predicates":{"type":"array","description":"A list of predicates defining the comparisons to use for this condition.","items":{"$ref":"#/definitions/DigitalDataActionConditionPredicate"}},"contactColumnToDataActionFieldMappings":{"type":"array","description":"A list of mappings defining which contact data fields will be passed to which data action input fields.","items":{"$ref":"#/definitions/DataActionContactColumnFieldMapping"}}}},"DataActionContactColumnFieldMapping":{"type":"object","required":["contactColumnName","dataActionField"],"properties":{"contactColumnName":{"type":"string","description":"The name of a contact column whose data will be passed to the data action"},"dataActionField":{"type":"string","description":"The name of an input field from the data action that the contact column data will be passed to"}}},"DigitalAction":{"type":"object","properties":{"updateContactColumnActionSettings":{"description":"The settings for an 'update contact column' action.","$ref":"#/definitions/UpdateContactColumnActionSettings"},"doNotSendActionSettings":{"description":"The settings for a 'do not send' action.","$ref":"#/definitions/DoNotSendActionSettings"},"appendToDncActionSettings":{"description":"The settings for an 'Append to DNC' action.","$ref":"#/definitions/AppendToDncActionSettings"},"markContactUncontactableActionSettings":{"description":"The settings for a 'mark contact uncontactable' action.","$ref":"#/definitions/MarkContactUncontactableActionSettings"},"markContactAddressUncontactableActionSettings":{"description":"The settings for an 'mark contact address uncontactable' action.","$ref":"#/definitions/MarkContactAddressUncontactableActionSettings"},"setContentTemplateActionSettings":{"description":"The settings for a 'Set content template' action.","$ref":"#/definitions/SetContentTemplateActionSettings"},"setSmsPhoneNumberActionSettings":{"description":"The settings for a 'set sms phone number' action.","$ref":"#/definitions/SetSmsPhoneNumberActionSettings"}}},"DigitalCondition":{"type":"object","properties":{"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this condition. Default is false."},"contactColumnConditionSettings":{"description":"The settings for a 'contact list column' condition.","$ref":"#/definitions/ContactColumnConditionSettings"},"contactAddressConditionSettings":{"description":"The settings for a 'contact address' condition.","$ref":"#/definitions/ContactAddressConditionSettings"},"contactAddressTypeConditionSettings":{"description":"The settings for a 'contact address type' condition.","$ref":"#/definitions/ContactAddressTypeConditionSettings"},"lastAttemptByColumnConditionSettings":{"description":"The settings for a 'last attempt by column' condition.","$ref":"#/definitions/LastAttemptByColumnConditionSettings"},"lastAttemptOverallConditionSettings":{"description":"The settings for a 'last attempt overall' condition.","$ref":"#/definitions/LastAttemptOverallConditionSettings"},"lastResultByColumnConditionSettings":{"description":"The settings for a 'last result by column' condition.","$ref":"#/definitions/LastResultByColumnConditionSettings"},"lastResultOverallConditionSettings":{"description":"The settings for a 'last result overall' condition.","$ref":"#/definitions/LastResultOverallConditionSettings"},"dataActionConditionSettings":{"description":"The settings for a 'data action' condition.","$ref":"#/definitions/DataActionConditionSettings"}}},"DigitalDataActionConditionPredicate":{"type":"object","required":["comparisonValue","inverted","outputField","outputFieldMissingResolution","outputOperator"],"properties":{"outputField":{"type":"string","description":"The name of an output field from the data action's output to use for this condition"},"outputOperator":{"type":"string","description":"The operation with which to evaluate this condition","enum":["Equals","LessThan","LessThanEquals","GreaterThan","GreaterThanEquals","Contains","BeginsWith","EndsWith","Before","After"]},"comparisonValue":{"type":"string","description":"The value to compare against for this condition"},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Predicate. Default is false."},"outputFieldMissingResolution":{"type":"boolean","description":"The result of this predicate if the requested output field is missing from the data action's result"}}},"DigitalRule":{"type":"object","required":["actions","category","conditions","name","order"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["PreContact","PostContact"]},"conditions":{"type":"array","description":"A list of conditions to evaluate. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/DigitalCondition"}},"actions":{"type":"array","description":"The list of actions to be taken if all conditions are true.","items":{"$ref":"#/definitions/DigitalAction"}}}},"DigitalRuleSet":{"type":"object","required":["rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DigitalRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DoNotSendActionSettings":{"type":"object"},"LastAttemptByColumnConditionSettings":{"type":"object","required":["operator","value"],"properties":{"emailColumnName":{"type":"string","description":"The name of the contact column to evaluate for Email."},"smsColumnName":{"type":"string","description":"The name of the contact column to evaluate for SMS."},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Before","After"]},"value":{"type":"string","example":"P1DT1H1M","description":"The period value to compare against the contact's data."}}},"LastAttemptOverallConditionSettings":{"type":"object","required":["mediaTypes","operator","value"],"properties":{"mediaTypes":{"type":"array","description":"A list of media types to evaluate.","items":{"type":"string","enum":["Voice","Email","Sms"]}},"operator":{"type":"string","description":"The operator to use when comparing values.","enum":["Before","After"]},"value":{"type":"string","example":"P1DT1H1M","description":"The period value to compare against the contact's data."}}},"LastResultByColumnConditionSettings":{"type":"object","properties":{"emailColumnName":{"type":"string","description":"The name of the contact column to evaluate for Email."},"emailWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for Email.","items":{"type":"string"}},"smsColumnName":{"type":"string","description":"The name of the contact column to evaluate for SMS."},"smsWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for SMS.","items":{"type":"string"}}}},"LastResultOverallConditionSettings":{"type":"object","properties":{"emailWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for Email.","items":{"type":"string"}},"smsWrapupCodes":{"type":"array","description":"A list of wrapup code identifiers to match for SMS.","items":{"type":"string"}}}},"MarkContactAddressUncontactableActionSettings":{"type":"object"},"MarkContactUncontactableActionSettings":{"type":"object","required":["mediaTypes"],"properties":{"mediaTypes":{"type":"array","description":"A list of media types to evaluate.","items":{"type":"string","enum":["Voice","Email","Sms"]}}}},"SetContentTemplateActionSettings":{"type":"object","required":["emailContentTemplateId","smsContentTemplateId"],"properties":{"smsContentTemplateId":{"type":"string","description":"A string of sms contentTemplateId."},"emailContentTemplateId":{"type":"string","description":"A string of email contentTemplateId."}}},"SetSmsPhoneNumberActionSettings":{"type":"object","required":["senderSmsPhoneNumber"],"properties":{"senderSmsPhoneNumber":{"type":"string","description":"The string address for the sms phone number."}}},"UpdateContactColumnActionSettings":{"type":"object","required":["properties","updateOption"],"properties":{"properties":{"type":"object","example":"{\"phoneNumber\":\"+11234567890\"}, {\"lastContactedTime\":\"\"","description":"A mapping of contact columns to their new values.","additionalProperties":{"type":"string"}},"updateOption":{"type":"string","description":"The type of update to make to the specified contact column(s).","enum":["Set","Increment","Decrement","CurrentTime"]}}},"DigitalRuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DigitalRuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailConfig":{"type":"object","required":["emailColumns","fromAddress"],"properties":{"emailColumns":{"type":"array","description":"The contact list columns specifying the email address(es) of the contact.","items":{"type":"string"}},"contentTemplate":{"description":"The content template used to formulate the email to send to the contact.","$ref":"#/definitions/DomainEntityRef"},"fromAddress":{"description":"The email address that will be used as the sender of the email.","$ref":"#/definitions/FromEmailAddress"},"replyToAddress":{"description":"The email address from which any reply will be sent.","$ref":"#/definitions/ReplyToEmailAddress"}}},"FromEmailAddress":{"type":"object","required":["domain"],"properties":{"domain":{"description":"The OutboundDomain used for the email address.","$ref":"#/definitions/DomainEntityRef"},"friendlyName":{"type":"string","description":"The friendly name of the email address."},"localPart":{"type":"string","description":"The local part of the email address."}}},"MessagingCampaign":{"type":"object","required":["contactList","messagesPerMinute"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.","enum":["on","stopping","off","complete","invalid","forced_off"]},"callableTimeSet":{"description":"The callable time set for this messaging campaign.","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"The contact list that this messaging campaign will send messages for.","$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"The dnc lists to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"alwaysRunning":{"type":"boolean","description":"Whether this messaging campaign is always running"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"messagesPerMinute":{"type":"integer","format":"int32","description":"How many messages this messaging campaign will send per minute."},"ruleSets":{"type":"array","description":"Rule Sets to be applied while this campaign is sending messages","items":{"$ref":"#/definitions/DomainEntityRef"}},"contactListFilters":{"type":"array","description":"The contact list filter to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"errors":{"type":"array","description":"A list of current error conditions associated with this messaging campaign.","items":{"$ref":"#/definitions/RestErrorDetail"}},"dynamicContactQueueingSettings":{"description":"Indicates (when true) that the campaign supports dynamic queueing of the contact list at the time of a request for contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"emailConfig":{"description":"Configuration for this messaging campaign to send Email messages.","$ref":"#/definitions/EmailConfig"},"smsConfig":{"description":"Configuration for this messaging campaign to send SMS messages.","$ref":"#/definitions/SmsConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplyToEmailAddress":{"type":"object","required":["domain","route"],"properties":{"domain":{"description":"The InboundDomain used for the email address.","$ref":"#/definitions/DomainEntityRef"},"route":{"description":"The InboundRoute used for the email address.","$ref":"#/definitions/DomainEntityRef"}}},"SmsConfig":{"type":"object","required":["messageColumn","phoneColumn","senderSmsPhoneNumber"],"properties":{"messageColumn":{"type":"string","description":"The Contact List column specifying the message to send to the contact."},"phoneColumn":{"type":"string","description":"The Contact List column specifying the phone number to send a message to."},"senderSmsPhoneNumber":{"description":"A reference to the SMS Phone Number that will be used as the sender of a message.","$ref":"#/definitions/SmsPhoneNumberRef"},"contentTemplate":{"description":"The content template used to formulate the message to send to the contact.","$ref":"#/definitions/DomainEntityRef"}}},"SmsPhoneNumberRef":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"selfUri":{"type":"string","format":"uri"}}},"MessagingCampaignDiagnostics":{"type":"object","properties":{"timeZoneRescheduledContactsCount":{"type":"integer","format":"int32","description":"Current number of time zone rescheduled messages on the campaign","readOnly":true}}},"MessagingCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailCampaignSchedule":{"type":"object","required":["emailCampaign","intervals"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this email campaign schedule."},"emailCampaign":{"description":"The Campaign that this email campaign schedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailCampaignScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailCampaignSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingCampaignSchedule":{"type":"object","required":["intervals","messagingCampaign"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this messaging campaign schedule."},"messagingCampaign":{"description":"The Campaign that this messaging campaign schedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"UserDevice":{"type":"object","required":["acceptNotifications","deviceToken","make","model","notificationId","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"deviceToken":{"type":"string","description":"device token sent by mobile clients."},"notificationId":{"type":"string","description":"notification id of the device."},"make":{"type":"string","description":"make of the device."},"model":{"type":"string","description":"Device model"},"acceptNotifications":{"type":"boolean","description":"if the device accepts notifications"},"type":{"type":"string","description":"type of the device; ios or android","enum":["android","ios"]},"sessionHash":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DirectoryUserDevicesListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserDevice"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FieldConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entityType":{"type":"string","enum":["person","group","org"]},"state":{"type":"string"},"sections":{"type":"array","items":{"$ref":"#/definitions/Section"}},"version":{"type":"string"},"schemaVersion":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupMembersUpdate":{"type":"object","required":["memberIds","version"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add.","items":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The current group version."}}},"GroupProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GroupProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupUpdate":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"state":{"type":"string","description":"State of the group.","enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","ownerIds","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupCreate":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Group"}}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["description","id","name","state"]}}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"LanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationUpdateDefinition":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"LocationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationCreateDefinition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"LocationsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/LocationDefinition"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["id","name","notes","addressFields.city","addressFields.country","addressFields.state","addressFields.street1","addressFields.street2","addressFields.zipcode","addressVerified","emergencyNumber"]}}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"OrganizationFeatures":{"type":"object","properties":{"realtimeCIC":{"type":"boolean"},"purecloud":{"type":"boolean"},"hipaa":{"type":"boolean"},"ucEnabled":{"type":"boolean"},"pci":{"type":"boolean"},"purecloudVoice":{"type":"boolean"},"xmppFederation":{"type":"boolean"},"chat":{"type":"boolean"},"informalPhotos":{"type":"boolean"},"directory":{"type":"boolean"},"contactCenter":{"type":"boolean"},"unifiedCommunications":{"type":"boolean"},"custserv":{"type":"boolean"}}},"FeatureState":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Adjacents":{"type":"object","properties":{"superiors":{"type":"array","items":{"$ref":"#/definitions/User"}},"siblings":{"type":"array","items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"AvailableTranslations":{"type":"object","properties":{"orgSpecific":{"type":"array","items":{"type":"string"}},"builtin":{"type":"array","items":{"type":"string"}}}},"UserExpands":{"type":"object","properties":{"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Active 3rd party presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"}}},"UserProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"expands":{"description":"User information expansions","readOnly":true,"$ref":"#/definitions/UserExpands"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExternalMetricDataProcessedItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]},"totalValue":{"type":"number","description":"The total value of the metric data."},"totalCount":{"type":"integer","format":"int32","description":"The total number of data points."}}},"ExternalMetricDataUnprocessedItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]},"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"}}},"ExternalMetricDataWriteResponse":{"type":"object","properties":{"processedEntities":{"type":"array","description":"The list of processed entities","items":{"$ref":"#/definitions/ExternalMetricDataProcessedItem"}},"unprocessedEntities":{"type":"array","description":"The list of unprocessed entities","items":{"$ref":"#/definitions/ExternalMetricDataUnprocessedItem"}}},"description":"External metric data write response"},"ExternalMetricDataItem":{"type":"object","required":["dateOccurred","metricId","value"],"properties":{"userId":{"type":"string","description":"The user ID. Must provide either userId or userEmail, but not both."},"userEmail":{"type":"string","description":"The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."},"metricId":{"type":"string","description":"The ID of the external metric definition"},"dateOccurred":{"type":"string","format":"date","description":"The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"value":{"type":"number","description":"The value of the metric data. When value is null, the metric data will be deleted."},"count":{"type":"integer","format":"int32","description":"The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."},"type":{"type":"string","description":"The type of the metric data. The default value is Total.","enum":["Total","Cumulative"]}}},"ExternalMetricDataWriteRequest":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"A list of external metric data items. A maximum of 100 items are allowed.","items":{"$ref":"#/definitions/ExternalMetricDataItem"}}}},"ExternalMetricDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the External Metric Definition"},"unit":{"type":"string","description":"The unit of the External Metric Definition","enum":["Seconds","Percent","Number","Currency"]},"unitDefinition":{"type":"string","description":"The unit definition of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition"},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"retentionMonths":{"type":"integer","format":"int32","description":"The retention in months of the External Metric Definition"},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"},"inUse":{"type":"boolean","description":"True if the External Metric Definition is in use","readOnly":true},"dateLastRefreshed":{"type":"string","format":"date-time","description":"The last date and time that the metric data was refreshed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalMetricDefinitionCreateRequest":{"type":"object","required":["defaultObjectiveType","enabled","name","precision","unit"],"properties":{"name":{"type":"string","description":"The name of the External Metric Definition"},"unit":{"type":"string","description":"The unit of the External Metric Definition","enum":["Seconds","Percent","Number","Currency"]},"unitDefinition":{"type":"string","description":"The unit definition of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition. Must be at least 0 and at most 5","minimum":0,"maximum":5},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"}}},"ExternalMetricDefinitionUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the External Metric Definition"},"precision":{"type":"integer","format":"int32","description":"The decimal precision of the External Metric Definition. Must be at least 0 and at most 5","minimum":0,"maximum":5},"defaultObjectiveType":{"type":"string","description":"The default objective type of the External Metric Definition","enum":["HigherIsBetter","LowerIsBetter","TargetArea"]},"enabled":{"type":"boolean","description":"True if the External Metric Definition is enabled"}}},"ExternalMetricDefinitionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalMetricDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExecutionDataEntity":{"type":"object","properties":{"id":{"type":"string","description":"The id of the execution requested"},"downloadUri":{"type":"string","description":"A downloadable link to the execution data file."},"failed":{"type":"boolean","description":"If the retrieval failed (not found, no permission, etc;), this will be set true."},"statusCode":{"type":"string","description":"This will contain the http status code for the failure"}},"description":"Represents an individual result of an execution data lookup"},"ExecutionDataRequest":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"A list of ids to retrieve","items":{"type":"string"}}},"description":"Used to retrieve a set of executionData history by the respective ids"},"CriteriaCategoryInfo":{"type":"object","properties":{"categoryId":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"}}},"QueryCriteria":{"type":"object","properties":{"criteriaKey":{"type":"string","description":"The is the name of the criteria that can be queried.","enum":["FlowStartDateTime","FlowEndDateTime","ConversationId","FlowType","FlowId","FlowErrorReason","FlowWarningReason","FlowAlternateExecutionId","FlowObjectExecutionId","FlowActionId","FlowActionType","FlowActionOutputPathId","FlowActionOutputPathName","FlowActionIdOutputPathId","FlowActionIdOutputPathName","FlowActionTypeOutputPathId","FlowActionTypeOutputPathName","BotId","BotErrorReason","BotFlowExecutionId","BotObjectExecutionId"]},"criteriaGroups":{"type":"array","description":"The executionData type that this criteria item can be used on.","items":{"type":"string","enum":["flow","bot"]}},"description":{"type":"string","description":"The is the description of the criteria."},"operators":{"type":"array","description":"A list of operators that can be used on this criteria.","items":{"type":"string"}},"dataType":{"type":"string","description":"The type of data for the criteria (string, int, etc).","enum":["string","guid","dateTime"]},"categoryInfo":{"description":"A logical grouping and display order for this item.","$ref":"#/definitions/CriteriaCategoryInfo"}},"description":"A criteria type that can be used in tandem with other criteria type to create queries of executionData"},"CriteriaGroup":{"type":"object","properties":{"and":{"type":"array","description":"These criteriaItems will be AND'd together to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"or":{"type":"array","description":"These criteriaItems will be OR'd together to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"not":{"type":"array","description":"These criteriaItems must all be false to find a match.","items":{"$ref":"#/definitions/CriteriaItem"}},"criteria":{"description":"A singular critieriaItem to match.","$ref":"#/definitions/CriteriaItem"}},"description":"A group of logical or a singular criteria used to create a query of executionData"},"CriteriaItem":{"type":"object","properties":{"key":{"type":"string","description":"The id of the criteria to be checked.","enum":["FlowStartDateTime","FlowEndDateTime","ConversationId","FlowType","FlowId","FlowErrorReason","FlowWarningReason","FlowAlternateExecutionId","FlowObjectExecutionId","FlowActionId","FlowActionType","FlowActionOutputPathId","FlowActionOutputPathName","FlowActionIdOutputPathId","FlowActionIdOutputPathName","FlowActionTypeOutputPathId","FlowActionTypeOutputPathName","BotId","BotErrorReason","BotFlowExecutionId","BotObjectExecutionId"]},"operator":{"type":"string","description":"The operator used to check on the criteria id.","enum":["eq","gt","gte","lt","lte","not","begins","not_null"]},"value":{"type":"string","description":"The target value used to query on."}},"description":"A singular criteria used to query executionData."},"CriteriaQuery":{"type":"object","required":["query"],"properties":{"query":{"type":"array","description":"A list of CriteriaGroups which will be AND'd together to generate a result set.","items":{"$ref":"#/definitions/CriteriaGroup"}}},"description":"Used to retrieve executionData based upon certain criteria"},"GetFlowExecutionDataJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entities":{"type":"array","description":"On jobState = Success this field will be populated with the list of results of files for download.","items":{"$ref":"#/definitions/ExecutionDataEntity"}},"jobState":{"type":"string","description":"The state of the backend process to prep the files for download.","enum":["Registered","Running","Success","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is a list of executionData links that can be used to download the complete executionData"},"FlowsQueryCriteriaResponse":{"type":"object","properties":{"criteria":{"type":"array","description":"The is a list of allowed criteria to query on.","items":{"$ref":"#/definitions/QueryCriteria"}},"flowTypes":{"type":"array","description":"The is a list of flow types the organization has access to.","items":{"type":"string","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]}},"actionTypes":{"type":"array","description":"The is a list of action types the organization has access to.","items":{"type":"string","enum":["actionAbortSurveyInvite","actionAddFlowMilestone","actionAskForBoolean","actionAskForNLUIntent","actionAskForNLUNextIntent","actionAskForSlot","actionCallBotConnector","actionCallBotFlow","actionCallCommonModule","actionCallData","actionCallDataSecure","actionCallDialogEngineBot","actionCallDialogflowBot","actionCallDialogflowCxBot","actionCallDigitalBotFlow","actionCallLexBot","actionCallLexV2Bot","actionCallNuanceMixBot","actionCallTask","actionChangeState","actionClearSlot","actionClearVoicemailSnippet","actionCollectInput","actionCommunicate","actionCompleteSurveyInvite","actionCreateCallback","actionDataTableLookup","actionDecision","actionDecryptData","actionDetectSilence","actionDialExtension","actionDialName","actionDigitalMenu","actionDisconnect","actionEnableParticipantRecord","actionEncryptData","actionEndState","actionEndTask","actionEndWorkflow","actionEvaluateSchedule","actionEvaluateScheduleGroup","actionExitBotFlow","actionExitLoop","actionExtractSecureData","actionFindEmergencyGroup","actionFindGroup","actionFindLanguageSkill","actionFindQueue","actionFindQueueById","actionFindSchedule","actionFindScheduleGroup","actionFindSkill","actionFindSystemPrompt","actionFindUser","actionFindUserById","actionFindUserPrompt","actionFindUsersById","actionFlushAudio","actionGetConversationData","actionGetExternalContact","actionGetExternalOrganization","actionGetJourneyOutcome","actionGetJourneyOutcomeScoresBySession","actionGetJourneySegment","actionGetJourneySession","actionGetJourneySessionsByCustomer","actionGetJourneySessionsByExternalContact","actionGetParticipantData","actionGetResponse","actionGetSecuredData","actionHoldMusic","actionInitializeFlowOutcome","actionJumpToMenu","actionJumpToTask","actionLoop","actionLoopUntil","actionNextLoop","actionPlayAudio","actionPlayAudioOnSilence","actionPlayEstimatedWaitTime","actionPlayPositionInQueue","actionPlayUserGreeting","actionPlayUserName","actionPreviousMenu","actionProcessVoicemailInput","actionRepeatMenu","actionReturnToAgent","actionSaveWorkitem","actionScreenPop","actionSearchExternalContacts","actionSendAutoReply","actionSendResponse","actionSetActiveIntent","actionSetConversationData","actionSetExternalTag","actionSetFlowOutcome","actionSetLocale","actionSetParticipantData","actionSetPriority","actionSetSecuredData","actionSetSkills","actionSetUUIData","actionSetWhisperAudio","actionSetWrapupCode","actionShowKnowledgeArticle","actionSubmitVoicemailSnippet","actionSwitch","actionTranscription","actionTransferExternal","actionTransferFlow","actionTransferFlowSecure","actionTransferGroup","actionTransferToAcd","actionTransferUser","actionTransferVoicemail","actionUpdateData","actionWait","actionWaitForInput","menuDialExtension","menuDialName","menuDisconnect","menuJumpToMenu","menuJumpToTask","menuMenu","menuPreviousMenu","menuRepeatMenu","menuShowKnowledgeArticle","menuTask","menuTransferToAcd","menuTransferFlow","menuTransferGroup","menuTransferExternal","menuTransferFlowSecure","menuTransferUser","menuTransferVoicemail"]}},"errorCodes":{"type":"array","description":"The is a list of potential error codes the organization may encounter.","items":{"type":"string"}},"warningCodes":{"type":"array","description":"The is a list of potential warning codes the organization may encounter.","items":{"type":"string"}}},"description":"The response for QueryCapabilities which contains the allowed criteria, flow types and action types for the organization."},"FlowExecutionDataQueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDateTime":{"type":"string","format":"date-time","description":"The start time for the execution of this flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDateTime":{"type":"string","format":"date-time","description":"The end time for the execution of this flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"flowId":{"type":"string","description":"The id of the flow that was executed."},"flowVersion":{"type":"string","description":"The version of the flow that was executed."},"conversationId":{"type":"string","description":"The id of the conversation that executed this flow."},"flowType":{"type":"string","description":"The type of flow.","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"flowErrorReason":{"type":"string","description":"If the flow errored out this is the reason."},"flowName":{"type":"string","description":"The name of the flow."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is the metadata of an executionData entry for a flow."},"FlowResultEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionDataQueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxConfig":{"type":"object","required":["disableEmailPii","sendEmailNotifications"],"properties":{"sendEmailNotifications":{"type":"boolean","description":"Whether to enable email notifications for this organization"},"disableEmailPii":{"type":"boolean","description":"Whether to disable PII for email notifications"}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"sharingUri":{"type":"string","format":"uri"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean"},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxDocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"GamificationStatus":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Gamification status of the organization."},"dateStart":{"type":"string","format":"date","description":"Gamification start date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"automaticUserAssignment":{"type":"boolean","description":"Automatic assignment of users to the default profile"},"dateStartPersonalBest":{"type":"string","format":"date","description":"Personal best aggregation starting date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"OverallBestPoints":{"type":"object","properties":{"division":{"description":"The requested division","readOnly":true,"$ref":"#/definitions/Division"},"bestPoints":{"type":"array","description":"List of gamification best point items","readOnly":true,"items":{"$ref":"#/definitions/OverallBestPointsItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"OverallBestPointsItem":{"type":"object","properties":{"granularityType":{"type":"string","description":"Best points aggregation interval granularity","readOnly":true,"enum":["Daily","Weekly","Monthly"]},"users":{"type":"array","description":"List of associated users with the equal points.","readOnly":true,"items":{"$ref":"#/definitions/UserReference"}},"count":{"type":"integer","format":"int32","description":"The count of the user IDs in the list","readOnly":true},"points":{"type":"integer","format":"int32","description":"Gamification points","readOnly":true},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true}}},"Leaderboard":{"type":"object","properties":{"division":{"description":"The targeted division for this leaderboard","readOnly":true,"$ref":"#/definitions/Division"},"metric":{"description":"The metric id if the leaderboard is about a specific metric","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"leaders":{"type":"array","description":"The list of leaders generated.","readOnly":true,"items":{"$ref":"#/definitions/LeaderboardItem"}},"userRank":{"description":"The requesting user's rank","readOnly":true,"$ref":"#/definitions/LeaderboardItem"},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LeaderboardItem":{"type":"object","properties":{"user":{"description":"The user object for this leaderboard rank","readOnly":true,"$ref":"#/definitions/UserReference"},"rank":{"type":"integer","format":"int32","description":"The rank of the user","readOnly":true},"points":{"type":"integer","format":"int64","description":"The points collected by the user","readOnly":true}}},"DefaultObjective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queues":{"type":"array","description":"A list of queues for the metric","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topics":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]}}},"MetricDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"unitType":{"type":"string","description":"The type of associated metric unit","enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"shortName":{"type":"string","description":"An alternate name for this metric definition, often abbreviation"},"dividendMetrics":{"type":"array","description":"Metric names used as dividend","items":{"type":"string"}},"divisorMetrics":{"type":"array","description":"Metric names used as divisor","items":{"type":"string"}},"defaultObjective":{"description":"A predefined default objective for this metric","$ref":"#/definitions/DefaultObjective"},"lockTemplateId":{"type":"string","description":"An optional field to specify if this metric definition is locked to certain template. e.g. punctuality"},"mediaTypeFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on media types"},"initialDirectionFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on initial direction"},"queueFilteringAllowed":{"type":"boolean","description":"Flag to indicate if this metricDefinition allows filter based on queues"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ObjectiveZone":{"type":"object","required":["directionType","label","lowerLimitPoints","upperLimitPoints","zoneType"],"properties":{"label":{"type":"string","description":"label"},"directionType":{"type":"string","description":"direction type","enum":["Up","Down","Flat"]},"zoneType":{"type":"string","description":"zone type","enum":["Good","Target","Great","Out"]},"upperLimitPoints":{"type":"integer","format":"int32","description":"upper limit points"},"lowerLimitPoints":{"type":"integer","format":"int32","description":"lower limit points"},"upperLimitValue":{"type":"integer","format":"int32","description":"upper limit value"},"lowerLimitValue":{"type":"integer","format":"int32","description":"lower limit value"}}},"GetMetricDefinitionsResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/MetricDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"ObjectiveTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"zones":{"type":"array","items":{"$ref":"#/definitions/ObjectiveZone"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetTemplatesResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ObjectiveTemplate"}},"selfUri":{"type":"string","format":"uri"}}},"ProfileWithDateRange":{"type":"object","properties":{"id":{"type":"string","description":"Profile ID"},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserProfilesInDateRange":{"type":"object","properties":{"user":{"description":"The query agent","$ref":"#/definitions/UserReference"},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"profiles":{"type":"array","description":"The list of profiles of the agent","items":{"$ref":"#/definitions/ProfileWithDateRange"}}}},"UserProfilesInDateRangeRequest":{"type":"object","required":["endWorkday","startWorkday"],"properties":{"startWorkday":{"type":"string","example":"2022-11-07","description":"Start work day in ISO-8601 format used in the date range."},"endWorkday":{"type":"string","example":"2022-11-11","description":"End work day in ISO-8601 format used in the date range."}}},"PerformanceProfile":{"type":"object","required":["description","metricOrders","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"A name for this performance profile"},"division":{"description":"The division for this performance profile associate to","readOnly":true,"$ref":"#/definitions/Division"},"description":{"type":"string","description":"A description about this performance profile"},"metricOrders":{"type":"array","description":"Order of the associated metrics. The list should contain valid ids for metrics","items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"reportingIntervals":{"type":"array","description":"The reporting interval periods for this performance profile","items":{"$ref":"#/definitions/ReportingInterval"}},"active":{"type":"boolean","description":"The flag for active profiles","readOnly":true},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this performance profile","readOnly":true},"maxLeaderboardRankSize":{"type":"integer","format":"int32","description":"The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportingInterval":{"type":"object","required":["intervalType","intervalValue"],"properties":{"intervalType":{"type":"string","description":"The granularity of the reporting interval period","enum":["Day","Week","Month"]},"intervalValue":{"type":"integer","format":"int32","description":"The value of the reporting interval period for a given interval type"}}},"GetProfilesResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PerformanceProfile"}},"selfUri":{"type":"string","format":"uri"}}},"CreatePerformanceProfile":{"type":"object","required":["active","description","division","maxLeaderboardRankSize","name","reportingIntervals"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"A name for this performance profile"},"division":{"description":"The associated division for this Performance Profile","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"A description about this performance profile"},"metricOrders":{"type":"array","description":"Order of the associated metrics. The list should contain valid ids for metrics","readOnly":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"reportingIntervals":{"type":"array","description":"The reporting interval periods for this performance profile","items":{"$ref":"#/definitions/ReportingInterval"}},"active":{"type":"boolean","description":"The flag for active profiles"},"memberCount":{"type":"integer","format":"int32","description":"The number of members in this performance profile","readOnly":true},"maxLeaderboardRankSize":{"type":"integer","format":"int32","description":"The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Metric":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this metric"},"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"objective":{"description":"Associated objective for this metric","$ref":"#/definitions/Objective"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"linkedMetric":{"description":"The linked metric entity reference","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of this metric. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateUnlinked":{"type":"string","format":"date","description":"The unlinked workday for this metric if this metric was ever unlinked. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"precision":{"type":"integer","format":"int32","description":"The precision of the metric, must be between 0 and 5","readOnly":true},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]},"sourcePerformanceProfile":{"description":"The source performance profile when this metric is linked","readOnly":true,"$ref":"#/definitions/PerformanceProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Objective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queues":{"type":"array","description":"A list of queues for the metric","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topics":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"$ref":"#/definitions/AddressableEntityRef"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]},"dateStart":{"type":"string","format":"date","description":"start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"TargetPerformanceProfile":{"type":"object","required":["targetPerformanceProfileId"],"properties":{"targetPerformanceProfileId":{"type":"string","description":"The target destination performanceProfileId for the linked metric."}}},"CreateMetric":{"type":"object","required":["name"],"properties":{"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"objective":{"description":"Associated objective for this metric","$ref":"#/definitions/CreateObjective"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"name":{"type":"string","description":"The name of this metric"},"precision":{"type":"integer","format":"int32","description":"The precision of the metric, must be between 0 and 5"},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]}}},"CreateObjective":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"templateId":{"type":"string","description":"The id of this objective's base template"},"zones":{"type":"array","description":"Objective zone specifies min,max points and values for the associated metric","items":{"$ref":"#/definitions/ObjectiveZone"}},"enabled":{"type":"boolean","description":"A flag for whether this objective is enabled for the related metric"},"topicIds":{"type":"array","description":"A list of topic ids for detected topic metrics","items":{"type":"string"}},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}},"queueIds":{"type":"array","description":"A list of queue ids for the metric","items":{"type":"string"}},"topicIdsFilterType":{"type":"string","description":"A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".","enum":["and","or"]},"evaluationFormContextIds":{"type":"array","description":"The ids of associated evaluation form context, for Quality Evaluation Score metrics","items":{"type":"string"}},"initialDirection":{"type":"string","description":"The initial direction to filter on","enum":["inbound","outbound"]},"dateStart":{"type":"string","format":"date","description":"start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"GetMetricsResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metrics"}},"selfUri":{"type":"string","format":"uri"}}},"Metrics":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"order":{"type":"integer","format":"int32","description":"The order of metric within a performance profile"},"metricDefinitionName":{"type":"string","description":"The name of associated metric definition"},"metricDefinitionId":{"type":"string","description":"The id of associated metric definition"},"externalMetricDefinitionId":{"type":"string","description":"The id of associated external metric definition"},"unitType":{"type":"string","description":"Corresponding unit type for this metric","enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"enabled":{"type":"boolean","description":"A flag for whether this metric is enabled for a performance profile"},"templateName":{"type":"string","description":"The name of associated objective template"},"maxPoints":{"type":"integer","format":"int32","description":"Achievable maximum points for this metric"},"performanceProfileId":{"type":"string","description":"Performance profile id of this metric"},"linkedMetric":{"description":"The linked metric entity reference","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of this metric. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateUnlinked":{"type":"string","format":"date","description":"The unlinked workday for this metric if this metric was ever unlinked. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"sourcePerformanceProfile":{"description":"The source performance profile when this metric is linked","readOnly":true,"$ref":"#/definitions/PerformanceProfile"},"unitDefinition":{"type":"string","description":"Unit definition of linked external metric","readOnly":true},"precision":{"type":"integer","format":"int32","description":"Precision of linked external metric","readOnly":true},"timeDisplayUnit":{"type":"string","description":"The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values","enum":["None","Seconds","Minutes","Hours"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetMetricResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Metric"}},"selfUri":{"type":"string","format":"uri"}}},"DivisionReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InsightsDetails":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"user":{"description":"The query user","$ref":"#/definitions/UserReference"},"metricData":{"type":"array","description":"The list of insights data for each metric of the user","items":{"$ref":"#/definitions/InsightsDetailsMetricItem"}},"overallData":{"description":"Overall insights data of the user","$ref":"#/definitions/InsightsDetailsOverallItem"}}},"InsightsDetailsMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the data","$ref":"#/definitions/AddressableEntityRef"},"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsDetailsMetricPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsDetailsMetricPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"},"valueChange":{"type":"number","format":"double","description":"Value change"}}},"InsightsDetailsMetricPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"rankTotalPoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for points on this metric"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for percentage on this metric"},"value":{"type":"number","format":"double","description":"Average value"}}},"InsightsDetailsOverallItem":{"type":"object","properties":{"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsDetailsOverallPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsDetailsOverallPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"}}},"InsightsDetailsOverallPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"rankTotalPoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for points on this metric"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"The agent's rank in leader board for percentage on this metric"}}},"WorkdayPeriod":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"InsightsAgentItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"manager":{"description":"This user's manager.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InsightsAgents":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"entities":{"type":"array","description":"The list of insights agents","items":{"$ref":"#/definitions/InsightsAgentItem"}}}},"InsightsTrend":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"entities":{"type":"array","description":"The list of insights trend for each metric","items":{"$ref":"#/definitions/InsightsTrendMetricItem"}},"total":{"description":"The insights trend in total","$ref":"#/definitions/InsightsTrendTotalItem"}}},"InsightsTrendMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the trend","$ref":"#/definitions/AddressableEntityRef"},"trends":{"description":"Trends for the metric","$ref":"#/definitions/InsightsTrends"}}},"InsightsTrendTotalItem":{"type":"object","properties":{"trends":{"description":"Trends for the metric","$ref":"#/definitions/InsightsTrends"}}},"InsightsTrends":{"type":"object","properties":{"comparativePeriod":{"type":"array","description":"List of trend data in the comparative period","items":{"$ref":"#/definitions/TrendData"}},"primaryPeriod":{"type":"array","description":"List of trend data in the primary period","items":{"$ref":"#/definitions/TrendData"}}}},"TrendData":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"percentOfGoal":{"type":"number","format":"double","description":"Percent of goal"},"averageValue":{"type":"number","format":"double","description":"Average metric value"}}},"InsightsSummary":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InsightsSummaryUserItem"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"pageCount":{"type":"integer","format":"int32"}}},"InsightsSummaryMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the data","$ref":"#/definitions/AddressableEntityRef"},"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsSummaryMetricPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsSummaryMetricPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"},"valueChange":{"type":"number","format":"double","description":"Value change"}}},"InsightsSummaryMetricPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"},"value":{"type":"number","format":"double","description":"Average value"}}},"InsightsSummaryOverallItem":{"type":"object","properties":{"comparativePeriod":{"description":"Insights data in the comparative period","$ref":"#/definitions/InsightsSummaryOverallPeriodPoints"},"primaryPeriod":{"description":"Insights data in the primary period","$ref":"#/definitions/InsightsSummaryOverallPeriodPoints"},"percentOfGoalChange":{"type":"number","format":"double","description":"Percent of goal change"}}},"InsightsSummaryOverallPeriodPoints":{"type":"object","properties":{"points":{"type":"integer","format":"int32","description":"Points scored"},"maxPoints":{"type":"integer","format":"int32","description":"Max possible points"},"dataPointCount":{"type":"integer","format":"int32","description":"Number of data points"},"percentOfGoal":{"type":"number","format":"double","description":"Percentage of the goal"}}},"InsightsSummaryUserItem":{"type":"object","properties":{"user":{"description":"Queried user","$ref":"#/definitions/UserReference"},"metricData":{"type":"array","description":"The list of insights data for each metric of the user","items":{"$ref":"#/definitions/InsightsSummaryMetricItem"}},"overallData":{"description":"Overall insights data of the user","$ref":"#/definitions/InsightsSummaryOverallItem"},"ranking":{"type":"integer","format":"int32","description":"Ranking of the user"}}},"UserInsightsTrend":{"type":"object","properties":{"performanceProfile":{"description":"The performance profile","$ref":"#/definitions/AddressableEntityRef"},"division":{"description":"The division","$ref":"#/definitions/DivisionReference"},"granularity":{"type":"string","description":"Granularity","enum":["Daily","Weekly","Monthly"]},"comparativePeriod":{"description":"The comparative period work day date range","$ref":"#/definitions/WorkdayPeriod"},"primaryPeriod":{"description":"The primary period work day date range","$ref":"#/definitions/WorkdayPeriod"},"user":{"description":"The query user","$ref":"#/definitions/UserReference"},"entities":{"type":"array","description":"The list of insights trend for each metric","items":{"$ref":"#/definitions/UserInsightsTrendMetricItem"}},"total":{"description":"The insights trend in total","$ref":"#/definitions/UserInsightsTrendTotalItem"}}},"UserInsightsTrendMetricItem":{"type":"object","properties":{"metric":{"description":"The gamification metric for the trend","$ref":"#/definitions/AddressableEntityRef"},"trends":{"description":"Trends for the metric","$ref":"#/definitions/UserInsightsTrends"}}},"UserInsightsTrendTotalItem":{"type":"object","properties":{"trends":{"description":"Trends for the metric","$ref":"#/definitions/UserInsightsTrends"}}},"UserInsightsTrends":{"type":"object","properties":{"comparativePeriod":{"type":"array","description":"List of trend data in the comparative period","items":{"$ref":"#/definitions/UserTrendData"}},"primaryPeriod":{"type":"array","description":"List of trend data in the primary period","items":{"$ref":"#/definitions/UserTrendData"}}}},"UserTrendData":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"Start workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEndWorkday":{"type":"string","format":"date","description":"End workday used as the date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"percentOfGoal":{"type":"number","format":"double","description":"Percent of goal"},"averageValue":{"type":"number","format":"double","description":"Average metric value"},"rankTotalPoints":{"type":"integer","format":"int32","description":"Rank, ordered by total points"},"rankPercentagePoints":{"type":"integer","format":"int32","description":"Rank, ordered by percentage of points"}}},"Assignment":{"type":"object","properties":{"assignedMembers":{"type":"array","description":"The list of users successfully assigned to the custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"removedMembers":{"type":"array","description":"The list of users successfully removed from the custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"assignmentErrors":{"type":"array","description":"The list of users failed assignment or removal for the custom performance profile","items":{"$ref":"#/definitions/AssignmentError"}}}},"AssignmentError":{"type":"object","properties":{"user":{"description":"A user that is failed to be removed from the performance profile","$ref":"#/definitions/UserReference"},"message":{"type":"string","description":"Error message from membership assignment"}}},"AssignUsers":{"type":"object","required":["membersToAssign","membersToRemove"],"properties":{"membersToAssign":{"type":"array","description":"List of user ids to assign to a performance profile","items":{"type":"string"}},"membersToRemove":{"type":"array","description":"List of user ids to remove from a performance profile","items":{"type":"string"}}}},"Member":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The user's id"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"The associated user reference as a member of a performance profile"},"MemberListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Member"}}}},"AssignmentValidation":{"type":"object","properties":{"membersNotAssigned":{"type":"array","description":"The list of users that are not assigned to any custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"membersAlreadyAssigned":{"type":"array","description":"The list of users that are already assigned to the requesting custom performance profile","items":{"$ref":"#/definitions/UserReference"}},"membersAlreadyAssignedToOther":{"type":"array","description":"The list of users that are already assigned to other custom performance profiles","items":{"$ref":"#/definitions/OtherProfileAssignment"}},"invalidMemberAssignments":{"type":"array","description":"The list of user id that are invalid for the gamfication service to handle","items":{"$ref":"#/definitions/InvalidAssignment"}}}},"InvalidAssignment":{"type":"object","properties":{"user":{"description":"Invalid user for validation","$ref":"#/definitions/UserReference"},"message":{"type":"string","description":"The reason for the invalid input for validation"}}},"OtherProfileAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"currentProfile":{"description":"The current performance profile that this user belongs to","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ValidateAssignUsers":{"type":"object","required":["membersToAssign"],"properties":{"membersToAssign":{"type":"array","description":"List of user ids to assign to a performance profile","items":{"type":"string"}}}},"MetricValueTrendAverage":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The targeted start workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The targeted end workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateReferenceWorkday":{"type":"string","format":"date","description":"The targeted reference workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the metrics","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the metrics","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"result":{"description":"The metric value trend and average","readOnly":true,"$ref":"#/definitions/WorkdayValuesMetricItem"},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metric":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"WorkdayValuesMetricItem":{"type":"object","properties":{"metric":{"description":"Gamification metric for the average and the trend","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metricDefinition":{"description":"Gamification metric definition for the average and the trend","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"average":{"type":"number","format":"double","description":"The average value of the metric","readOnly":true},"unitType":{"type":"string","description":"The unit type of the metric value","readOnly":true,"enum":["None","Percent","Currency","Seconds","Number","AttendanceStatus","Unit"]},"trend":{"type":"array","description":"The metric value trend","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesTrendItem"}}}},"WorkdayValuesTrendItem":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"The workday for the metric value. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"value":{"type":"number","format":"double","description":"The metric value","readOnly":true}}},"UserBestPoints":{"type":"object","properties":{"user":{"description":"The requested user for the best points","readOnly":true,"$ref":"#/definitions/UserReference"},"bestPoints":{"type":"array","description":"List of best point for the requested user","readOnly":true,"items":{"$ref":"#/definitions/UserBestPointsItem"}}}},"UserBestPointsItem":{"type":"object","properties":{"granularityType":{"type":"string","description":"Best points aggregation interval granularity","readOnly":true,"enum":["Daily","Weekly","Monthly"]},"points":{"type":"integer","format":"int32","description":"Gamification points","readOnly":true},"dateStartWorkday":{"type":"string","format":"date","description":"Start workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"End workday of the best points aggregation interval. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"rank":{"type":"integer","format":"int32","description":"The rank of this user","readOnly":true}}},"PunctualityEvent":{"type":"object","properties":{"dateScheduleStart":{"type":"string","format":"date-time","description":"The scheduled activity start time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The time the user started the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the activity in minutes","readOnly":true},"description":{"type":"string","description":"The description of the activity","readOnly":true},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity","readOnly":true},"activityCode":{"type":"string","description":"The activity code","readOnly":true},"activityName":{"type":"string","description":"The activity name","readOnly":true},"category":{"type":"string","description":"The category for the activity","readOnly":true},"points":{"type":"integer","format":"int32","description":"The points earned for this activity","readOnly":true},"delta":{"type":"number","format":"double","description":"Difference between this activity and the last activity in seconds","readOnly":true},"bullseye":{"type":"boolean"}}},"QualityEvaluationScoreItem":{"type":"object","properties":{"evaluationId":{"type":"string","description":"The id of evaluation","readOnly":true},"conversationId":{"type":"string","description":"The id of conversation","readOnly":true},"conversationDate":{"type":"string","format":"date-time","description":"The date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversationEndDate":{"type":"string","format":"date-time","description":"The end date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"formName":{"type":"string","description":"The name of form","readOnly":true},"points":{"type":"integer","format":"int32","description":"Gamification points earned for this metric","readOnly":true},"evaluationScore":{"type":"number","format":"double","description":"The quality score of evaluation as a percentage","readOnly":true},"maxPoints":{"type":"integer","format":"int32","description":"The maximum Gamification points a user may earn for this metric","readOnly":true},"mediaTypes":{"type":"array","description":"A list of media types for the metric","items":{"type":"string","enum":["callback","chat","cobrowse","email","message","screenshare","unknown","video","voice"]}}}},"WorkdayMetric":{"type":"object","properties":{"metric":{"description":"Gamification metric","readOnly":true,"$ref":"#/definitions/Metric"},"objective":{"description":"Current objective for this metric","readOnly":true,"$ref":"#/definitions/Objective"},"points":{"type":"integer","format":"int32","description":"Gamification points earned for this metric","readOnly":true},"maxPoints":{"type":"integer","format":"int32","description":"The maximum Gamification points a user may earn for this metric","readOnly":true},"value":{"type":"number","format":"double","description":"Value of this metric","readOnly":true},"punctualityEvents":{"type":"array","description":"List of schedule activity events for punctuality metrics","readOnly":true,"items":{"$ref":"#/definitions/PunctualityEvent"}},"evaluationDetails":{"type":"array","description":"List of evaluations for quality evaluation score metrics","readOnly":true,"items":{"$ref":"#/definitions/QualityEvaluationScoreItem"}}}},"WorkdayMetricListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkdayMetric"}}}},"AttendanceStatus":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"the workday date of this attendance status. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"attendanceStatusType":{"type":"string","description":"the attendance status","readOnly":true,"enum":["HasData","Scheduled","Absent","Present","NoSchedule"]},"hasEvaluation":{"type":"string","description":"the quality evaluation score status","readOnly":true,"enum":["HasQualityEvaluation","NoQualityEvaluation"]}}},"AttendanceStatusListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttendanceStatus"}}}},"AllTimePoints":{"type":"object","properties":{"user":{"description":"Queried user","readOnly":true,"$ref":"#/definitions/UserReference"},"dateEndWorkday":{"type":"string","format":"date","description":"Queried end workday for all time points to be collected. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"allTimePoints":{"type":"integer","format":"int64","description":"All time point collected bt the user","readOnly":true}}},"SingleWorkdayAveragePoints":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"Queried target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the average points","readOnly":true,"$ref":"#/definitions/Division"},"averagePoints":{"type":"number","format":"double","description":"The average points per agent earned within the division","readOnly":true},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"WorkdayPointsTrend":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The start workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The end workday for the query range for the gamification points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"user":{"description":"The targeted user for the query","readOnly":true,"$ref":"#/definitions/UserReference"},"dayOfWeek":{"type":"string","description":"Aggregated for same day comparison","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"averagePoints":{"type":"number","format":"double","description":"The total average points","readOnly":true},"trend":{"type":"array","description":"Daily points trends","readOnly":true,"items":{"$ref":"#/definitions/WorkdayPointsTrendItem"}}}},"WorkdayPointsTrendItem":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"workday date for the points trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"points":{"type":"number","format":"double","description":"workday points for the date","readOnly":true}}},"WorkdayValuesTrend":{"type":"object","properties":{"dateStartWorkday":{"type":"string","format":"date","description":"The start workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateEndWorkday":{"type":"string","format":"date","description":"The end workday for the query range for the metric value trend. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateReferenceWorkday":{"type":"string","format":"date","description":"The reference workday used to determine the metric definition. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the query","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the query","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"results":{"type":"array","description":"The metric value trends","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesMetricItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"metric":{"description":"The targeted metric for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SingleWorkdayAverageValues":{"type":"object","properties":{"dateWorkday":{"type":"string","format":"date","description":"The targeted workday for average value query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"division":{"description":"The targeted division for the metrics","readOnly":true,"$ref":"#/definitions/Division"},"user":{"description":"The targeted user for the metrics","readOnly":true,"$ref":"#/definitions/UserReference"},"timezone":{"type":"string","description":"The time zone used for aggregating metric values","readOnly":true},"results":{"type":"array","description":"The metric value averages","readOnly":true,"items":{"$ref":"#/definitions/WorkdayValuesMetricItem"}},"performanceProfile":{"description":"The targeted performance profile for the average points","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"DialerContactId":{"type":"object","properties":{"id":{"type":"string"},"contactListId":{"type":"string"}}},"GDPRJourneyCustomer":{"type":"object","properties":{"type":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined."},"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined."}}},"GDPRRequest":{"type":"object","required":["createdBy","createdDate","requestType","status","subject"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdBy":{"description":"The user that created this request","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"replacementTerms":{"type":"array","example":"[ { \"type\": \"EMAIL\": \"existingValue\": \"personal.email@domain.com\", \"updatedValue\": \"updated.personal.email@domain.com\" } ]","description":"The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request","items":{"$ref":"#/definitions/ReplacementTerm"}},"requestType":{"type":"string","description":"The type of GDPR request","enum":["GDPR_EXPORT","GDPR_UPDATE","GDPR_DELETE"]},"createdDate":{"type":"string","format":"date-time","description":"When the request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the request","readOnly":true,"enum":["INITIATED","SEARCHING","UPDATING","DELETING","COMPLETED","ERROR","FINALIZING"]},"subject":{"example":"{ \"emailAddresses\": [\"personal.email@domain.com\"], \"phoneNumbers\": [\"+13115552368\"] }","description":"The subject of the GDPR request","$ref":"#/definitions/GDPRSubject"},"resultsUrl":{"type":"string","description":"The location where the results of the request can be retrieved","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GDPRSubject":{"type":"object","properties":{"name":{"type":"string"},"userId":{"type":"string"},"externalContactId":{"type":"string"},"dialerContactId":{"$ref":"#/definitions/DialerContactId"},"journeyCustomer":{"$ref":"#/definitions/GDPRJourneyCustomer"},"socialHandle":{"$ref":"#/definitions/SocialHandle"},"externalId":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"phoneNumbers":{"type":"array","items":{"type":"string"}},"emailAddresses":{"type":"array","items":{"type":"string"}}}},"ReplacementTerm":{"type":"object","properties":{"type":{"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","enum":["TWITTER"]},"value":{"type":"string"}}},"GDPRRequestEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRRequest"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GDPRSubjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRSubject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean"},"mapboxKey":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"Greeting":{"type":"object","required":["owner","ownerType","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Greeting type","enum":["STATION","VOICEMAIL","NAME"]},"ownerType":{"type":"string","description":"Greeting owner type","enum":["USER","ORGANIZATION","GROUP"]},"owner":{"description":"Greeting owner","$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION","GROUP"]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Greeting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ClientApp":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED","RESTORED"]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/ClientAppConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a ClientApp"},"ClientAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"ClientAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ClientApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialSpecification":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if the credential must be provided in order for the integration configuration to be valid.","readOnly":true},"title":{"type":"string","description":"Title describing the usage for this credential.","readOnly":true},"credentialTypes":{"type":"array","description":"List of acceptable credential types that can be provided for this credential.","readOnly":true,"items":{"type":"string"}}},"description":"Specifies the requirements for a credential that can be provided for configuring an integration"},"EffectiveConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties"],"properties":{"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field.","additionalProperties":{"type":"object"}},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}}},"description":"Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type."},"HelpLink":{"type":"object","properties":{"uri":{"type":"string","description":"URI of the help resource","readOnly":true},"title":{"type":"string","description":"Link text of the resource","readOnly":true},"description":{"type":"string","description":"Description of the document or resource","readOnly":true}},"description":"Link to a help or support resource"},"IntegrationConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"IntegrationStatusInfo":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"description":"Localizable status details for the integration.","readOnly":true,"$ref":"#/definitions/MessageInfo"},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Status information for an Integration."},"IntegrationType":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"category":{"type":"string","description":"Category describing the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"helpUri":{"type":"string","description":"URI of a page with more information about the integration type","readOnly":true},"termsOfServiceUri":{"type":"string","description":"URI of a page with terms and conditions for the integration type","readOnly":true},"vendorName":{"type":"string","description":"Name of the vendor of this integration type","readOnly":true},"vendorWebsiteUri":{"type":"string","description":"URI of the vendor's website","readOnly":true},"marketplaceUri":{"type":"string","description":"URI of the marketplace listing for this integration type","readOnly":true},"faqUri":{"type":"string","description":"URI of frequently asked questions about the integration type","readOnly":true},"privacyPolicyUri":{"type":"string","description":"URI of a privacy policy for users of the integration type","readOnly":true},"supportContactUri":{"type":"string","description":"URI for vendor support","readOnly":true},"salesContactUri":{"type":"string","description":"URI for vendor sales information","readOnly":true},"helpLinks":{"type":"array","description":"List of links to additional help resources","readOnly":true,"items":{"$ref":"#/definitions/HelpLink"}},"credentials":{"type":"object","description":"Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CredentialSpecification"}},"nonInstallable":{"type":"boolean","description":"Indicates if the integration type is installable or not.","readOnly":true},"maxInstances":{"type":"integer","format":"int32","description":"The maximum number of integration instances allowable for this integration type","readOnly":true},"userPermissions":{"type":"array","description":"List of permissions required to permit user access to the integration type.","readOnly":true,"items":{"type":"string"}},"vendorOAuthClientIds":{"type":"array","description":"List of OAuth Client IDs that must be authorized when the integration is created.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"Integration":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED","RESTORED"]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"}},"description":"Configuration information for the integration"},"IntegrationTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"UserApp":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the userApp, used to distinguish this userApp from others of the same type.","readOnly":true},"integrationType":{"description":"Integration Type for the userApp","readOnly":true,"$ref":"#/definitions/IntegrationType"},"config":{"$ref":"#/definitions/UserAppConfigurationInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a UserApp"},"UserAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"UserAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Category":{"type":"object","properties":{"name":{"type":"string","description":"Category name"}},"description":"List of available Action categories."},"CategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Category"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ActionCertificate":{"type":"object","properties":{"signingAuthority":{"type":"string","description":"The Signing Authority for the certificate","enum":["DigiCert","Genesys"]},"certificate":{"type":"string","description":"The certificate string"},"status":{"type":"string","description":"The certificate status","enum":["Current","Upcoming"]},"type":{"type":"string","description":"The certificate type","enum":["Client"]}},"description":"Details for an mTLS certificate"},"ActionCertificateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionCertificate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Action":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"integrationId":{"type":"string","description":"The ID of the integration for which this action is associated"},"category":{"type":"string","description":"Category of Action"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContract"},"version":{"type":"integer","format":"int32","description":"Version of this action"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionConfig":{"type":"object","properties":{"timeoutSeconds":{"type":"integer","format":"int32","description":"Optional 1-60 second timeout enforced on the execution or test of this action. This setting is invalid for Custom Authentication Actions."},"request":{"description":"Configuration of outbound request.","$ref":"#/definitions/RequestConfig"},"response":{"description":"Configuration of response processing.","$ref":"#/definitions/ResponseConfig"}},"description":"Defines components of the Action Config."},"ActionContract":{"type":"object","properties":{"output":{"description":"The output to expect when executing this action.","$ref":"#/definitions/ActionOutput"},"input":{"description":"The input required when executing this action.","$ref":"#/definitions/ActionInput"}},"description":"This resource contains all of the schemas needed to define the inputs and outputs, of a single Action."},"ActionInput":{"type":"object","properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaFlattened":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaUri":{"type":"string","description":"The URI of the input schema"}},"description":"Input requirements of Action."},"ActionOutput":{"type":"object","properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"successSchemaUri":{"type":"string","description":"URI to retrieve success schema"},"errorSchema":{"description":"JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaUri":{"type":"string","description":"URI to retrieve error schema"},"successSchemaFlattened":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaFlattened":{"type":"object","description":"JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both."}},"description":"Output definition of Action."},"RequestConfig":{"type":"object","properties":{"requestUrlTemplate":{"type":"string","description":"URL that may include placeholders for requests to 3rd party service. This value is read only for Function Integrations and will be set when a draft is created."},"requestTemplate":{"type":"string","description":"Velocity template to define request body sent to 3rd party service."},"requestTemplateUri":{"type":"string","description":"URI to retrieve requestTemplate"},"requestType":{"type":"string","description":"HTTP method to use for request"},"headers":{"type":"object","description":"Headers to include in request in (Header Name, Value) pairs.","additionalProperties":{"type":"string"}}},"description":"Defines response components of the Action Request."},"ResponseConfig":{"type":"object","properties":{"translationMap":{"type":"object","description":"Map 'attribute name' and 'JSON path' pairs used to extract data from REST response.","additionalProperties":{"type":"string"}},"translationMapDefaults":{"type":"object","description":"Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key.","additionalProperties":{"type":"string"}},"successTemplate":{"type":"string","description":"Velocity template to build response to return from Action."},"successTemplateUri":{"type":"string","description":"URI to retrieve success template."}},"description":"Defines response components of the Action Request."},"TestExecutionOperationResult":{"type":"object","properties":{"step":{"type":"integer","format":"int32","description":"The step number to indicate the order in which the operation was performed"},"name":{"type":"string","description":"Name of the operation performed"},"success":{"type":"boolean","description":"Indicated whether or not the operation was successful"},"result":{"type":"object","description":"The result of the operation"},"error":{"description":"Error that occurred during the operation","$ref":"#/definitions/ErrorBody"}}},"TestExecutionResult":{"type":"object","properties":{"operations":{"type":"array","description":"Execution operations performed as part of the test","items":{"$ref":"#/definitions/TestExecutionOperationResult"}},"error":{"description":"The final error encountered during the test that resulted in test failure","$ref":"#/definitions/ErrorBody"},"finalResult":{"type":"object","description":"The final result of the test. This is the response that would be returned during normal action execution"},"success":{"type":"boolean","description":"Indicates whether or not the test was a success"}}},"ActionContractInput":{"type":"object","required":["input","output"],"properties":{"input":{"description":"Execution input contract","$ref":"#/definitions/PostInputContract"},"output":{"description":"Execution output contract","$ref":"#/definitions/PostOutputContract"}},"description":"Contract definition."},"PostInputContract":{"type":"object","required":["inputSchema"],"properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected requests/inputs."},"PostOutputContract":{"type":"object","required":["successSchema"],"properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected responses/outputs."},"UpdateDraftInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"version":{"type":"integer","format":"int32","description":"Version of current Draft"}},"description":"Definition of an Action Draft to be created or updated."},"PublishDraftInput":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","example":"If the current draft version is 2 and the current published version of Action is 33, then you would send 2 here. (Your draft will become published version 34)","description":"The current draft version."}},"description":"Draft to be published"},"DraftValidationResult":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates if configuration is valid"},"errors":{"type":"array","description":"List of errors causing validation failure","items":{"$ref":"#/definitions/ErrorBody"}}},"description":"Validation results"},"UpdateActionInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"version":{"type":"integer","format":"int32","description":"Version of this action"}}},"ActionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Action"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PostActionInput":{"type":"object","required":["category","config","contract","integrationId","name"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"integrationId":{"type":"string","description":"The ID of the integration this action is associated to"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"}},"description":"Definition of an Action to be created or updated."},"BotConnectorBot":{"type":"object","required":["id","versions"],"properties":{"id":{"type":"string","description":"The Botconnector Bot Id - this is configurable by the user when put"},"name":{"type":"string"},"description":{"type":"string","description":"An optional description of the bot. This can be up to 256 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"versions":{"type":"array","description":"This bots versions, limit of 50 per bot","items":{"$ref":"#/definitions/BotConnectorBotVersion"}},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A botConnector Bot Instance"},"BotConnectorBotVersion":{"type":"object","required":["intents","supportedLanguages","version"],"properties":{"version":{"type":"string","description":"The name of the version. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"supportedLanguages":{"type":"array","description":"The supported languages for this bot. EG 'en-us' or 'es', etc; These language codes are W3C language identification tags (ISO 639-1 for the language name and ISO 3166 for the country code)","items":{"type":"string"}},"intents":{"type":"array","description":"A list of potential intents this bot will return, limit of 50","items":{"$ref":"#/definitions/BotIntent"}}},"description":"A version description for a botConnector bot."},"BotIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of this intent. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"slots":{"type":"object","description":"Optional returned data values associated with this intent, limit of 50.","additionalProperties":{"$ref":"#/definitions/BotSlot"}}},"description":"A botConnector's bot intention"},"BotList":{"type":"object","required":["chatBots"],"properties":{"chatBots":{"type":"array","description":"A list of botConnector Bots. Max 50","items":{"$ref":"#/definitions/BotConnectorBot"}}},"description":"A list of BotConnectorBots"},"BotSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the slot. This can be up to 100 characters long and must be comprised of displayable characters without leading or trailing whitespace"},"type":{"type":"string","description":"The data type of the slot string, integer, decimal, duration, boolean, currency, datetime or the xxxCollection versions of those types"}},"description":"Description of a data value returned from an intent"},"BotConnectorBotSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BotSummary":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The name of the bot."},"id":{"type":"string","description":"The id of the bot."},"description":{"type":"string","description":"An optional description of the bot."},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true}},"description":"A summary description for a botConnector bot"},"BotConnectorBotVersionSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotVersionSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BotVersionSummary":{"type":"object","required":["id","name","version"],"properties":{"name":{"type":"string","description":"The name of the bot."},"id":{"type":"string","description":"The id of the bot."},"description":{"type":"string","description":"An optional description of the bot."},"botCompositeTag":{"type":"string","description":"A system-generated string that contains metadata about this bot.","readOnly":true},"version":{"type":"string","description":"The name of the version."}},"description":"A version summary for a botConnector bot."},"DialogflowAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow agent","items":{"type":"string"}},"intents":{"type":"array","description":"An array of Intents associated with this agent","items":{"$ref":"#/definitions/DialogflowIntent"}},"environments":{"type":"array","description":"Available environments for this agent","items":{"type":"string"}},"integration":{"description":"The Integration this Dialogflow agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowIntent":{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","description":"The intent name"},"parameters":{"type":"object","description":"An object mapping parameter names to Parameter objects","additionalProperties":{"$ref":"#/definitions/DialogflowParameter"}}}},"DialogflowParameter":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The parameter name"},"type":{"type":"string","description":"The parameter type"}}},"DialogflowProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"DialogflowAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to.","$ref":"#/definitions/DialogflowProject"},"description":{"type":"string","description":"A description of the Dialogflow agent."},"integration":{"description":"The Integration this Dialogflow agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialogflowCXAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow CX agent belongs to.","$ref":"#/definitions/DialogflowCXProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow CX agent. Each value will be a language code in the country-locale format. e.g. en-us, es-us, fr-ca, etc.","items":{"type":"string"}},"environments":{"type":"array","description":"Available environments for this CX agent.","items":{"$ref":"#/definitions/DialogflowCXEnvironment"}},"integration":{"description":"The Integration this Dialogflow CX agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXEnvironment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"DialogflowCXAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow CX agent belongs to.","$ref":"#/definitions/DialogflowCXProject"},"description":{"type":"string","description":"A description of the Dialogflow CX agent."},"integration":{"description":"The Integration this Dialogflow CX agent was referenced from.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowCXAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowCXAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexBot":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the Lex bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotAlias":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"bot":{"description":"The Lex bot this is an alias for","$ref":"#/definitions/LexBot"},"botVersion":{"type":"string","description":"The version of the Lex bot this alias points at"},"status":{"type":"string","description":"The status of the Lex bot alias","enum":["BUILDING","READY","FAILED","NOT_BUILT"]},"failureReason":{"type":"string","description":"If the status is FAILED, Amazon Lex explains why it failed to build the bot"},"language":{"type":"string","description":"The target language of the Lex bot","enum":["en-US"]},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexIntent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexIntent":{"type":"object","required":["name","slots","version"],"properties":{"name":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexSlot"}},"version":{"type":"string","description":"The intent version"}}},"LexSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"type":{"type":"string","description":"The slot type"},"priority":{"type":"integer","format":"int32","description":"The priority of the slot"}}},"LexBotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexV2Bot":{"type":"object","required":["botId","region"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"botId":{"type":"string","description":"Lex V2 bot Id"},"region":{"type":"string","description":"A region of the Lex V2 bot"},"description":{"type":"string","description":"A description of the Lex V2 bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexV2BotAlias":{"type":"object","required":["aliasId","region"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"region":{"type":"string","description":"The Lex V2 bot region"},"aliasId":{"type":"string","description":"The Lex V2 bot alias Id"},"bot":{"description":"The Lex V2 bot this is an alias for","$ref":"#/definitions/LexV2Bot"},"botVersion":{"type":"string","description":"The version of the Lex V2 bot this alias points at"},"status":{"type":"string","description":"The status of the Lex V2 bot alias","enum":["Creating","Available","Deleting","Failed"]},"language":{"type":"string","description":"The target language of the Lex V2 bot"},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexV2Intent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexV2Intent":{"type":"object","required":["intentId","intentName","slots"],"properties":{"intentName":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexV2Slot"}},"intentId":{"type":"string","description":"The intent id"}}},"LexV2Slot":{"type":"object","required":["slotId","slotName","slotTypeId","type"],"properties":{"slotName":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"slotId":{"type":"string","description":"The slot id"},"type":{"type":"string","description":"The slot type"},"slotTypeId":{"type":"string","description":"The slot type id"}}},"LexV2BotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexV2BotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexV2BotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexV2Bot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AsyncJob":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"state":{"type":"string","enum":["Running","Completed","Failed","Cancelled"]}}},"ComplexVariableInfo":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The variable type ID"},"name":{"type":"string","description":"The variable type display name"}},"description":"Variable type information about a complex type from the bot's definition"},"NuanceApplication":{"type":"object","required":["id","name","tag"],"properties":{"id":{"type":"string","description":"The application ID"},"tag":{"type":"string","description":"The application Tag"},"name":{"type":"string","description":"The application name"}},"description":"Model for a Nuance bot application"},"NuanceBot":{"type":"object","required":["application","geography","id","integrationId","name","nuanceEnvironment","nuanceOrganization"],"properties":{"id":{"type":"string","description":"Nuance bot Id"},"name":{"type":"string","description":"Nuance bot name"},"integrationId":{"type":"string","description":"The Integration Id for this bot"},"nuanceOrganization":{"description":"The Nuance Organization for this bot","$ref":"#/definitions/NuanceOrganization"},"application":{"description":"The Application for this bot","$ref":"#/definitions/NuanceApplication"},"nuanceEnvironment":{"description":"The environment of the Nuance bot","$ref":"#/definitions/NuanceEnvironment"},"geography":{"description":"The Geography of the Nuance bot","$ref":"#/definitions/NuanceGeography"},"credentials":{"type":"array","description":"client ID/Secret objects for the credentials that execute this Nuance bot","items":{"$ref":"#/definitions/NuanceBotCredentials"}},"variables":{"type":"array","description":"List of available variables in this Nuance bot. When querying, use the 'expand=variables' query param to populate this value","items":{"$ref":"#/definitions/NuanceBotVariable"}},"transferNodes":{"type":"array","description":"List of transferNodes in this Nuance bot. When querying, use the 'expand=transferNodes' query param to populate this value","items":{"$ref":"#/definitions/NuanceBotTransferNode"}},"locales":{"type":"array","description":"List of locales associated with this Nuance bot. Generally in the ISO format such as 'en-US'","items":{"type":"string"}},"channels":{"type":"array","description":"List of channels associated with this Nuance bot.","items":{"$ref":"#/definitions/NuanceChannel"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Model for a Nuance bot"},"NuanceBotCredentials":{"type":"object","required":["appId","clientId"],"properties":{"appId":{"type":"string","description":"The application ID"},"clientId":{"type":"string","description":"The credentials client ID"},"clientSecret":{"type":"string","description":"The credentials client secret"},"clientSecretProvided":{"type":"boolean","description":"True if the credentials secret is set (but not returned due to security reasons)"}},"description":"Model for a Nuance bot credentials"},"NuanceBotTransferNode":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","description":"The transfer node ID"},"name":{"type":"string","description":"The transfer node name"},"type":{"type":"string","description":"The transfer node type","enum":["End","Escalate"]},"description":{"type":"string","description":"The transfer node description"},"requestVariables":{"type":"array","description":"List of variables associated with this transfer node","items":{"$ref":"#/definitions/NuanceBotVariable"}}},"description":"Model for a Nuance bot transfer node"},"NuanceBotVariable":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The variable ID"},"name":{"type":"string","description":"The variable display name"},"description":{"type":"string","description":"The variable description"},"reserved":{"type":"boolean","description":"True if the variable is a reserved variable"},"simpleVariableInfo":{"type":"string","description":"The type information for this variable"},"complexGenericVariableInfo":{"description":"The type information for this variable","$ref":"#/definitions/ComplexVariableInfo"}},"description":"Model for a Nuance bot variable"},"NuanceChannel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The channel ID"},"name":{"type":"string","description":"The channel name"},"modes":{"type":"array","description":"Supported Channel Modes","items":{"type":"string"}},"color":{"type":"string","description":"The Channel Color"}},"description":"Model for a Nuance channel"},"NuanceEnvironment":{"type":"object","required":["environmentDesignation","id","name"],"properties":{"id":{"type":"string","description":"The environment ID"},"name":{"type":"string","description":"The environment name"},"environmentDesignation":{"type":"string","description":"The environment type, usually a value like SANDBOX or PRODUCTION"},"executionHost":{"type":"string","description":"The host used to execute this bot, similar to 'api.nuance.com:443'"}},"description":"Model for a Nuance bot environment"},"NuanceGeography":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The geography ID"},"name":{"type":"string","description":"The geography name"}},"description":"Model for a Nuance bot geography"},"NuanceOrganization":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The organization ID"},"name":{"type":"string","description":"The organization name"}},"description":"Model for a Nuance bot organization"},"NuanceBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NuanceBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Model for a paged listing of Nuance bots"},"BotExecutionConfiguration":{"type":"object","required":["botCredentials","botId","executionHost"],"properties":{"botId":{"type":"string","description":"The Nuance bot ID"},"executionHost":{"type":"string","description":"The hostname to use when contacting Nuance to execute this bot"},"botCredentials":{"description":"The bot's launch credentials","$ref":"#/definitions/NuanceBotCredentials"}},"description":"Model for setting the launch configuration for a Nuance bot available to Genesys Cloud"},"NuanceBotLaunchSettings":{"type":"object","required":["botExecutionConfigurations"],"properties":{"botExecutionConfigurations":{"type":"array","description":"The list of Nuance bots that are configured as available to the Genesys Cloud system","items":{"$ref":"#/definitions/BotExecutionConfiguration"}}},"description":"Model for setting the launch configuration for Nuance bots available to Genesys Cloud"},"SttEngineEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grammarBased":{"type":"boolean","description":"The STT engine is intended to be used for Grammars"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SttEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SttEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TtsEngineEntity":{"type":"object","required":["languages","outputFormats"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languages":{"type":"array","description":"The set of languages the TTS engine supports","items":{"type":"string"}},"outputFormats":{"type":"array","description":"The set of output formats the TTS engine can produce","items":{"type":"string"}},"voices":{"type":"array","description":"The set of voices the TTS engine supports","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"isDefault":{"type":"boolean","description":"The TTS engine is the global default engine"},"isSecure":{"type":"boolean","description":"The TTS engine can be used in a secure call flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsVoiceEntity":{"type":"object","required":["engine","gender","language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"gender":{"type":"string","description":"The gender of the TTS voice"},"language":{"type":"string","description":"The language supported by the TTS voice"},"engine":{"description":"Ths TTS engine this voice belongs to","$ref":"#/definitions/TtsEngineEntity"},"isDefault":{"type":"boolean","description":"The voice is the default voice for its language"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LanguageOverride":{"type":"object","required":["engine","language","voice"],"properties":{"language":{"type":"string","description":"The language code of the language being overridden"},"engine":{"type":"string","description":"The ID of the TTS engine to use for this language override"},"voice":{"type":"string","description":"The ID of the voice to use for this language override. The voice must be supported by the chosen engine."}}},"TtsSettings":{"type":"object","required":["defaultEngine","languageOverrides"],"properties":{"defaultEngine":{"type":"string","description":"ID of the global default TTS engine"},"languageOverrides":{"type":"array","description":"The list of default overrides for specific languages","items":{"$ref":"#/definitions/LanguageOverride"}}}},"TtsVoiceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"triggerWithOutcomePercentileConditions":{"type":"array","description":"(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomePercentileCondition"}},"triggerWithOutcomeQuantileConditions":{"type":"array","description":"Quantile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeQuantileCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/ActionMapAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/ActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ActionMapAction":{"type":"object","properties":{"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"actionTargetId":{"type":"string","description":"Action target ID."},"isPacingEnabled":{"type":"boolean","description":"Whether this action should be throttled."},"props":{"description":"Additional properties.","$ref":"#/definitions/ActionProperties"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"},"webMessagingOfferFields":{"description":"Admin-configurable fields of a web messaging offer action.","$ref":"#/definitions/WebMessagingOfferFields"},"openActionFields":{"description":"Admin-configurable fields of an open action.","$ref":"#/definitions/OpenActionFields"}}},"ActionMapActionTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapScheduleGroup":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the action maps's associated schedule group."}}},"ActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"ActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/ActionSurvey"}}},"ActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/JourneySurveyQuestion"}}}},"Activation":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of activation."},"delayInSeconds":{"type":"integer","format":"int32","description":"Activation delay time amount."}}},"ArchitectFlowFields":{"type":"object","properties":{"architectFlow":{"description":"The architect flow.","$ref":"#/definitions/AddressableEntityRef"},"flowRequestMappings":{"type":"array","description":"Collection of Architect Flow Request Mappings to use.","items":{"$ref":"#/definitions/RequestMapping"}}}},"EventCondition":{"type":"object","required":["key","sessionType","streamType","values"],"properties":{"key":{"type":"string","description":"The event key."},"values":{"type":"array","description":"The event values.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"streamType":{"type":"string","description":"The stream type for which this condition can be satisfied.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this condition can be satisfied."},"eventName":{"type":"string","description":"The name of the event for which this condition can be satisfied."}}},"JourneySurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"OpenActionFields":{"type":"object","required":["openAction"],"properties":{"openAction":{"description":"The specific type of the open action.","$ref":"#/definitions/DomainEntityRef"},"configurationFields":{"type":"object","description":"Custom fields defined in the schema referenced by the open action type selected.","additionalProperties":{"type":"object"}}}},"OutcomePercentileCondition":{"type":"object","required":["maximumPercentile","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumPercentile":{"type":"number","format":"float","description":"Percentile value for the selected outcome, at or above which the action map will trigger."},"fallbackPercentile":{"type":"number","format":"float","description":"Additional percentile condition, where if set, the action map will trigger if the current outcome percentile is lower or equal to the value."}}},"OutcomeProbabilityCondition":{"type":"object","required":["maximumProbability","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."}}},"OutcomeQuantileCondition":{"type":"object","required":["maxQuantileThreshold","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maxQuantileThreshold":{"type":"number","format":"float","description":"This Outcome Quantile Condition is met when sessionMaxQuantile of the OutcomeScore is above this value, (unless fallbackQuantile is set). Range 0.00-1.00"},"fallbackQuantileThreshold":{"type":"number","format":"float","description":"(Optional) If set, this Condition is met when maxQuantileThreshold is met, AND the current quantile of the OutcomeScore is below this fallbackQuantileThreshold. Range 0.00-1.00"}}},"RequestMapping":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Integration Action Attribute to supply the value for"},"attributeType":{"type":"string","description":"Type of the value supplied","enum":["String","Number","Integer","Boolean"]},"mappingType":{"type":"string","description":"Method of finding value to use with Attribute","enum":["Lookup","HardCoded"]},"value":{"type":"string","description":"Value to supply for the specified Attribute"}}},"UrlCondition":{"type":"object","required":["operator","values"],"properties":{"values":{"type":"array","description":"The URL condition value.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"WebMessagingOfferFields":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."},"architectFlow":{"description":"Flow to be invoked, overrides default flow when specified.","$ref":"#/definitions/AddressableEntityRef"}}},"PatchAction":{"type":"object","required":["mediaType"],"properties":{"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"actionTargetId":{"type":"string","description":"Action target ID."},"isPacingEnabled":{"type":"boolean","description":"Whether this action should be throttled."},"props":{"description":"Additional properties.","$ref":"#/definitions/PatchActionProperties"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"},"webMessagingOfferFields":{"description":"Admin-configurable fields of a web messaging offer action.","$ref":"#/definitions/PatchWebMessagingOfferFields"},"openActionFields":{"description":"Admin-configurable fields of an open action.","$ref":"#/definitions/OpenActionFields"}}},"PatchActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"triggerWithOutcomePercentileConditions":{"type":"array","description":"(deprecated - use triggerWithOutcomeQuantileConditions instead) Percentile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomePercentileCondition"}},"triggerWithOutcomeQuantileConditions":{"type":"array","description":"Quantile conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeQuantileCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/PatchAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/PatchActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"PatchActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/PatchActionSurvey"}}},"PatchActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/PatchSurveyQuestion"}}}},"PatchSurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"PatchWebMessagingOfferFields":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."},"architectFlow":{"description":"Flow to be invoked, overrides default flow when specified.","$ref":"#/definitions/AddressableEntityRef"}}},"ActionMapListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionMap"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userData":{"type":"array","description":"Additional user data associated with the target in key/value format.","items":{"$ref":"#/definitions/KeyValue"}},"supportedMediaTypes":{"type":"array","description":"Supported media types of the target.","items":{"type":"string","enum":["callback","call","email","generic","messaging","social","webchat"]}},"state":{"type":"string","description":"Indicates the state of the target.","enum":["active","inactive","deleted"]},"description":{"type":"string","description":"Description of the target."},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"KeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for free-form data."},"value":{"type":"string","description":"Value for free-form data."}}},"PatchActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddressableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionTargetListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTarget"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTemplate":{"type":"object","required":["mediaType","name","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"version":{"type":"integer","format":"int32","description":"The version of the action template.","readOnly":true},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/ContentOffer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when action template was created in ISO-8601 format.","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when action template was last modified in ISO-8601 format.","readOnly":true}}},"CallToAction":{"type":"object","required":["url"],"properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"]}}},"CloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"ContentOffer":{"type":"object","required":["displayMode","layoutMode"],"properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/CallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/ContentOfferStylingConfiguration"}}},"ContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"ContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/ContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/ContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/CloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/CtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/TextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/TextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/TextStyleProperties"}}},"ContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"CtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #FF0000)"}}},"IntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/IntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"TextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]}}},"PatchActionTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"version":{"type":"integer","format":"int32","description":"The version of the action template."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/PatchContentOffer"}}},"PatchCallToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"]}}},"PatchCloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"PatchContentOffer":{"type":"object","properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/PatchCallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/PatchContentOfferStylingConfiguration"}}},"PatchContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"PatchContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/PatchContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/PatchContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/PatchCloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/PatchCtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/PatchTextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/PatchTextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/PatchTextStyleProperties"}}},"PatchContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"PatchCtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #A04033)"}}},"PatchIntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration action to be invoked."}}},"PatchIntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/PatchIntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"PatchTextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"]}}},"ActionTemplateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionMapEstimateResult":{"type":"object","properties":{"qualifiedSessionCount":{"type":"integer","format":"int32","description":"Number of sessions qualified for Action map."},"totalSessionCount":{"type":"integer","format":"int32","description":"Total number of sessions."},"perSegmentCounts":{"type":"array","description":"Number of sessions qualified for Action map per segment.","items":{"$ref":"#/definitions/SegmentEstimateCount"}},"outcomesScoresCount":{"type":"integer","format":"int32","description":"Difference made by outcome criteria to number of sessions qualified for Action map."}}},"SegmentEstimateCount":{"type":"object","properties":{"segmentId":{"type":"string","description":"ID of Segment."},"count":{"type":"integer","format":"int32","description":"Estimate count per segment."}}},"EstimateJobAsyncResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapEstimateOutcomeCriteria":{"type":"object","required":["outcomeId"],"properties":{"outcomeId":{"type":"string","description":"ID of outcome."},"maxProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."},"quantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted probability."},"maxQuantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted session max probability."}}},"ActionMapEstimateRequest":{"type":"object","properties":{"segmentIds":{"type":"array","description":"List of Segment IDs.","items":{"type":"string"}},"outcomeCriteria":{"description":"Outcome Criteria containing outcomeId and probability thresholds.","$ref":"#/definitions/ActionMapEstimateOutcomeCriteria"}}},"FlowPaths":{"type":"object","required":["category","elements"],"properties":{"category":{"type":"string","description":"Category (use case) of the paths within a given domain.","enum":["All","Abandoned","AgentEscalation","Complete","Disconnect","Error","RecognitionFailure","Transfer"]},"elements":{"type":"object","description":"Unique element identifiers and their corresponding elements in the trie data structure representing the paths.","additionalProperties":{"$ref":"#/definitions/FlowPathsElement"}}}},"FlowPathsElement":{"type":"object","required":["count","flows","type"],"properties":{"parentId":{"type":"string","description":"Unique identifier of the parent element. Will be null for the root element."},"type":{"type":"string","description":"Type of the element.","enum":["Abandoned","AgentEscalation","Disconnect","Error","Exit","Milestone","Outcome","RecognitionFailure","Root","TransferToAcd"]},"count":{"type":"integer","format":"int32","description":"Count of all journeys that include this element."},"flows":{"type":"array","description":"Details of flows involved in journeys that include this element.","items":{"$ref":"#/definitions/FlowPathsFlowDetails"}},"flowOutcomeValue":{"type":"string","description":"The value of the flow outcome, if the element type is Outcome.","enum":["FAILURE","SUCCESS","UNKNOWN"]},"flowMilestone":{"description":"The flow milestone, set if the element type is Milestone.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flowOutcome":{"description":"The flow outcome, set if the element type is Outcome or Milestone.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"FlowPathsFlowDetails":{"type":"object","required":["count","flow","type","version"],"properties":{"version":{"type":"string","description":"The version of the flow."},"type":{"type":"string","description":"The type of the flow.","enum":["DigitalBot","Bot","InboundCall","SecureCall","InboundShortMessage","InboundEmail","OutboundCall"]},"count":{"type":"integer","format":"int32","description":"Count of all journeys that include this element in the given flow."},"flow":{"description":"The identifier of the flow.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"FlowPathsFlowFilter":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the flow."}}},"FlowPathsQuery":{"type":"object","required":["category","flows"],"properties":{"category":{"type":"string","description":"Category (use case) of the paths within a given domain.","enum":["All","Abandoned","AgentEscalation","Complete","Disconnect","Error","RecognitionFailure","Transfer"]},"flows":{"type":"array","description":"List of flows to query the paths result.","items":{"$ref":"#/definitions/FlowPathsFlowFilter"}}}},"AssociatedValueField":{"type":"object","required":["dataType","name"],"properties":{"dataType":{"type":"string","description":"The data type of the value field.","enum":["Number","Integer"]},"name":{"type":"string","description":"The field name for extracting value from event."}}},"Context":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/ContextPattern"}}}},"ContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/EntityTypeCriteria"}}}},"Criteria":{"type":"object","required":["key","operator","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"EntityTypeCriteria":{"type":"object","required":["entityType","key","operator","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"Journey":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/JourneyPattern"}}}},"JourneyPattern":{"type":"object","required":["count","criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/Criteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"Outcome":{"type":"object","required":["context","createdDate","displayName","id","isActive","isPositive","journey","modifiedDate","version"],"properties":{"id":{"type":"string","description":"ID of the outcome."},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/AssociatedValueField"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchAssociatedValueField":{"type":"object","properties":{"dataType":{"type":"string","description":"The data type of the value field.","enum":["Number","Integer"]},"name":{"type":"string","description":"The field name for extracting value from event."}}},"PatchContext":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/PatchContextPattern"}}}},"PatchContextPattern":{"type":"object","properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/PatchEntityTypeCriteria"}}}},"PatchCriteria":{"type":"object","properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"PatchEntityTypeCriteria":{"type":"object","properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"PatchJourney":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/PatchJourneyPattern"}}}},"PatchJourneyPattern":{"type":"object","properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/PatchCriteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"PatchOutcome":{"type":"object","required":["displayName"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/PatchContext"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/PatchJourney"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/PatchAssociatedValueField"}}},"OutcomeRequest":{"type":"object","required":["displayName"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/RequestContext"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/RequestJourney"},"associatedValueField":{"description":"The field from the event indicating the associated value.","$ref":"#/definitions/AssociatedValueField"}}},"RequestContext":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/RequestContextPattern"}}}},"RequestContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/RequestEntityTypeCriteria"}}}},"RequestCriteria":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]}}},"RequestEntityTypeCriteria":{"type":"object","required":["entityType","key","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"]}}},"RequestJourney":{"type":"object","properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/RequestJourneyPattern"}}}},"RequestJourneyPattern":{"type":"object","required":["count","criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/RequestCriteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation","App"]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"OutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Outcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutcomeScore":{"type":"object","properties":{"outcome":{"description":"The outcome that the score was calculated for.","$ref":"#/definitions/AddressableEntityRef"},"sessionMaxProbability":{"type":"number","format":"float","description":"Represents the max probability reached in the session."},"probability":{"type":"number","format":"float","description":"Represents the likelihood of a customer reaching or achieving a given outcome."},"percentile":{"type":"integer","format":"int32","description":"(Deprecated: use the 'quantile' field instead) Represents the predicted probability's percentile score when compared with all other generated probabilities for a given outcome."},"sessionMaxPercentile":{"type":"integer","format":"int32","description":"(Deprecated: use the 'quantile' field instead) Represents the maximum likelihood percentile score reached for a given outcome by the current session."},"quantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted probability."},"sessionMaxQuantile":{"type":"number","format":"float","description":"Represents the quantity of sessions that have a maximum probability less than the predicted session max probability."}}},"OutcomeScoresResult":{"type":"object","properties":{"outcomeScores":{"type":"array","description":"List of scored outcomes in the session.","items":{"$ref":"#/definitions/OutcomeScore"}},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating the last time that the event was scored. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"OutcomePredictor":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"outcome":{"description":"The outcome for which this predictor will provide predictions.","$ref":"#/definitions/OutcomeRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeRef":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomePredictorRequest":{"type":"object","required":["outcome"],"properties":{"outcome":{"description":"The outcome for which this predictor will provide predictions.","$ref":"#/definitions/OutcomeRefRequest"}}},"OutcomeRefRequest":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of outcome."}}},"OutcomePredictorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomePredictor"}}}},"ExternalSegment":{"type":"object","required":["id","name","source"],"properties":{"id":{"type":"string","description":"Identifier for the external segment in the system where it originates from."},"name":{"type":"string","description":"Name for the external segment in the system where it originates from."},"source":{"type":"string","description":"The external system where the segment originates from.","enum":["AdobeExperiencePlatform","Custom"]}}},"JourneySegment":{"type":"object","required":["color","context","createdDate","displayName","id","isActive","journey","modifiedDate","scope","shouldDisplayToAgent","version"],"properties":{"id":{"type":"string","description":"The ID of the segment."},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/ExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchExternalSegment":{"type":"object","properties":{"name":{"type":"string","description":"Name for the external segment in the system where it originates from."}}},"PatchSegment":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/PatchContext"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/PatchJourney"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/PatchExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."}}},"JourneySegmentRequest":{"type":"object","required":["color","context","displayName","journey"],"properties":{"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/RequestContext"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/RequestJourney"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/RequestExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."}}},"RequestExternalSegment":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Identifier for the external segment in the system where it originates from."},"name":{"type":"string","description":"Name for the external segment in the system where it originates from."},"source":{"type":"string","description":"The external system where the segment originates from.","enum":["AdobeExperiencePlatform","Custom"]}}},"SegmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneySegment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CategoryReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the category."},"name":{"type":"string","description":"Category name."},"parentCategory":{"description":"The reference to category to which this category belongs to.","$ref":"#/definitions/CategoryReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"description":{"type":"string"},"externalId":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"parentCategory":{"description":"The reference to category to which this category belongs to.","$ref":"#/definitions/CategoryReference"},"documentCount":{"type":"integer","format":"int32","description":"Number of documents assigned to this category."},"knowledgeBase":{"description":"The reference to knowledge base to which the category belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CategoryResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"CategoryCreateRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"parentCategoryId":{"type":"string"},"description":{"type":"string","description":"The description for the category."},"externalId":{"type":"string","description":"The external id associated with the category."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CategoryUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the category."},"parentCategoryId":{"type":"string","description":"The category to which this category belongs."},"description":{"type":"string"},"externalId":{"type":"string","description":"The external id associated with the category."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArticleContent":{"type":"object","properties":{"body":{"description":"Body of the article content.","readOnly":true,"$ref":"#/definitions/ArticleContentBody"}}},"ArticleContentBody":{"type":"object","properties":{"locationUrl":{"type":"string","description":"Presigned URL to retrieve the document content.","readOnly":true}}},"DocumentArticle":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"The title of the Article."},"content":{"description":"The content of the Article.","readOnly":true,"$ref":"#/definitions/ArticleContent"},"alternatives":{"type":"array","description":"List of Alternative questions related to the title which helps in improving the likelihood of a match to user query.","items":{"type":"string"}}}},"DocumentFaq":{"type":"object","required":["answer","question"],"properties":{"question":{"type":"string","description":"The question for this FAQ"},"answer":{"type":"string","description":"The answer for this FAQ"},"alternatives":{"type":"array","description":"List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query","items":{"type":"string"}}}},"KnowledgeBase":{"type":"object","required":["coreLanguage"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-US","description":"Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy.","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"dateCreated":{"type":"string","format":"date-time","description":"Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"faqCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type FAQ in the KnowledgeBase","readOnly":true},"dateDocumentLastModified":{"type":"string","format":"date-time","description":"The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"articleCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type Article in the KnowledgeBase","readOnly":true},"published":{"type":"boolean","description":"Flag that indicates the knowledge base is published","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchDocumentV1":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"type":{"type":"string","description":"Document type","enum":["Faq","Article"]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"article":{"description":"Article","$ref":"#/definitions/DocumentArticle"},"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchResponse":{"type":"object","properties":{"searchId":{"type":"string","description":"Search Id","readOnly":true},"total":{"type":"integer","format":"int32","description":"Total number of records returned","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"pageSize":{"type":"integer","format":"int32","description":"Number of records according to the page size","readOnly":true},"pageNumber":{"type":"integer","format":"int32","description":"Current page number for the returned records","readOnly":true},"results":{"type":"array","description":"Results associated to the search response","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeSearchDocumentV1"}}}},"KnowledgeSearchRequest":{"type":"object","required":["languageCode","query"],"properties":{"query":{"type":"string","description":"Input query to search content in the knowledge base"},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results"},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results"},"documentType":{"type":"string","description":"Document type to be used while searching","enum":["Faq","Article"]},"languageCode":{"type":"string","description":"query search for specific languageCode"},"searchOnDraftDocuments":{"type":"boolean","description":"If true the search query will be executed on draft documents, else it will be on active documents"}}},"CategoryListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeExtendedCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"parent":{"description":"Category parent","readOnly":true,"$ref":"#/definitions/KnowledgeCategory"},"children":{"type":"array","description":"Category children","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeCategory"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentCategoryInput":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"KnowledgeBase Category ID"}}},"KnowledgeCategoryRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"parent":{"description":"Category parent","$ref":"#/definitions/DocumentCategoryInput"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ImportError":{"type":"object","properties":{"message":{"type":"string"},"line":{"type":"integer","format":"int32"}}},"ImportReport":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/ImportError"}},"validated":{"$ref":"#/definitions/ResultCounters"},"imported":{"$ref":"#/definitions/ResultCounters"},"totalDocuments":{"type":"integer","format":"int32"}}},"KnowledgeImport":{"type":"object","required":["fileType","uploadKey"],"properties":{"id":{"type":"string","description":"Id of the import operation","readOnly":true},"name":{"type":"string","description":"Name of the import operation"},"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"file type of the document","enum":["Csv","JsonLines"]},"ignoreHeaders":{"type":"boolean","description":"Ignore headers for the specified file"},"status":{"type":"string","description":"Status of the operation","readOnly":true,"enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the import operation","readOnly":true,"$ref":"#/definitions/ImportReport"},"knowledgeBase":{"description":"Knowledge base which document import does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Language code","readOnly":true,"enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResultCounters":{"type":"object","properties":{"success":{"type":"integer","format":"int32"},"failure":{"type":"integer","format":"int32"}}},"ImportStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"New status for existing import operation"}}},"KnowledgeDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]},"type":{"type":"string","description":"Document type","enum":["Faq","Article"]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"article":{"description":"Article","$ref":"#/definitions/DocumentArticle"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq","Article"]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"article":{"description":"Article details","$ref":"#/definitions/DocumentArticle"}}},"DocumentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocument"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentBulkRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq","Article"]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"article":{"description":"Article details","$ref":"#/definitions/DocumentArticle"},"id":{"type":"string","description":"Identifier of document for update. Omit for create new Document."}}},"KnowledgeBaseUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"Knowledge base name"},"description":{"type":"string","description":"Knowledge base description"}}},"KnowledgeBaseCreateRequest":{"type":"object","required":["coreLanguage","name"],"properties":{"name":{"type":"string","description":"Knowledge base name"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-US","description":"Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy.","enum":["en-US","en-UK","en-AU","en-CA","en-HK","en-IN","en-IE","en-NZ","en-PH","en-SG","en-ZA","de-DE","de-AT","de-CH","es-AR","es-CO","es-MX","es-US","es-ES","fr-FR","fr-BE","fr-CA","fr-CH","pt-BR","pt-PT","nl-NL","nl-BE","it-IT","ca-ES","tr-TR","sv-SE","fi-FI","nb-NO","da-DK","ja-JP","ar-AE","zh-CN","zh-TW","zh-HK","ko-KR","pl-PL","hi-IN","th-TH","hu-HU","vi-VN","uk-UA"]}}},"KnowledgeBaseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeBase"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeGroupStatistics":{"type":"object","properties":{"unlinkedPhraseCount":{"type":"integer","format":"int32","description":"Knowledge Group unique phrase count"},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Knowledge Group unlinked phrases hit count"},"totalPhraseHitCount":{"type":"integer","format":"int32","description":"Total number of phrase hit counts of an unanswered group"}}},"UnansweredGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"label":{"type":"string","description":"Knowledge base unanswered group label"},"phraseGroups":{"type":"array","description":"Represents a list of phrase groups inside an unanswered group","items":{"$ref":"#/definitions/UnansweredPhraseGroup"}},"suggestedDocuments":{"type":"array","description":"Represents a list of documents that may be linked to an unanswered group","items":{"$ref":"#/definitions/UnansweredGroupSuggestedDocument"}},"statistics":{"description":"Statistics object containing the various hit counts for an unanswered group","$ref":"#/definitions/KnowledgeGroupStatistics"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnansweredGroupSuggestedDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnansweredGroups":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnansweredGroup"}}}},"UnansweredPhrase":{"type":"object","properties":{"id":{"type":"string","description":"Id of an unanswered phrase"},"text":{"type":"string","description":"Phrase text of an unanswered phrase"},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Hit count of an unlinked phrase"}}},"UnansweredPhraseGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"label":{"type":"string","description":"Knowledge base phrase group label"},"phrases":{"type":"array","description":"List of unanswered phrases in a phrase group","items":{"$ref":"#/definitions/UnansweredPhrase"}},"unlinkedPhraseHitCount":{"type":"integer","format":"int32","description":"Hit count of the unlinked phrase group"},"unlinkedPhraseCount":{"type":"integer","format":"int32","description":"Unique phrase count of the unlinked phrase group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhraseAssociations":{"type":"object","required":["documentId","phraseId"],"properties":{"phraseId":{"type":"string","description":"Id of the phrase to be linked"},"documentId":{"type":"string","description":"Id of the document to be linked"}}},"UnansweredPhraseGroupUpdateResponse":{"type":"object","properties":{"phraseAssociations":{"type":"array","description":"List of phrases and documents linked in the patch request","items":{"$ref":"#/definitions/PhraseAssociations"}},"group":{"description":"Knowledge base unanswered group response","$ref":"#/definitions/UnansweredGroup"}}},"UnansweredPhraseGroupPatchRequestBody":{"type":"object","required":["phraseAssociations"],"properties":{"phraseAssociations":{"type":"array","description":"List of phrases and documents to be linked","items":{"$ref":"#/definitions/PhraseAssociations"}},"dateStart":{"type":"string","format":"date","description":"The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"LabelResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color of the label."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The last modification date and time of the label. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentCount":{"type":"integer","format":"int32","description":"Number of documents assigned to this label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LabelUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color for the label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LabelListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LabelResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"LabelCreateRequest":{"type":"object","required":["color","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the label."},"color":{"type":"string","description":"The color for the label."},"externalId":{"type":"string","description":"The external id associated with the label."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeOperationSource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeTraining":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateTriggered":{"type":"string","format":"date-time","description":"Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Training status.","readOnly":true,"enum":["Queued","InProgress","Succeeded","Failed"]},"languageCode":{"type":"string","description":"Language of the documents that are trained.","readOnly":true},"knowledgeBase":{"description":"Knowledge Base that the training belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"errorMessage":{"type":"string","description":"Any error message during the Training or Promote action.","readOnly":true},"knowledgeDocumentsState":{"type":"string","description":"State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.","readOnly":true,"enum":["Draft","Active","Discarded","Archived"]},"datePromoted":{"type":"string","format":"date-time","description":"Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrainingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeTraining"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"DocumentBodyBlockWithHighlight":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Image","Video","OrderedList","UnorderedList","Table"]},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"}}},"DocumentBodyImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL for the image."},"hyperlink":{"type":"string","description":"The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label//"},"properties":{"description":"The properties for the image.","$ref":"#/definitions/DocumentBodyImageProperties"}}},"DocumentBodyImageProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color property for the image. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align property for the image.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation property for the image. The valid values in 'em'."}}},"DocumentBodyList":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlock"}},"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"}}},"DocumentBodyListBlock":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlock"}},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"}}},"DocumentBodyListBlockProperties":{"type":"object","properties":{"unorderedType":{"type":"string","description":"The type of icon for the unordered list.","enum":["Normal","Square","Circle","None"]},"orderedType":{"type":"string","description":"The type of icon for the ordered list.","enum":["Number","LowerAlpha","LowerGreek","LowerRoman","UpperAlpha","UpperRoman","None"]}}},"DocumentBodyListItemProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color for the list item. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the list item.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation property for the list item. The valid values in 'em'."},"fontSize":{"type":"string","description":"The font size for the list item. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"fontType":{"type":"string","description":"The font type for the list item.","enum":["Paragraph","Heading1","Heading2","Heading3","Heading4","Heading5","Heading6","Preformatted"]},"textColor":{"type":"string","description":"The text color for the list item. The valid values in hex color code representation. For example black color - #000000"},"unorderedType":{"type":"string","description":"The type of icon for the unordered list.","enum":["Normal","Square","Circle","None"]},"orderedType":{"type":"string","description":"The type of icon for the ordered list.","enum":["Number","LowerAlpha","LowerGreek","LowerRoman","UpperAlpha","UpperRoman","None"]}}},"DocumentBodyParagraph":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of blocks for the paragraph.","items":{"$ref":"#/definitions/DocumentContentBlock"}},"properties":{"description":"The properties for the paragraph.","$ref":"#/definitions/DocumentBodyParagraphProperties"}}},"DocumentBodyParagraphProperties":{"type":"object","properties":{"fontSize":{"type":"string","description":"The font size for the paragraph. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"fontType":{"type":"string","description":"The font type for the paragraph.","enum":["Paragraph","Heading1","Heading2","Heading3","Heading4","Heading5","Heading6","Preformatted"]},"textColor":{"type":"string","description":"The text color for the paragraph. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the paragraph. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the paragraph.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation color for the paragraph. The valid values in 'em'."}}},"DocumentBodyParagraphWithHighlight":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of blocks for the paragraph.","items":{"$ref":"#/definitions/DocumentContentBlockWithHighlight"}},"properties":{"description":"The properties for the paragraph.","$ref":"#/definitions/DocumentBodyParagraphProperties"}}},"DocumentBodyTable":{"type":"object","required":["rows"],"properties":{"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlock"}},"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"}}},"DocumentBodyTableCaptionBlock":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the caption property.","items":{"$ref":"#/definitions/DocumentBodyTableCaptionItem"}}}},"DocumentBodyTableCaptionItem":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the caption item.","enum":["Text","Paragraph","Image","Video","OrderedList","UnorderedList"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"}}},"DocumentBodyTableCellBlock":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlock"}},"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"}}},"DocumentBodyTableCellBlockProperties":{"type":"object","properties":{"cellType":{"type":"string","description":"The type of the table cell.","enum":["Cell","HeaderCell"]},"width":{"type":"number","format":"float","description":"The width for the table cell."},"height":{"type":"number","format":"float","description":"The height for the table cell."},"horizontalAlign":{"type":"string","description":"The horizontal alignment for the table cell.","enum":["Center","Left","Right"]},"verticalAlign":{"type":"string","description":"The vertical alignment for the table cell.","enum":["Top","Middle","Bottom"]},"borderWidth":{"type":"number","format":"float","description":"The border width for the table cell. The valid values in 'em'"},"borderStyle":{"type":"string","description":"The border style for the table cell.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table cell. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table cell. For example black color - #000000"},"scope":{"type":"string","description":"The scope for the table cell.","enum":["Row","Column","RowGroup","ColumnGroup","None"]},"colSpan":{"type":"integer","format":"int32","description":"The colSpan for the table cell."},"rowSpan":{"type":"integer","format":"int32","description":"The rowSpan for the table cell."}}},"DocumentBodyTableProperties":{"type":"object","properties":{"width":{"type":"number","format":"float","description":"The width for the table. The valid values in 'em'."},"height":{"type":"number","format":"float","description":"The height for the table."},"cellSpacing":{"type":"number","format":"float","description":"The cell spacing for the table. The valid values in 'em'."},"cellPadding":{"type":"number","format":"float","description":"The cell padding for the table. The valid values in 'em'."},"borderWidth":{"type":"number","format":"float","description":"The border width for the table. The valid values in 'em'"},"alignment":{"type":"string","description":"The alignment for the table.","enum":["Center","Left","Right"]},"borderStyle":{"type":"string","description":"The border style for the table.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table. The valid values in hex color code representation. For example black color - #000000"},"caption":{"description":"The caption for the table. The valid values in hex color code representation. For example black color - #000000","$ref":"#/definitions/DocumentBodyTableCaptionBlock"}}},"DocumentBodyTableRowBlock":{"type":"object","required":["cells"],"properties":{"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlock"}},"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"}}},"DocumentBodyTableRowBlockProperties":{"type":"object","properties":{"rowType":{"type":"string","description":"The type of the table row.","enum":["Header","Footer","Body"]},"alignment":{"type":"string","description":"The alignment for the table row.","enum":["Center","Left","Right"]},"height":{"type":"number","format":"float","description":"The height for the table row."},"borderStyle":{"type":"string","description":"The border style for the table row.","enum":["Solid","Dotted","Dashed","Double","Groove","Ridge","Inset","Outset","Hidden","None"]},"borderColor":{"type":"string","description":"The border color for the table row. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the table row. For example black color - #000000"}}},"DocumentBodyVideo":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL for the video."},"properties":{"description":"The properties for the video.","$ref":"#/definitions/DocumentBodyVideoProperties"}}},"DocumentBodyVideoProperties":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The background color for the video. The valid values in hex color code representation. For example black color - #000000"},"align":{"type":"string","description":"The align type for the video.","enum":["Center","Left","Right","Justify"]},"indentation":{"type":"number","format":"float","description":"The indentation for the video. The valid values in 'em'."}}},"DocumentBodyWithHighlight":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlockWithHighlight"}}}},"DocumentContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the paragraph block.","enum":["Text","Image","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"}}},"DocumentContentBlockWithHighlight":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the paragraph block.","enum":["Text","Image","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"DocumentContentHighlightIndex":{"type":"object","properties":{"startIndex":{"type":"integer","format":"int32","description":"Highlight text start index."},"endIndex":{"type":"integer","format":"int32","description":"Highlight text end index."}}},"DocumentListContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["Text","Image","OrderedList","UnorderedList","Video"]},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"}}},"DocumentTableContentBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the table cell. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Text","Image","Video","OrderedList","UnorderedList","Table"]},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"text":{"description":"Text. It must contain a value if the type of the block is Text.","$ref":"#/definitions/DocumentText"},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if the type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"}}},"DocumentText":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Text."},"marks":{"type":"array","description":"The unique list of marks (whether it is bold and/or underlined etc.) for the text.","uniqueItems":true,"items":{"type":"string","enum":["Bold","Italic","Underline","Strikethrough","Subscript","Superscript"]}},"hyperlink":{"type":"string","description":"The URL of the page OR an email OR the reference to the knowledge article that the hyperlink goes to. Possible URL value types are https:// | mailto: | grn:knowledge:::documentVariation/// | grn:knowledge:::document// | grn:knowledge:::category// | grn:knowledge:::label//"},"properties":{"description":"The properties for the text.","$ref":"#/definitions/DocumentTextProperties"}}},"DocumentTextProperties":{"type":"object","properties":{"fontSize":{"type":"string","description":"The font size for the text. The valid values in 'em'.","enum":["XxSmall","XSmall","Small","Medium","Large","XLarge","XxLarge","XxxLarge"]},"textColor":{"type":"string","description":"The text color for the text. The valid values in hex color code representation. For example black color - #000000"},"backgroundColor":{"type":"string","description":"The background color for the text. The valid values in hex color code representation. For example black color - #000000"}}},"DocumentVariationAnswer":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBodyWithHighlight"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentVariationContext":{"type":"object","required":["context","values"],"properties":{"context":{"description":"The knowledge context associated with the variation.","$ref":"#/definitions/KnowledgeContextReference"},"values":{"type":"array","description":"The list of knowledge context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeContextValueReference"}}}},"KnowledgeContextReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge context."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeContextValueReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge context value."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentReference":{"type":"object","required":["id","knowledgeBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document."},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentBody":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentBodyBlock":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the block for the body. This determines which body block object (paragraph, list, video, image or table) would have a value.","enum":["Paragraph","Image","Video","OrderedList","UnorderedList","Table"]},"image":{"description":"Image. It must contain a value if the type of the block is Image.","$ref":"#/definitions/DocumentBodyImage"},"video":{"description":"Video. It must contain a value if the type of the block is Video.","$ref":"#/definitions/DocumentBodyVideo"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyList"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTable"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"}}},"DocumentVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentAlternative":{"type":"object","required":["autocomplete","phrase"],"properties":{"phrase":{"type":"string","description":"Alternate phrasing to the document title, having a limit of 500 words."},"autocomplete":{"type":"boolean","description":"Autocomplete enabled for the alternate phrase."}}},"KnowledgeDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"category":{"description":"The reference to category associated with the document.","$ref":"#/definitions/CategoryResponse"},"labels":{"type":"array","description":"The references to labels associated with the document.","items":{"$ref":"#/definitions/LabelResponse"}},"knowledgeBase":{"description":"Knowledge base to which the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"externalId":{"type":"string","description":"The reference to external id associated with the document."},"source":{"description":"The reference to source associated with the document.","$ref":"#/definitions/AddressableEntityRef"},"readonly":{"type":"boolean","description":"Whether the document is read-only."},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/DocumentVariation"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentReq":{"type":"object","required":["title"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"categoryId":{"type":"string","description":"The category associated with the document."},"labelIds":{"type":"array","description":"The ids of labels associated with the document.","items":{"type":"string"}},"externalId":{"type":"string","description":"The external id associated with the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersion":{"type":"object","required":["restoreFromVersionId"],"properties":{"id":{"type":"string","description":"Globally unique identifier for the document version.","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"Published date of document version. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"document":{"description":"The document which is versioned.","readOnly":true,"$ref":"#/definitions/KnowledgeDocumentResponse"},"restoreFromVersionId":{"type":"string","description":"The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. If not, it publishes the draft changes as a new version of the document."},"versionNumber":{"type":"integer","format":"int32","description":"Version Number of the document.","readOnly":true},"dateExpires":{"type":"string","format":"date-time","description":"Expiry date of document version, applicable only to the 'Archived' version of the document. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"BulkResponse":{"type":"object","properties":{"results":{"type":"array","description":"A list of the results from the bulk operation.","items":{"$ref":"#/definitions/BulkResult"}},"errorCount":{"type":"integer","format":"int32","description":"The number of errors from the bulk operation."},"errorIndexes":{"type":"array","description":"An index of where the errors are in the listing.","items":{"type":"integer","format":"int32"}}}},"DocumentVariationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentVariation"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentVersionVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/DocumentVariationContext"}},"priority":{"type":"integer","format":"int32","description":"The priority of the variation."},"name":{"type":"string","description":"The name of the variation."},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"documentVersion":{"description":"Reference to the document version to which the variation is associated with.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentVersionVariationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariation"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeConversationContext":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The unique identifier of the conversation."},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Unknown","Callback","Chat","Cobrowse","Email","Message","Screenshare","Video","Voice"]},"queueId":{"type":"string","description":"The unique identifier of the queue used to assign the interaction to the user."},"externalContactId":{"type":"string","description":"The external contact identifier of the end-user participant."}}},"KnowledgeDocumentCopy":{"type":"object","required":["application","documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the document whose content was copied."},"documentVersionId":{"type":"string","description":"The version of the document whose content was copied."},"searchId":{"type":"string","description":"The search that surfaced the document whose content was copied."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"conversationContext":{"description":"Conversation context information, if the document content is copied in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"application":{"description":"The client application in which the document content was copied.","$ref":"#/definitions/KnowledgeSearchClientApplication"}}},"KnowledgeSearchClientApplication":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Application type.","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"deployment":{"description":"Application details when type is MessengerKnowledgeApp or SupportCenter.","$ref":"#/definitions/AddressableEntityRef"},"botFlow":{"description":"Application details when type is BotFlow.","$ref":"#/definitions/AddressableEntityRef"},"assistant":{"description":"Application details when type is Assistant.","$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentPresentation":{"type":"object","required":["application","documents"],"properties":{"documents":{"type":"array","description":"The presented documents","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationReference"}},"searchId":{"type":"string","description":"The search that surfaced the documents that were presented."},"queryType":{"type":"string","description":"The type of the query that surfaced the documents.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"conversationContext":{"description":"Conversation context information if the documents were presented in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"application":{"description":"The client application in which the documents were presented.","$ref":"#/definitions/KnowledgeSearchClientApplication"}}},"KnowledgeDocumentVersionVariationReference":{"type":"object","required":["documentId","documentVariationId","documentVersionId"],"properties":{"documentId":{"type":"string","description":"The ID of the document."},"documentVariationId":{"type":"string","description":"The variation of the document."},"documentVersionId":{"type":"string","description":"The version of the document."}}},"EntityReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"KnowledgeConversationContextResponse":{"type":"object","required":["conversation"],"properties":{"conversation":{"description":"The conversation.","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"The queue used to assign the interaction to the user.","$ref":"#/definitions/AddressableEntityRef"},"externalContact":{"description":"The end-user participant of the conversation.","$ref":"#/definitions/AddressableEntityRef"},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Unknown","Callback","Chat","Cobrowse","Email","Message","Screenshare","Video","Voice"]}}},"KnowledgeDocumentFeedbackResponse":{"type":"object","required":["documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the feedback is given in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContextResponse"},"user":{"description":"The user who created the feedback.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentVersionReference":{"type":"object","required":["knowledgeBase","versionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document.","readOnly":true},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBaseReference"},"versionId":{"type":"string","description":"The globally unique identifier for the version of the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentFeedback":{"type":"object","required":["application","document","documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the feedback is given in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"userId":{"type":"string","description":"The ID of the user who created the feedback.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentFeedbackResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentFeedbackResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"DocumentQuery":{"type":"object","required":["clauses","operator"],"properties":{"clauses":{"type":"array","description":"Documents filter clauses/criteria. Limit of 20 clauses.","items":{"$ref":"#/definitions/DocumentQueryClause"}},"operator":{"type":"string","description":"Specifies how the filter clauses will be applied together.","enum":["Or","And"]}}},"DocumentQueryClause":{"type":"object","required":["operator","predicates"],"properties":{"operator":{"type":"string","description":"Specifies how the predicates will be applied together.","enum":["Or","And"]},"predicates":{"type":"array","description":"To apply multiple conditions. Limit of 10 predicates across all clauses.","items":{"$ref":"#/definitions/DocumentQueryPredicate"}}}},"DocumentQueryInterval":{"type":"object","properties":{"field":{"type":"string","description":"Specifies the date field to be used for date and time range.","enum":["dateCreated","dateModified","datePublished"]},"value":{"type":"string","description":"Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}},"DocumentQueryPredicate":{"type":"object","required":["fields","type","values"],"properties":{"fields":{"type":"array","description":"Specifies the document fields to be matched against.","items":{"type":"string","enum":["alternatives","categoryId","categoryName","contextId","contextName","contextValueId","contextValueName","documentId","labelId","labelName","title","variationId","visible","state"]}},"values":{"type":"array","description":"Specifies the values of the fields to be matched against.","items":{"type":"string"}},"type":{"type":"string","description":"Specifies the matching criteria between the fields and values.","enum":["Equals","NotEquals","Contains","MatchAll","MatchAny"]}}},"KnowledgeExportJobDocumentsFilter":{"type":"object","properties":{"interval":{"type":"string","description":"Retrieves the documents modified in specified date and time range. Cannot be used together with entities filter. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"entities":{"type":"array","description":"Retrieves the documents with the given ids. Cannot be used together with internal filter.","items":{"$ref":"#/definitions/Entity"},"maxItems":100,"minItems":1},"sourceId":{"type":"string"}}},"KnowledgeExportJobFilter":{"type":"object","required":["versionFilter"],"properties":{"documentsFilter":{"description":"Filters for narrowing down which documents to export.","$ref":"#/definitions/KnowledgeExportJobDocumentsFilter"},"versionFilter":{"type":"string","description":"Specifies what version should be exported.","enum":["All","Latest"]}}},"KnowledgeExportJobResponse":{"type":"object","required":["fileType"],"properties":{"id":{"type":"string","description":"Id of the export job."},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the export file, when available."},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"jsonFileVersion":{"type":"integer","format":"int32","description":"Requested version of the exported json file."},"countDocumentProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed."},"exportFilter":{"description":"Filters to narrow down what to export.","$ref":"#/definitions/KnowledgeExportJobFilter"},"status":{"type":"string","description":"The status of the export job.","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"knowledgeBase":{"description":"Knowledge base which document export belongs to.","$ref":"#/definitions/KnowledgeBase"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"errorInformation":{"description":"Any error information, or null of the processing is not in failed state.","$ref":"#/definitions/ErrorBody"},"source":{"description":"Source of the export job.","$ref":"#/definitions/KnowledgeOperationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeExportJobRequest":{"type":"object","required":["exportFilter","fileType"],"properties":{"exportFilter":{"description":"What to export.","$ref":"#/definitions/KnowledgeExportJobFilter"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"sourceId":{"type":"string","description":"Knowledge integration source id."},"jsonFileVersion":{"type":"integer","format":"int32","description":"Requested version of the exported json file. Available versions are 2 and 3, default is 2"}}},"KnowledgeImportJobError":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}},"limit":{"$ref":"#/definitions/Limit"},"documentIndex":{"type":"integer","format":"int32","description":"Index of the faulty document."}}},"KnowledgeImportJobReport":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors occurred during processing import.","items":{"$ref":"#/definitions/KnowledgeImportJobError"}},"statistics":{"description":"Statistics related to the import job.","$ref":"#/definitions/KnowledgeImportJobStatistics"}}},"KnowledgeImportJobResponse":{"type":"object","required":["fileType","uploadKey"],"properties":{"id":{"type":"string","description":"Id of the import job","readOnly":true},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the imported file."},"failedEntitiesURL":{"type":"string","description":"The URL of the location at which the caller can download the entities in json format that failed during the import."},"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"settings":{"description":"Additional optional settings","$ref":"#/definitions/KnowledgeImportJobSettings"},"status":{"type":"string","description":"Status of the import job","readOnly":true,"enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the import job","readOnly":true,"$ref":"#/definitions/KnowledgeImportJobReport"},"knowledgeBase":{"description":"Knowledge base which document import does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"createdBy":{"description":"The user who created the operation","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"skipConfirmationStep":{"type":"boolean","description":"If enabled pre-validation step will be skipped."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeImportJobSettings":{"type":"object","properties":{"importAsNew":{"type":"boolean","description":"If enabled import creates a new document even if update is available."},"visible":{"type":"boolean","description":"If specified, import will override the visibility of the imported documents."},"categoryId":{"type":"string","description":"If specified, import will override the category of the imported documents."},"labelIds":{"type":"array","description":"If specified, import will add this labels to the imported documents.","items":{"type":"string"}}}},"KnowledgeImportJobStatistics":{"type":"object","properties":{"countDocumentImportActivityCreate":{"type":"integer","format":"int32","description":"Number of documents will be created by the import."},"countDocumentImportActivityUpdate":{"type":"integer","format":"int32","description":"Number of documents will be updated by the import."},"countDocumentStateDraft":{"type":"integer","format":"int32","description":"Number of documents will be imported as draft."},"countDocumentStatePublished":{"type":"integer","format":"int32","description":"Number of documents will be imported as published."},"countDocumentValidationSuccess":{"type":"integer","format":"int32","description":"Number of documents that validated successfully for import."},"countDocumentValidationFailure":{"type":"integer","format":"int32","description":"Number of documents that failed validation for import."},"countDocumentImportSuccess":{"type":"integer","format":"int32","description":"Number of imported documents."},"countDocumentImportFailure":{"type":"integer","format":"int32","description":"Number of documents failed to import."},"countCategoryValidationSuccess":{"type":"integer","format":"int32","description":"Number of categories that validated successfully for import."},"countCategoryValidationFailure":{"type":"integer","format":"int32","description":"Number of categories that failed validation for import."},"countCategoryImportSuccess":{"type":"integer","format":"int32","description":"Number of imported categories."},"countCategoryImportFailure":{"type":"integer","format":"int32","description":"Number of categories failed to import."},"countLabelValidationSuccess":{"type":"integer","format":"int32","description":"Number of labels that validated successfully for import."},"countLabelValidationFailure":{"type":"integer","format":"int32","description":"Number of labels that failed validation for import."},"countLabelImportSuccess":{"type":"integer","format":"int32","description":"Number of imported labels."},"countLabelImportFailure":{"type":"integer","format":"int32","description":"Number of labels failed to import."},"migrationDetected":{"type":"boolean","description":"Shows whether the import treated as migration or not."}}},"KnowledgeImportJobRequest":{"type":"object","required":["fileType","uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"fileType":{"type":"string","description":"File type of the document","enum":["Json","Csv","Xlsx"]},"settings":{"description":"Additional optional settings","$ref":"#/definitions/KnowledgeImportJobSettings"},"skipConfirmationStep":{"type":"boolean","description":"If enabled pre-validation step will be skipped."}}},"KnowledgeDocumentSearch":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"results":{"type":"array","description":"Documents matching the search query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentSearchResult"}},"application":{"description":"The client application details from which search happened.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the search is initiated in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContextResponse"},"confidenceThreshold":{"type":"number","format":"float","description":"The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold."}}},"KnowledgeDocumentSearchResult":{"type":"object","properties":{"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query."},"document":{"description":"Document that matched the query.","$ref":"#/definitions/KnowledgeSearchDocumentResponse"}}},"KnowledgeSearchDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"category":{"description":"The reference to category associated with the document.","$ref":"#/definitions/CategoryResponse"},"labels":{"type":"array","description":"The references to labels associated with the document.","items":{"$ref":"#/definitions/LabelResponse"}},"knowledgeBase":{"description":"Knowledge base to which the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"externalId":{"type":"string","description":"The reference to external id associated with the document."},"source":{"description":"The reference to source associated with the document.","$ref":"#/definitions/AddressableEntityRef"},"readonly":{"type":"boolean","description":"Whether the document is read-only."},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/DocumentVariationAnswer"}},"answer":{"type":"string","description":"The answer to the query."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentSearchRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the search results would also include draft documents."},"interval":{"description":"Retrieves the documents created/modified/published in specified date and time range.","$ref":"#/definitions/DocumentQueryInterval"},"filter":{"description":"Filter for the document search.","$ref":"#/definitions/DocumentQuery"},"sortOrder":{"type":"string","description":"The sort order for search results.","enum":["Asc","Desc"]},"sortBy":{"type":"string","description":"The field in the documents that you want to sort the search results by.","enum":["ConfidenceScore","DateCreated","DateModified","CategoryName","LabelName"]},"application":{"description":"The client application details from which search request was sent.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"conversationContext":{"description":"Conversation context information if the search is initiated in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"},"confidenceThreshold":{"type":"number","format":"float","description":"The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1."},"answerHighlightTopResults":{"type":"integer","format":"int32","description":"The number of articles to be sent for answer-highlighting. Can range from 1-5.","minimum":1,"maximum":5}}},"SearchUpdateRequest":{"type":"object","required":["answered"],"properties":{"sessionId":{"type":"string","description":"The unique identifier of this session","readOnly":true},"answered":{"type":"boolean","description":"Mark the search as answered/unanswered"},"selectedAnswer":{"description":"The selected search result chosen as the answer.","$ref":"#/definitions/SelectedAnswer"}}},"SelectedAnswer":{"type":"object","required":["document"],"properties":{"document":{"description":"The search result document chosen as the answer.","$ref":"#/definitions/AddressableEntityRef"}}},"KnowledgeDocumentSuggestion":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"results":{"type":"array","description":"Documents matching to the autocomplete suggestions query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentSuggestionResult"}}}},"KnowledgeDocumentSuggestionResult":{"type":"object","properties":{"matchedPhrase":{"type":"string","description":"Matched phrase to the autocomplete suggestions query."},"document":{"$ref":"#/definitions/KnowledgeDocumentSuggestionResultDocument"}}},"KnowledgeDocumentSuggestionResultDocument":{"type":"object","required":["id","knowledgeBase","title"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document."},"knowledgeBase":{"description":"The knowledge base that the document belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"title":{"type":"string","description":"The title of the document."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentSuggestionRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the suggestion results would also include draft documents."},"interval":{"description":"Retrieves the documents created/modified/published in specified date and time range.","$ref":"#/definitions/DocumentQueryInterval"},"filter":{"description":"Filter for the document suggestions.","$ref":"#/definitions/DocumentQuery"}}},"KnowledgeDocumentView":{"type":"object","required":["application","documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the viewed document."},"documentVersionId":{"type":"string","description":"The version of the viewed document."},"searchId":{"type":"string","description":"The search that surfaced the viewed document."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"application":{"description":"The client application from which the document was viewed.","$ref":"#/definitions/KnowledgeSearchClientApplication"},"sessionId":{"type":"string","description":"The unique identifier of the knowledge session in which the document was viewed."},"conversationContext":{"description":"Conversation context information if the document was viewed in the context of a conversation.","$ref":"#/definitions/KnowledgeConversationContext"}}},"AdditionalLanguagesIntent":{"type":"object","properties":{"id":{"type":"string","description":"ID of the intent for respective additional language","readOnly":true},"utterances":{"type":"array","description":"Utterances list for additional language","items":{"$ref":"#/definitions/NluUtterance"}}}},"AdditionalLanguagesSynonyms":{"type":"object","properties":{"synonyms":{"type":"array","description":"Synonyms for additional language","readOnly":true,"items":{"type":"string"}}}},"IntentDefinition":{"type":"object","required":["name","utterances"],"properties":{"id":{"type":"string","description":"ID of the intent.","readOnly":true},"name":{"type":"string","description":"The name of the intent."},"entityTypeBindings":{"type":"array","description":"The bindings for the named entity types used in this intent.This field is mutually exclusive with entityNameReferences and entities","items":{"$ref":"#/definitions/NamedEntityTypeBinding"}},"entityNameReferences":{"type":"array","description":"The references for the named entity used in this intent.This field is mutually exclusive with entityTypeBindings","readOnly":true,"items":{"type":"string"}},"utterances":{"type":"array","description":"The utterances that act as training phrases for the intent.","items":{"$ref":"#/definitions/NluUtterance"}},"additionalLanguages":{"type":"object","description":"Additional languages for intents","additionalProperties":{"$ref":"#/definitions/AdditionalLanguagesIntent"}}}},"NamedEntityAnnotation":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the annotated named entity."}}},"NamedEntityDefinition":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the entity."},"type":{"type":"string","description":"The name of the entity type."}}},"NamedEntityTypeBinding":{"type":"object","required":["entityName","entityType"],"properties":{"entityType":{"type":"string","description":"The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."},"entityName":{"type":"string","description":"The name that this named entity type is bound to."}}},"NamedEntityTypeDefinition":{"type":"object","required":["mechanism","name"],"properties":{"name":{"type":"string","description":"The name of the entity type."},"description":{"type":"string","description":"Description of the of the named entity type."},"mechanism":{"description":"The mechanism enabling detection of the named entity type.","$ref":"#/definitions/NamedEntityTypeMechanism"}}},"NamedEntityTypeItem":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"A value for an named entity type definition."},"synonyms":{"type":"array","description":"Synonyms for the given named entity value.","items":{"type":"string"}},"additionalLanguages":{"type":"object","description":"Additional Language Synonyms for the given named entity value.","additionalProperties":{"$ref":"#/definitions/AdditionalLanguagesSynonyms"}}}},"NamedEntityTypeMechanism":{"type":"object","required":["items","type"],"properties":{"items":{"type":"array","description":"The items that define the named entity type.","items":{"$ref":"#/definitions/NamedEntityTypeItem"}},"restricted":{"type":"boolean","description":"Whether the named entity type is restricted to the items provided. Default: false"},"type":{"type":"string","description":"The type of the mechanism.","enum":["DynamicList","List","Regex","Unknown"]}}},"NluDomain":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the NLU domain."},"language":{"type":"string","description":"The language culture of the NLU domain, e.g. `en-us`, `de-de`."},"draftVersion":{"description":"The draft version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"lastPublishedVersion":{"description":"The last published version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"engineVersion":{"type":"string","description":"The version of the NLU engine to use."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluDomainVersion":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"domain":{"description":"The NLU domain of the version.","readOnly":true,"$ref":"#/definitions/NluDomain"},"description":{"type":"string","description":"The description of the NLU domain version."},"language":{"type":"string","description":"The language that the NLU domain version supports."},"published":{"type":"boolean","description":"Whether this NLU domain version has been published.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trainingStatus":{"type":"string","description":"The training status of the NLU domain version.","readOnly":true,"enum":["Untrained","Training","Trained","Error","Unknown"]},"evaluationStatus":{"type":"string","description":"The evaluation status of the NLU domain version.","readOnly":true,"enum":["Unevaluated","Evaluating","Evaluated","Error"]},"intents":{"type":"array","description":"The intents defined for this NLU domain version.","items":{"$ref":"#/definitions/IntentDefinition"}},"entityTypes":{"type":"array","description":"The entity types defined for this NLU domain version.","items":{"$ref":"#/definitions/NamedEntityTypeDefinition"}},"entities":{"type":"array","description":"The entities defined for this NLU domain version.This field is mutually exclusive with entityTypeBindings","items":{"$ref":"#/definitions/NamedEntityDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluUtterance":{"type":"object","required":["segments"],"properties":{"id":{"type":"string","description":"ID of the utterance.","readOnly":true},"segments":{"type":"array","description":"The list of segments that that constitute this utterance for the given intent.","items":{"$ref":"#/definitions/NluUtteranceSegment"}}}},"NluUtteranceSegment":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the segment."},"entity":{"description":"The entity annotation of the segment.","$ref":"#/definitions/NamedEntityAnnotation"}}},"NluDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DetectedNamedEntity":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected named entity.","readOnly":true},"entityType":{"type":"string","description":"The type of the detected named entity.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected named entity.","readOnly":true},"value":{"description":"The value of the detected named entity.","readOnly":true,"$ref":"#/definitions/DetectedNamedEntityValue"}}},"DetectedNamedEntityValue":{"type":"object","properties":{"raw":{"type":"string","description":"The raw value of the detected named entity.","readOnly":true},"resolved":{"type":"string","description":"The resolved value of the detected named entity.","readOnly":true},"unit":{"type":"string","description":"The unit of the detected amount of money entity, e.g. EUR, USD.","readOnly":true,"allowEmptyValue":true}}},"IntentFeedback":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}},"assessment":{"type":"string","description":"The assessment on the detection for feedback text.","enum":["Incorrect","Correct","Unknown","Disabled"]}}},"NluFeedbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"version":{"description":"The domain version of the feedback.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"language":{"type":"string","description":"The language of the version to which feedback is linked, e.g. en-us, de-de"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluFeedbackRequest":{"type":"object","required":["intents","text","versionId"],"properties":{"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"versionId":{"type":"string","description":"The domain version ID of the feedback."},"language":{"type":"string","description":"The language of the version to which feedback is linked, e.g. en-us, de-de"}}},"NluFeedbackListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluFeedbackResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Draft":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Draft name"},"miner":{"description":"Miner to which the draft belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"intents":{"type":"array","description":"Draft intent object.","readOnly":true,"items":{"$ref":"#/definitions/DraftIntents"}},"topics":{"type":"array","description":"Draft topic object.","readOnly":true,"items":{"$ref":"#/definitions/DraftTopics"}},"dateCreated":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the draft was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the draft was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftIntents":{"type":"object","required":["id","name","utterances"],"properties":{"id":{"type":"string","description":"Id for an intent."},"name":{"type":"string","description":"Name/Label for an intent."},"utterances":{"type":"array","description":"The utterances that are extracted for an Intent.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftTopics":{"type":"object","required":["id","phrases"],"properties":{"id":{"type":"string","description":"Id for a topic."},"name":{"type":"string","description":"Topic name."},"miner":{"description":"The miner to which the topic belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"conversationCount":{"type":"integer","format":"int32","description":"Number of conversations where a topic has occurred.","readOnly":true},"conversationPercent":{"type":"number","format":"float","description":"Percentage of conversations where a topic has occurred.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of unique utterances where a topic has occurred.","readOnly":true},"phraseCount":{"type":"integer","format":"int32","description":"Number of unique phrases (sub-utterances) where a topic has occurred.","readOnly":true},"phrases":{"type":"array","description":"The phrases that are extracted for a topic.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Miner":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Chat Corpus Name."},"language":{"type":"string","description":"Language Localization code.","enum":["en-us","en-gb","en-au","en-in","en-za","es-us","es-es","fr-fr","fr-ca","de-de","pt-pt","pt-br","nl-nl","it-it"]},"minerType":{"type":"string","description":"Type of the miner, intent or topic.","enum":["Intent","Topic"]},"dateCreated":{"type":"string","format":"date-time","example":"2020-04-29T17:12:06.613","description":"Date when the miner was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Status of the miner.","readOnly":true,"enum":["NotStarted","FetchingConversationIds","ConversationIdsFetched","ConversationIdsFetchError","FetchingConversations","ConversationsFetched","ConversationsFetchError","Queued","QueuingError","MiningStarted","MaskingUtterances","MaskingError","ComputingAnalytics","ComputingAnalyticsError","MiningCompleted","MiningError","ModelValidationError","Deleted"]},"conversationsDateRangeStart":{"type":"string","format":"date","example":"2019-06-20","description":"Date from which the conversations need to be taken for mining. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"conversationsDateRangeEnd":{"type":"string","format":"date","example":"2019-12-20","description":"Date till which the conversations need to be taken for mining. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","example":"2020-05-20T23:56:07.268","description":"Date when the mining process was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"message":{"type":"string","description":"Mining message if present.","readOnly":true},"errorInfo":{"description":"Error Information","readOnly":true,"$ref":"#/definitions/MinerErrorInfo"},"warningInfo":{"description":"Warning Information","readOnly":true,"$ref":"#/definitions/MinerErrorInfo"},"conversationDataUploaded":{"type":"boolean","description":"Flag to indicate whether data file to be mined was uploaded.","readOnly":true},"mediaType":{"type":"string","description":"Media type for filtering conversations.","readOnly":true,"enum":["Chat","Call","Message","Email"]},"participantType":{"type":"string","description":"Type of the participant, either agent, customer or both.","readOnly":true,"enum":["Customer","Agent","Both"]},"queueIds":{"type":"array","description":"List of queue IDs for filtering conversations.","readOnly":true,"items":{"type":"string"}},"dateTriggered":{"type":"string","format":"date-time","example":"2020-04-30T23:56:07.268","description":"Date when the miner started execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","example":"2020-04-30T23:56:07.268","description":"Date when the miner was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"latestDraftVersion":{"description":"Latest draft details of the miner.","readOnly":true,"$ref":"#/definitions/Draft"},"conversationsFetchedCount":{"type":"integer","format":"int32","description":"Number of conversations/transcripts fetched.","readOnly":true},"conversationsValidCount":{"type":"integer","format":"int32","description":"Number of conversations/recordings/transcripts that were found valid for mining purposes.","readOnly":true},"getminedItemCount":{"type":"integer","format":"int32","description":"Number of intents or topics based on the miner type.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MinerErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"messageWithParams":{"type":"string","description":"Error message with params included."},"messageParams":{"type":"object","description":"Map of variables and params for the error message.","additionalProperties":{"type":"object"}}}},"DraftRequest":{"type":"object","properties":{"intents":{"type":"array","description":"Draft intent object.","items":{"$ref":"#/definitions/DraftIntents"}},"topics":{"type":"array","description":"Draft topic object.","items":{"$ref":"#/definitions/DraftTopicRequest"}}}},"DraftTopicRequest":{"type":"object","required":["id","name","phrases"],"properties":{"id":{"type":"string","description":"Id for a topic."},"name":{"type":"string","description":"Name/Label for a topic."},"phrases":{"type":"array","description":"The phrases that are extracted for a topic.","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DraftListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Draft"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerIntent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","example":"pay bill.","description":"Intent name."},"miner":{"description":"The miner to which the intent belongs.","$ref":"#/definitions/Miner"},"utterances":{"type":"array","description":"The utterances that are extracted for an Intent.","items":{"$ref":"#/definitions/Utterance"}},"analyticVolumePercent":{"type":"number","format":"double","example":21.5,"description":"Percentage of conversations belonging to the intent."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Utterance":{"type":"object","properties":{"utteranceText":{"type":"string","example":"I want to pay bill.","description":"Utterance text"}}},"MinedIntentsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MinerIntent"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerExecuteRequest":{"type":"object","properties":{"dateStart":{"type":"string","format":"date","example":"2020-04-01","description":"Start date for the date range to mine. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","example":"2020-04-01","description":"End date for the date range to mine. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"uploadKey":{"type":"string","example":"intent-miner/raw-utterances/imports/org_id/request_id.mine_id.json","description":"Location of input conversations."},"mediaType":{"type":"string","description":"Media type for filtering conversations.","enum":["Chat","Call","Message","Email"]},"participantType":{"type":"string","description":"Type of the participant, either agent, customer or both.","enum":["Customer","Agent","Both"]},"queueIds":{"type":"array","example":"[ \"7fe8a4ce-7435-4c78-a83f-47c3943e53eb\", \"18c744bf-34d5-452a-b6d6-9af95628aa50\"]","description":"List of queue IDs for filtering conversations.","items":{"type":"string"}}}},"MinerListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Miner"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Topic name."},"miner":{"description":"The miner to which the topic belongs.","readOnly":true,"$ref":"#/definitions/Miner"},"conversationCount":{"type":"integer","format":"int32","description":"Number of conversations where a topic has occurred.","readOnly":true},"conversationPercent":{"type":"number","format":"float","description":"Percentage of conversations where a topic has occurred.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of unique utterances where a topic has occurred.","readOnly":true},"phraseCount":{"type":"integer","format":"int32","description":"Number of unique phrases (sub-utterances) where a topic has occurred.","readOnly":true},"phrases":{"type":"array","description":"Phrases associated with a topic.","items":{"$ref":"#/definitions/TopicPhrase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicPhrase":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"utteranceCount":{"type":"integer","format":"int32"}}},"MinerTopicsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MinerTopic"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"MinerTopicPhrase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Phrase name."},"topic":{"description":"Topic associated with a phrase.","$ref":"#/definitions/MinerTopic"},"utterances":{"type":"array","description":"List of utterances related to a phrase.","items":{"$ref":"#/definitions/Utterance"}},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances belonging to a phrase"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluConfusionMatrixColumn":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the intent for the column."},"value":{"type":"number","format":"float","description":"The confusion value between the intents"}}},"NluConfusionMatrixRow":{"type":"object","required":["columns","name"],"properties":{"name":{"type":"string","description":"The name of the intent for the row."},"columns":{"type":"array","description":"The columns of confusion matrix for the intent","items":{"$ref":"#/definitions/NluConfusionMatrixColumn"}}}},"NluDomainVersionQualityReport":{"type":"object","required":["confusionMatrix","summary","version"],"properties":{"version":{"description":"The domain and version details of the quality report","$ref":"#/definitions/NluDomainVersion"},"confusionMatrix":{"type":"array","description":"The confusion matrix for the Domain Version","items":{"$ref":"#/definitions/NluConfusionMatrixRow"}},"summary":{"description":"The quality report summary for the Domain Version","$ref":"#/definitions/NluQualityReportSummary"}}},"NluQualityReportSummary":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"array","description":"The list of metrics in the summary","items":{"$ref":"#/definitions/NluQualityReportSummaryMetric"}}}},"NluQualityReportSummaryMetric":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the metric. e.g. recall, f1_score"},"value":{"type":"number","format":"float","description":"The value of the metric"}}},"NluDomainVersionTrainingResponse":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating result of the action.","readOnly":true},"version":{"$ref":"#/definitions/NluDomainVersion"}}},"DetectedDialogAct":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected dialog act.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected dialog act.","readOnly":true}}},"DetectedIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}}}},"NluDetectionInput":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text to perform NLU detection on."},"language":{"type":"string","description":"Language of the version for multilingual detection, e.g. `en-us`, `de-de`"}}},"NluDetectionOutput":{"type":"object","properties":{"intents":{"type":"array","description":"The detected intents.","readOnly":true,"items":{"$ref":"#/definitions/DetectedIntent"}},"dialogActs":{"type":"array","description":"The detected dialog acts.","readOnly":true,"items":{"$ref":"#/definitions/DetectedDialogAct"}}}},"NluDetectionResponse":{"type":"object","properties":{"version":{"description":"The NLU domain version which performed the detection.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"output":{"$ref":"#/definitions/NluDetectionOutput"},"input":{"$ref":"#/definitions/NluDetectionInput"}}},"ContextEntity":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity."}}},"ContextIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the intent."}}},"NluDetectionContext":{"type":"object","properties":{"intent":{"description":"Restrict detection to this intent.","$ref":"#/definitions/ContextIntent"},"entity":{"description":"Use this entity to restrict detection.","$ref":"#/definitions/ContextEntity"}}},"NluDetectionRequest":{"type":"object","required":["input"],"properties":{"input":{"description":"The input subject to NLU detection.","$ref":"#/definitions/NluDetectionInput"},"context":{"description":"The context for the input to NLU detection.","$ref":"#/definitions/NluDetectionContext"}}},"NluDomainVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomainVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddressableLicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"permissions":{"$ref":"#/definitions/Permissions"},"prerequisites":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AddressableLicenseDefinition"}},"comprises":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Permissions":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"List of permission ids.","items":{"type":"string"}}}},"LicenseOrgToggle":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean"}}},"LicenseUpdateStatus":{"type":"object","properties":{"userId":{"type":"string"},"licenseId":{"type":"string"},"result":{"type":"string"}}},"LicenseAssignmentRequest":{"type":"object","required":["licenseId","userIdsAdd","userIdsRemove"],"properties":{"licenseId":{"type":"string","description":"The id of the license to assign/unassign."},"userIdsAdd":{"type":"array","description":"The ids of users to assign this license to.","uniqueItems":true,"items":{"type":"string"}},"userIdsRemove":{"type":"array","description":"The ids of users to unassign this license from.","uniqueItems":true,"items":{"type":"string"}}}},"LicenseBatchAssignmentRequest":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"The list of license assignment updates to make.","items":{"$ref":"#/definitions/LicenseAssignmentRequest"}}}},"LicenseUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicenses":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicensesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserLicenses"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ApprovalNamespace":{"type":"object","properties":{"namespace":{"type":"string","description":"The namespace of the associated approvers.","readOnly":true,"enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","social.media","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"status":{"type":"string","description":"The current namespace approval status.","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"type":{"type":"string","description":"The type of namespace approval.","readOnly":true,"enum":["Primary","Secondary","System"]}}},"LimitChangeRequestDetails":{"type":"object","required":["description","key","namespace","requestedValue","supportCaseUrl"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"key":{"type":"string","description":"Limit key to be overridden (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)"},"namespace":{"type":"string","description":"Namespace the key belongs to (see https://developer.mypurecloud.com/api/rest/v2/organization/limits.html#available_limits)","enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","social.media","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"requestedValue":{"type":"number","format":"double","description":"Requested limit value for a given key"},"description":{"type":"string","description":"Description of the need for the limit change request"},"supportCaseUrl":{"type":"string","description":"The support case url created by Care"},"status":{"type":"string","description":"Current status of the limit change request","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"currentValue":{"type":"number","format":"double","description":"Current limit value for a given key","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date of the limit change request creation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"statusHistory":{"type":"array","description":"List of statuses that a limit change request has gone through","readOnly":true,"items":{"$ref":"#/definitions/StatusChange"}},"dateCompleted":{"type":"string","format":"date-time","description":"The date of the limit change request completion (ChangeImplemented, Rejected, or RollbackImplemented. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"rejectReason":{"type":"string","description":"The reason for rejecting the limit override request","readOnly":true,"enum":["AlternativeExists","IncreaseNotRequired","PlatformMisuse","PlatformStability","OtherReason"]},"approvalNamespaces":{"type":"array","description":"The approval breakdown for this override request.","readOnly":true,"items":{"$ref":"#/definitions/ApprovalNamespace"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StatusChange":{"type":"object","properties":{"dateStatusChanged":{"type":"string","format":"date-time","description":"The date of this status change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status the change request transitioned to","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"previousStatus":{"type":"string","description":"The status the change request transitioned from","readOnly":true,"enum":["Approved","Rejected","Rollback","Pending","Open","SecondaryApprovalNamespacesAdded","ReviewerApproved","ReviewerRejected","ReviewerRollback","ImplementingChange","ChangeImplemented","ImplementingRollback","RollbackImplemented"]},"namespace":{"type":"string","description":"The namespace for the status change","readOnly":true,"enum":["agent.assistant","analytics.alerting","analytics","analytics.realtime","analytics.reporting.settings","architect","audiohook","audit","auth.api","authorization","automation.testing","bots","bots.voice","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","journey","knowledge","language.understanding","learning","limit.registry","marketplace","media.communications","messaging","notifications","onboarding","outbound","platform.api","predictive.routing","presence","quality","recording","response.management","routing","scim","search","secondary.automation.testing","skills","social.media","speech.and.text.analytics","speech.integration","supportability","task.management","telephony.configuration","usage","users","web.deployments","web.messaging","webchat","webhooks","workforce.management.forecast","workforce.management","system"]},"message":{"type":"string","description":"A short message describing the status change","readOnly":true},"rejectReason":{"type":"string","description":"The reason for rejecting the limit override request","readOnly":true,"enum":["AlternativeExists","IncreaseNotRequired","PlatformMisuse","PlatformStability","OtherReason"]}}},"LimitChangeRequestsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LimitChangeRequestDetails"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"LimitDocs":{"type":"object","properties":{"key":{"type":"string"},"defaultValue":{"type":"integer","format":"int64"},"description":{"type":"string"},"resource":{"type":"string"},"configurable":{"type":"boolean"},"trackable":{"type":"boolean"}}},"LimitDocumentation":{"type":"object","properties":{"url":{"type":"string"},"namespaces":{"type":"array","items":{"$ref":"#/definitions/NamespaceDocs"}}}},"NamespaceDocs":{"type":"object","properties":{"friendlyName":{"type":"string"},"limits":{"type":"array","items":{"$ref":"#/definitions/LimitDocs"}}}},"FreeTrialLimit":{"type":"object","properties":{"key":{"type":"string"},"defaultValue":{"type":"integer","format":"int64"},"description":{"type":"string"},"resource":{"type":"string"}}},"FreeTrialLimitDocs":{"type":"object","properties":{"namespaces":{"type":"array","items":{"$ref":"#/definitions/FreeTrialNamespace"}}}},"FreeTrialNamespace":{"type":"object","properties":{"friendlyName":{"type":"string"},"limits":{"type":"array","items":{"$ref":"#/definitions/FreeTrialLimit"}}}},"PagedNamespaceListing":{"type":"object"},"LimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Limit"}}}},"LogCaptureDownloadExecutionResponse":{"type":"object","required":["dateStart","fileUrl","id","state","user"],"properties":{"id":{"type":"string","description":"Id of file download job."},"state":{"type":"string","description":"Execution state of the download.","readOnly":true,"enum":["Running","Failed","Succeeded"]},"dateStart":{"type":"string","format":"date-time","description":"Start date of file download execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"fileUrl":{"type":"string","description":"Url of a file with query result.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user that created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LogCaptureQueryRequest":{"type":"object","required":["interval","userId"],"properties":{"interval":{"type":"string","description":"Date and time range to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userId":{"type":"string","description":"Id of the user to query."},"sortOrder":{"type":"string","description":"Order of results. Default order is ASC.","enum":["ASC","DESC"]}}},"LogEntry":{"type":"object","properties":{"level":{"type":"string","description":"Level of log entry"},"message":{"type":"string","description":"Log message"},"timestamp":{"type":"integer","format":"int64","description":"Timestamp of log entry"}}},"LogCaptureQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LogEntry"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"PagelessEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/AddressableEntity"}},"selfUri":{"type":"string","format":"uri"}}},"LogCaptureUserConfiguration":{"type":"object","required":["dateExpired"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"Indicates when log capture will be turned off for the user. (Must be within 24 hours). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ButtonComponent":{"type":"object","properties":{"title":{"type":"string","description":"Text to show inside the button."},"actions":{"description":"The button actions (Deprecated).","$ref":"#/definitions/ContentActions"}},"description":"Structured template button object."},"ContentActions":{"type":"object","properties":{"url":{"type":"string","description":"A URL of a web page to direct the user to."},"urlTarget":{"type":"string","description":"The target window in which to open the URL. If empty will open a blank page or tab."},"textback":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The textback and title are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"ContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Provider specific ID for attachment. For example, a LINE sticker ID."},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."}},"description":"Attachment object."},"ContentCard":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"defaultAction":{"description":"The default button action.","$ref":"#/definitions/ContentCardAction"},"actions":{"type":"array","description":"An array of action objects.","items":{"$ref":"#/definitions/ContentCardAction"}}},"description":"Card content object."},"ContentCardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The payload and text are a combination which will have to be unique across each card and carousel in order to determine which button was clicked in that card or carousel."},"url":{"type":"string","description":"A URL of a web page to direct the user to."}},"description":"A card action that a user can take."},"ContentCarousel":{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","description":"An array of card objects.","items":{"$ref":"#/definitions/ContentCard"}}},"description":"Carousel content object."},"ContentGeneric":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"video":{"type":"string","description":"URL of a video."},"actions":{"description":"Actions to be taken (Deprecated).","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Deprecated, should use Card."},"ContentList":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID assigned to this rich message content."},"listType":{"type":"string","description":"The type of list this instance represents.","enum":["Selection","Vertical"]},"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"submitLabel":{"type":"string","description":"Label for Submit button."},"actions":{"description":"The list actions (Deprecated).","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ListItemComponent"}}},"description":"List content object."},"ContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"URL of the Location."},"address":{"type":"string","description":"Location postal address."},"text":{"type":"string","description":"Location name."},"latitude":{"type":"number","format":"double","description":"Latitude of the location."},"longitude":{"type":"number","format":"double","description":"Longitude of the location."}},"description":"Location object."},"ContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The messaging provider template ID. For WhatsApp, 'namespace@name'."},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/NotificationTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/NotificationTemplateBody"},"footer":{"description":"The template footer.","$ref":"#/definitions/NotificationTemplateFooter"}},"description":"Template notification object."},"ContentPostback":{"type":"object","required":["payload"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response."},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Postback response object representing the click of a rich media button (Deprecated)."},"ContentQuickReply":{"type":"object","required":["payload","text"],"properties":{"id":{"type":"string","description":"A unique ID assigned to the quick reply (Deprecated)."},"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object."},"ContentQuickReplyV2":{"type":"object","required":["actions","title"],"properties":{"title":{"type":"string","description":"Text to show as the title of the quick reply."},"actions":{"type":"array","description":"An array of quick reply objects.","items":{"$ref":"#/definitions/ContentQuickReply"}}},"description":"Quick reply object V2."},"ContentReaction":{"type":"object","required":["count","reactionType"],"properties":{"reactionType":{"type":"string","description":"Type of reaction.","enum":["Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care"]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to the message."}},"description":"User reaction to public message."},"ContentStory":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"An ephemeral story."},"ContentText":{"type":"object","required":["body"],"properties":{"type":{"type":"string","description":"Type of text content.","enum":["Text"]},"body":{"type":"string","description":"Text to be shown for this content element."}},"description":"Message content element containing text only."},"ListItemComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this list item."},"rmid":{"type":"string","description":"An ID of the rich message instance."},"type":{"type":"string","description":"The type of list item to render.","enum":["ListItem","ListItemBig"]},"image":{"type":"string","description":"URL of an image."},"title":{"type":"string","description":"The main headline of the list item."},"description":{"type":"string","description":"Text to show in the list item description."},"actions":{"description":"The list item actions (Deprecated).","$ref":"#/definitions/ContentActions"}},"description":"An entry in a List template."},"MessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element.","enum":["Attachment","Location","QuickReply","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention","ButtonResponse","Story","Card","Carousel","Text","QuickReplyV2"]},"location":{"description":"Location content.","$ref":"#/definitions/ContentLocation"},"attachment":{"description":"Attachment content.","$ref":"#/definitions/ContentAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/ContentQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ContentButtonResponse"},"generic":{"description":"Generic content (Deprecated).","$ref":"#/definitions/ContentGeneric"},"list":{"description":"List content (Deprecated).","$ref":"#/definitions/ContentList"},"template":{"description":"Template notification content.","$ref":"#/definitions/ContentNotificationTemplate"},"reactions":{"type":"array","description":"A set of reactions to a message.","items":{"$ref":"#/definitions/ContentReaction"}},"mention":{"description":"Mention content.","$ref":"#/definitions/MessagingRecipient"},"postback":{"description":"Structured message postback (Deprecated).","$ref":"#/definitions/ContentPostback"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/ContentStory"},"card":{"description":"Card content","$ref":"#/definitions/ContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ContentCarousel"},"text":{"description":"Text content.","$ref":"#/definitions/ContentText"},"quickReplyV2":{"description":"Quick reply V2 content.","$ref":"#/definitions/ContentQuickReplyV2"}},"description":"Message content element. If contentType = \"Attachment\" only one item is allowed."},"MessagingRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"type":"string","description":"The recipient ID type. This is used to indicate the format used for the ID.","enum":["Email","Phone","Opaque"]},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"email":{"type":"string","description":"E-mail address of the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","items":{"$ref":"#/definitions/RecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to or received from."},"NotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored."},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template body object."},"NotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored."}},"description":"Template footer object."},"NotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored."},"media":{"description":"Media template header image.","$ref":"#/definitions/ContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template.","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template header object."},"NotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name."},"text":{"type":"string","description":"Parameter text value."}},"description":"Template parameters for placeholders in template."},"RecipientAdditionalIdentifier":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Type of the Identifier","readOnly":true,"enum":["Deployment","Subject"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"Verifier":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Indicates whether this verifier is enabled."},"default":{"type":"boolean","description":"Indicates whether this is the default verifier."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VerifierEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Verifier"}},"selfUri":{"type":"string","format":"uri"}}},"UpdateVerifierRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the verifier."},"enabled":{"type":"boolean","description":"Indicates whether this verifier will be enabled."},"default":{"type":"boolean","description":"Indicates whether this will be the default verifier."}}},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp","audiohook","open-messaging","api"]},"region":{"type":"string"}}},"IpAddressRangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IpAddressRange"}}}},"ActionEventRequest":{"type":"object","required":["actionId","actionState","sessionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"sessionId":{"type":"string","description":"UUID of the customer session for this action."},"actionId":{"type":"string","description":"UUID for the action, as returned by the Ping endpoint when the action was qualified."},"actionState":{"type":"string","description":"State the action is transitioning to.","enum":["accepted","rejected","timedout","errored","ignored","qualified","offered","started","engaged","qualifiedOutsideSchedule","offeredOutsideSchedule","abandoned","completed","frequencyCapReached"]},"errorCode":{"type":"string","description":"Client defined error code (when state transitions to errored)"},"errorMessage":{"type":"string","description":"Message of the error returned when the action fails (when state transitions to errored)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AppEventResponse":{"type":"object","required":["app","attributes","createdDate","customerId","customerIdType","device","eventName","id","screenName","session","traits"],"properties":{"id":{"type":"string","description":"System-generated UUID for the event."},"customerId":{"type":"string","description":"Identifier of the customer in the source of the event."},"customerIdType":{"type":"string","description":"Type of identifier for the customer ID (cookie, email etc.)."},"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered)."},"screenName":{"type":"string","description":"The name of the screen in the app that the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"session":{"description":"The app session the event belongs to.","$ref":"#/definitions/AppEventResponseSession"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events (e.g. email, name, phone).","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AppEventResponseSession":{"type":"object","required":["createdDate","durationInSeconds","eventCount","id","screenviewCount"],"properties":{"id":{"type":"string","description":"ID of the app session."},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the customer has been in the app within this session."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events recorded during this session."},"screenviewCount":{"type":"integer","format":"int32","description":"The count of all screen views recorded during this session."},"referrer":{"description":"The referrer of the first event in the app session.","$ref":"#/definitions/Referrer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp of the session's first event, that is when the session starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AppEventRequest":{"type":"object","required":["app","createdDate","customerCookieId","device","eventName","screenName"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. Event types are created for each unique event name and can be faceted on in segment and outcome conditions. A valid event name must only contain alphanumeric characters and underscores. A good event name is typically an object followed by the action performed in past tense, e.g. screen_viewed, search_performed, user_registered."},"screenName":{"type":"string","description":"The name of the screen, view, or fragment in the app where the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/RequestDevice"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"referrerUrl":{"type":"string","description":"The referrer URL of the first event in the app session."},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event. These attributes provide additional context about the event. For example, items_in_cart or subscription_level.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events, (e.g. email, lastName, cellPhone). Traits are used to collect information for identity resolution. For example, the same person might be using an application on different devices which might create two sessions with different customerIds. Additional information can be provided as traits to help link those two sessions and customers to a single external contact through common identifiers that were submitted via a form fill, message, or other input in both sessions.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"customerCookieId":{"type":"string","description":"A UUID representing the customer associated with the app event. This is expected to be set per application install or device and can be used to identify a single customer across multiple sessions. This identifier, along with others passed as traits, is used for identity resolution."},"createdDate":{"type":"string","format":"date-time","description":"UTC timestamp indicating when the event actually took place, events older than an hour will be rejected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RequestDevice":{"type":"object","required":["category","osFamily","osVersion","type"],"properties":{"category":{"type":"string","description":"Device category.","enum":["desktop","mobile","tablet","other"]},"type":{"type":"string","description":"Device type (e.g. iPad, iPhone, Other)."},"isMobile":{"type":"boolean","description":"Flag that is true for mobile devices."},"screenHeight":{"type":"integer","format":"int32","description":"Device's screen height."},"screenWidth":{"type":"integer","format":"int32","description":"Device's screen width."},"screenDensity":{"type":"integer","format":"int32","description":"Device's screen density, measured as a scale factor where a value of 1 represents a baseline 1:1 ratio of pixels to logical (device-independent) pixels."},"fingerprint":{"type":"string","description":"Fingerprint generated by looking at the individual device features."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"DeploymentPing":{"type":"object","properties":{"actions":{"type":"array","description":"Collection of actions to be offered or displayed to the visitor.","items":{"$ref":"#/definitions/DeploymentWebAction"}},"pollIntervalMilliseconds":{"type":"integer","format":"int32","description":"Custom poll interval in milliseconds; when the return value is -1, disable pings."}}},"DeploymentWebAction":{"type":"object","required":["actionMapId","actionMapVersion","id","mediaType","sessionId"],"properties":{"id":{"type":"string","description":"System-generated UUID for the action."},"mediaType":{"type":"string","description":"Action media type used to deliver the action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"customerId":{"type":"string","description":"ID string of the customer that the action was triggered for."},"customerIdType":{"type":"string","description":"Type of the customer ID that the action was triggered for."},"actionMapId":{"type":"string","description":"ID of the action map that triggered the action."},"actionMapVersion":{"type":"integer","format":"int32","description":"Version of the action map that triggered the action."},"sessionId":{"type":"string","description":"ID of the session that the action was triggered for."},"webMessagingOfferProperties":{"description":"Web messaging offer specific properties.","$ref":"#/definitions/WebMessagingOfferProperties"},"contentOfferProperties":{"description":"Content offer specific properties.","$ref":"#/definitions/ContentOffer"},"openActionProperties":{"description":"Open action specific properties.","$ref":"#/definitions/OpenActionProperties"}}},"OpenActionProperties":{"type":"object","properties":{"openActionName":{"type":"string","description":"The specific type of the open action."},"configurationFields":{"type":"object","description":"Custom fields defined in the schema referenced by the open action type selected.","additionalProperties":{"type":"object"}}}},"WebMessagingOfferProperties":{"type":"object","properties":{"offerText":{"type":"string","description":"Text value to be used when inviting a visitor to engage with a web messaging offer."}}},"KnowledgeGuestDocumentVariationAnswer":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBodyWithHighlight"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentVariationContext":{"type":"object","required":["context","values"],"properties":{"context":{"description":"The knowledge context associated with the variation.","$ref":"#/definitions/AddressableEntityRef"},"values":{"type":"array","description":"The list of knowledge context values associated with the variation.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"KnowledgeGuestDocumentFeedback":{"type":"object","required":["document","documentVariation","rating"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"documentVariation":{"description":"The variation of the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason.","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Free-text comment of the feedback. Maximum length: 2000 characters.","minLength":0,"maxLength":2000},"search":{"description":"The search that surfaced the document on which feedback was given.","$ref":"#/definitions/EntityReference"},"sessionId":{"type":"string","description":"Knowledge guest session ID.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"queryType":{"type":"string","description":"The type of the query that surfaced the document on which the feedback was given.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"state":{"type":"string","description":"The state of the feedback.","enum":["Draft","Final"]},"document":{"description":"The document on which feedback was given.","$ref":"#/definitions/KnowledgeGuestDocumentVersionReference"},"application":{"description":"The client application from which feedback was given.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"KnowledgeGuestDocumentVersionReference":{"type":"object","required":["versionId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the document.","readOnly":true},"versionId":{"type":"string","description":"The globally unique identifier for the version of the document."}}},"KnowledgeGuestSearchClientApplication":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Application type.","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"deployment":{"description":"Application details when type is MessengerKnowledgeApp or SupportCenter.","$ref":"#/definitions/EntityReference"},"botFlow":{"description":"Application details when type is BotFlow.","$ref":"#/definitions/EntityReference"},"assistant":{"description":"Application details when type is Assistant.","$ref":"#/definitions/EntityReference"}}},"GuestCategoryReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"sessionId":{"type":"string","description":"ID of the guest session.","readOnly":true},"category":{"description":"The reference to category associated with the document.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariation"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentVariation":{"type":"object","required":["contexts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the variation.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"contexts":{"type":"array","description":"The context values associated with the variation.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationContext"}},"document":{"description":"The reference to document to which the variation is associated.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"body":{"description":"The content for the variation.","$ref":"#/definitions/DocumentBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeGuestDocumentResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeGuestDocumentResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeGuestDocumentView":{"type":"object","required":["documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the viewed document."},"documentVersionId":{"type":"string","description":"The version of the viewed document."},"searchId":{"type":"string","description":"The search that surfaced the viewed document."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]}}},"KnowledgeGuestDocumentCopy":{"type":"object","required":["documentVariationId","documentVersionId"],"properties":{"documentVariationId":{"type":"string","description":"The variation of the document whose content was copied."},"documentVersionId":{"type":"string","description":"The version of the document whose content was copied."},"searchId":{"type":"string","description":"The search that surfaced the document whose content was copied."},"queryType":{"type":"string","description":"The type of the query that surfaced the document.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"application":{"description":"The client application in which the document content was copied.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"KnowledgeGuestDocumentPresentation":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","description":"The presented documents","items":{"$ref":"#/definitions/KnowledgeDocumentVersionVariationReference"}},"searchId":{"type":"string","description":"The search that surfaced the documents that were presented."},"queryType":{"type":"string","description":"The type of the query that surfaced the documents.","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"surfacingMethod":{"type":"string","description":"The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.","enum":["Unknown","Article","Snippet","Highlight"]},"sessionId":{"type":"string","description":"Knowledge session ID.","readOnly":true},"application":{"description":"The client application in which the documents were presented.","readOnly":true,"$ref":"#/definitions/KnowledgeGuestSearchClientApplication"}}},"GuestCategoryResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GuestResponseCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"sessionId":{"type":"string"}}},"GuestResponseCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"externalId":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"parentCategory":{"description":"The reference to category to which this category belongs.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentGuestSearch":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"sessionId":{"type":"string","description":"Session ID of the search.","readOnly":true},"results":{"type":"array","description":"Documents that matched the search query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentGuestSearchResult"}}}},"KnowledgeDocumentGuestSearchResult":{"type":"object","properties":{"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query."},"document":{"description":"Document that matched the query.","$ref":"#/definitions/KnowledgeGuestSearchDocumentResponse"}}},"KnowledgeGuestSearchDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"Document title, having a limit of 500 words."},"visible":{"type":"boolean","description":"Indicates if the knowledge document should be included in search results."},"alternatives":{"type":"array","description":"List of alternate phrases related to the title which improves search results.","items":{"$ref":"#/definitions/KnowledgeDocumentAlternative"}},"state":{"type":"string","description":"State of the document.","enum":["Draft","Published","Archived"]},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateImported":{"type":"string","format":"date-time","description":"Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lastPublishedVersionNumber":{"type":"integer","format":"int32","description":"The last published version number of the document."},"datePublished":{"type":"string","format":"date-time","description":"The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The user who created the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who modified the document.","readOnly":true,"$ref":"#/definitions/UserReference"},"documentVersion":{"description":"The version of the document.","$ref":"#/definitions/AddressableEntityRef"},"sessionId":{"type":"string","description":"ID of the guest session.","readOnly":true},"category":{"description":"The reference to category associated with the document.","readOnly":true,"$ref":"#/definitions/GuestCategoryReference"},"variations":{"type":"array","description":"Variations of the document.","items":{"$ref":"#/definitions/KnowledgeGuestDocumentVariationAnswer"}},"answer":{"type":"string","description":"The answer to the query."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentGuestSearchRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.","minLength":3,"maxLength":2147483647},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"searchId":{"type":"string","description":"The globally unique identifier for the search.","readOnly":true},"total":{"type":"integer","format":"int32","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"queryType":{"type":"string","description":"The type of the query that initiates the search.","enum":["AutoSearch","ManualSearch","Suggestion"]},"sessionId":{"type":"string","description":"Session ID of the search.","readOnly":true},"answerHighlightTopResults":{"type":"integer","format":"int32","description":"The number of articles to be sent for answer-highlighting. Can range from 1-5.","minimum":1,"maximum":5},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the search results would also include draft documents."}}},"KnowledgeGuestDocumentSuggestion":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"sessionId":{"type":"string","description":"Session ID of the guest suggestions.","readOnly":true},"results":{"type":"array","description":"Suggestions matching the query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeGuestDocumentSuggestionResult"}}}},"KnowledgeGuestDocumentSuggestionResult":{"type":"object","properties":{"matchedPhrase":{"type":"string","description":"Matched phrase to the autocomplete suggestions query."}}},"KnowledgeGuestDocumentSuggestionRequest":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"Query to get autocomplete suggestions for the matching knowledge documents."},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the suggestion results would also include draft documents."}}},"KnowledgeGuestSession":{"type":"object","required":["app","customerId"],"properties":{"id":{"type":"string","description":"Session ID.","readOnly":true},"app":{"description":"The app where the session is started.","$ref":"#/definitions/KnowledgeGuestSessionApp"},"customerId":{"type":"string","description":"An arbitrary ID for the customer starting the session. Used to track multiple sessions started by the same customer."},"pageUrl":{"type":"string","description":"URL of the page where the session is started."},"contexts":{"type":"array","description":"The session contexts.","items":{"$ref":"#/definitions/KnowledgeGuestSessionContext"}}}},"KnowledgeGuestSessionApp":{"type":"object","required":["deploymentId","type"],"properties":{"deploymentId":{"type":"string","description":"App deployment ID."},"type":{"type":"string","description":"App type.","enum":["MessengerKnowledgeApp","SupportCenter"]}}},"KnowledgeGuestSessionContext":{"type":"object","required":["id","values"],"properties":{"id":{"type":"string","description":"The context id associated with the session."},"values":{"type":"array","description":"The list of knowledge context values associated with the session.","items":{"$ref":"#/definitions/Entity"}}}},"DomainEntityListingSurveyForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScorableSurvey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"]},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyForm":{"type":"object","required":["contextId","language","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The survey form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"published":{"type":"boolean","description":"Is this form published"},"disabled":{"type":"boolean","description":"Is this form disabled"},"contextId":{"type":"string","description":"Unique Id for all versions of this form","readOnly":true},"language":{"type":"string","description":"Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"},"header":{"type":"string","description":"Markdown text for the top of the form."},"footer":{"type":"string","description":"Markdown text for the bottom of the form."},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/SurveyQuestionGroup"}},"publishedVersions":{"description":"List of published version of this form","readOnly":true,"$ref":"#/definitions/DomainEntityListingSurveyForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"naEnabled":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."},"explanationPrompt":{"type":"string","description":"Prompt for details explaining the chosen NPS score. Used by NPS questions."}}},"SurveyQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"naEnabled":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"SurveyQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float","description":"Score of all questions in the group"},"maxTotalScore":{"type":"number","format":"float","description":"Maximum possible score of all questions in the group"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question group that does not have any answers. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"questionScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionScore"}}}},"SurveyQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32","description":"Unweighted score of the question"},"markedNA":{"type":"boolean","description":"True when the evaluation is submitted with a question that does not have an answer. Only allowed when naEnabled is true or if set by the system"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"assistedAnswerId":{"type":"string","description":"AnswerId found with evaluation assistance conditions"},"npsScore":{"type":"integer","format":"int32"},"npsTextAnswer":{"type":"string"},"freeTextAnswer":{"type":"string"}}},"SurveyScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"npsScore":{"type":"integer","format":"int32"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionGroupScore"}}}},"DocumentationResult":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int32","description":"The globally unique identifier for the object."},"categories":{"type":"array","description":"The category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"description":{"type":"string","description":"The description of the documentation entity. Will be returned in responses for certain entities."},"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"excerpt":{"type":"string","description":"The excerpt of the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"modified":{"type":"string","format":"date-time","description":"The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"The name of the documentation entity. Will be returned in responses for certain entities."},"service":{"type":"array","description":"The service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"slug":{"type":"string","description":"The slug of the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"get_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."},"facet_feature":{"type":"array","description":"The facet feature of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_role":{"type":"array","description":"The facet role of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_service":{"type":"array","description":"The facet service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"faq_categories":{"type":"array","description":"The faq categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_category":{"type":"array","description":"The releasenote category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_tag":{"type":"array","description":"The releasenote tag of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"service-area":{"type":"array","description":"The service area of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"video_categories":{"type":"array","description":"The video categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}}}},"DocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/DocumentationResult"}}}},"DocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","TERM","TERMS","MATCH_ALL","SIMPLE","QUERY_STRING","MULTI_MATCH"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["title","content"]}}}},"DocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}}}},"JsonNodeSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"GKNDocumentationResult":{"type":"object","required":["_type"],"properties":{"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."}}},"GKNDocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/GKNDocumentationResult"}}}},"GKNDocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["SIMPLE"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["title","content"]}}}},"GKNDocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}}}},"CreateWebChatConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Chat Conversation identifier"},"jwt":{"type":"string","description":"The JWT that you can use to identify subsequent calls on this conversation"},"eventStreamUri":{"type":"string","format":"uri","description":"The URI which provides the conversation event stream."},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"}}},"CreateWebChatConversationRequest":{"type":"object","required":["deploymentId","memberInfo","organizationId","routingTarget"],"properties":{"organizationId":{"type":"string","description":"The organization identifier."},"deploymentId":{"type":"string","description":"The web chat Deployment ID which contains the appropriate settings for this chat conversation."},"routingTarget":{"description":"The routing information to use for the new chat conversation.","$ref":"#/definitions/WebChatRoutingTarget"},"memberInfo":{"description":"The guest member info to use for the new chat conversation.","$ref":"#/definitions/GuestMemberInfo"},"memberAuthToken":{"type":"string","description":"If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource."},"journeyContext":{"description":"A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"}}},"GuestMemberInfo":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","description":"The display name to use for the guest member in the conversation."},"firstName":{"type":"string","description":"The first name to use for the guest member in the conversation."},"lastName":{"type":"string","description":"The last name to use for the guest member in the conversation."},"email":{"type":"string","description":"The email address to use for the guest member in the conversation."},"phoneNumber":{"type":"string","description":"The phone number to use for the guest member in the conversation."},"avatarImageUrl":{"type":"string","format":"uri","description":"The URL to the avatar image to use for the guest member in the conversation, if any."},"customFields":{"type":"object","description":"Any custom fields of information, in key-value format, to attach to the guest member in the conversation.","additionalProperties":{"type":"string"}}}},"WebChatRoutingTarget":{"type":"object","required":["targetAddress","targetType"],"properties":{"targetType":{"type":"string","description":"The target type of the routing target, such as 'QUEUE'.","enum":["QUEUE"]},"targetAddress":{"type":"string","description":"The target of the route, in the format appropriate given the 'targetType'."},"skills":{"type":"array","description":"The list of skill names to use for routing.","items":{"type":"string"}},"language":{"type":"string","description":"The language name to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."}}},"WebDeploymentsRefreshJWTRequest":{"type":"object","required":["deploymentId","refreshToken"],"properties":{"refreshToken":{"type":"string","description":"Refresh token used to issue a new JWT."},"deploymentId":{"type":"string","description":"The WebDeployment ID"}}},"WebDeploymentsAuthorizationResponse":{"type":"object","properties":{"refreshToken":{"type":"string","description":"Refresh token used to issue a new JWT."},"jwt":{"type":"string"}}},"WebDeploymentsJourneyContext":{"type":"object","properties":{"journeyAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"},"customer":{"description":"Journey customer information. Used for linking the authenticated customer with the journey. ","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"Contains the Journey System's customer session details.","$ref":"#/definitions/JourneyCustomerSession"}}},"WebDeploymentsOAuthExchangeRequest":{"type":"object","required":["deploymentId"],"properties":{"deploymentId":{"type":"string","description":"The WebDeployment ID"},"journeyContext":{"description":"A Customer journey context.","$ref":"#/definitions/WebDeploymentsJourneyContext"},"oauth":{"$ref":"#/definitions/WebDeploymentsOAuthRequestParameters"}}},"WebDeploymentsOAuthRequestParameters":{"type":"object","required":["code","redirectUri"],"properties":{"code":{"type":"string","description":"The authorization code to be sent to the authentication server during the token request.\n Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"redirectUri":{"type":"string","description":"Redirect URI sent in the \"Authentication Request\"Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"nonce":{"type":"string","description":"Required if provided in the \"Authentication Request\". Otherwise should be empty.String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token. Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"maxAge":{"type":"integer","format":"int32","description":"Required if provided in the \"Authentication Request\". Otherwise should be empty.Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated.Refer to https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest"},"codeVerifier":{"type":"string","description":"Required if authorizing using Proof Key for Code Exchange (PKCE). Otherwise should be empty.Random URL-safe string with a minimum length of 43 characters generated at start of authorization flow to mitigate the threat of having the authorization code intercepted. Refer to https://datatracker.ietf.org/doc/html/rfc7636"},"iss":{"type":"string","description":"Optional parameter. Set it if authorization server discovery metadata authorization_response_iss_parameter_supported is enabled.\nRefer to https://datatracker.ietf.org/doc/html/rfc9207"}}},"AvailableTopic":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"permissionDetails":{"type":"array","description":"Full detailed permissions required to subscribe to the topic","items":{"$ref":"#/definitions/PermissionDetails"}},"requiresPermissions":{"type":"array","description":"Permissions required to subscribe to the topic","items":{"type":"string"}},"requiresDivisionPermissions":{"type":"boolean","description":"True if the subscribing user must belong to the same division as the topic object ID"},"requiresAnyValidator":{"type":"boolean","description":"If multiple permissions are required for this topic, such as both requiresCurrentUser and requiresDivisionPermissions, then true here indicates that meeting any one condition will satisfy the requirements; false indicates all conditions must be met."},"enforced":{"type":"boolean","description":"Whether or not the permissions on this topic are enforced"},"visibility":{"type":"string","description":"Visibility of this topic (Public or Preview)","enum":["Public","Preview"]},"schema":{"type":"object","additionalProperties":{"type":"object"}},"requiresCurrentUser":{"type":"boolean","description":"True if the topic user ID is required to match the subscribing user ID"},"requiresCurrentUserOrPermission":{"type":"boolean","description":"True if permissions are only required when the topic user ID does not match the subscribing user ID"},"transports":{"type":"array","description":"Transports that support events for the topic","items":{"type":"string","enum":["All","Websocket","EventBridge","ProcessAutomation"]}},"publicApiTemplateUriPaths":{"type":"array","items":{"type":"string"}},"topicParameters":{"type":"array","description":"Parameters in the topic name that can be substituted, in the order they appear in the topic name","items":{"type":"string"}}}},"AvailableTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}}}},"PermissionDetails":{"type":"object","properties":{"type":{"type":"string","description":"The type of permission requirement","enum":["requiresCurrentUser","requiresPermissions","requiresDivisionPermissions","requiresAnyDivisionPermissions","requiresUserBeConversationParticipant"]},"permissions":{"type":"array","description":"List of required permissions","items":{"type":"string"}},"allowsCurrentUser":{"type":"boolean","description":"Whether the current user can subscribe, when division permissions are otherwise required"},"enforced":{"type":"boolean","description":"Whether or not this permission requirement is enforced"}}},"Channel":{"type":"object","properties":{"connectUri":{"type":"string","format":"uri"},"id":{"type":"string"},"expires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ChannelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","enum":["Permitted","Rejected"]},"rejectionReason":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChannelTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CustomerInteractionCenter":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GSuite":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GenericSAML":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityNow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CustomProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"]},"ssoBinding":{"type":"string","enum":["urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST","urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"]},"signAuthnRequests":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityProviderEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IdentityProvider"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthAuthorization":{"type":"object","properties":{"client":{"$ref":"#/definitions/OAuthClient"},"scope":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"type":"string"}},"resourceOwner":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"pending":{"type":"boolean"},"state":{"type":"string","enum":["Unauthorized","Requested","Authorized","Revoked"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"OAuthClientRequest":{"type":"object","required":["authorizedGrantType","name"],"properties":{"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","TOKEN","SAML2-BEARER","PASSWORD","CLIENT-CREDENTIALS"]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UsageExecutionResult":{"type":"object","properties":{"executionId":{"type":"string","description":"The id of the query execution"},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved"}}},"ApiUsageClientQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"]},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"]}},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","TemplateUri","HttpMethod"]}}}},"ApiUsageQueryResult":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ApiUsageRow"}},"queryStatus":{"type":"string","description":"Query status","enum":["Complete","Failed","Running"]},"cursors":{"description":"Cursor tokens to be used for navigating paginated results","$ref":"#/definitions/Cursors"}}},"ApiUsageRow":{"type":"object","properties":{"clientId":{"type":"string","description":"Client Id associated with this query result"},"clientName":{"type":"string","description":"Client Name associated with this query result"},"organizationId":{"type":"string","description":"Organization Id associated with this query result"},"userId":{"type":"string","description":"User Id associated with this query result"},"templateUri":{"type":"string","description":"Template Uri associated with this query result"},"httpMethod":{"type":"string","description":"HTTP Method associated with this query result"},"status200":{"type":"integer","format":"int64","description":"Number of requests resulting in a 2xx HTTP status code"},"status300":{"type":"integer","format":"int64","description":"Number of requests resulting in a 3xx HTTP status code"},"status400":{"type":"integer","format":"int64","description":"Number of requests resulting in a 4xx HTTP status code"},"status500":{"type":"integer","format":"int64","description":"Number of requests resulting in a 5xx HTTP status code"},"status429":{"type":"integer","format":"int64","description":"Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400"},"requests":{"type":"integer","format":"int64","description":"Total number of requests"},"date":{"type":"string","format":"date-time","description":"Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OAuthClientEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClientListing"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientListing":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScope":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScopeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthScope"}},"selfUri":{"type":"string","format":"uri"}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PingIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureEngage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"autoProvisionUsers":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"sloURI":{"type":"string"},"sloBinding":{"type":"string"},"relyingPartyIdentifier":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"description":{"type":"string","description":"description","readOnly":true}}},"EventDefinitionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventDefinition"}}}},"EmbeddedIntegration":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"IpAddressAuthentication":{"type":"object","properties":{"networkWhitelist":{"type":"array","items":{"type":"string"}}}},"OrgWhitelistSettings":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"OrgAuthSettings":{"type":"object","properties":{"multifactorAuthenticationRequired":{"type":"boolean","description":"Indicates whether multi-factor authentication is required."},"domainAllowlistEnabled":{"type":"boolean","description":"Indicates whether the domain allowlist is enabled."},"domainAllowlist":{"type":"array","description":"The list of domains that will be allowed to embed Genesys Cloud applications.","items":{"type":"string"}},"ipAddressAllowlist":{"type":"array","description":"The list of IP addresses that will be allowed to authenticate with Genesys Cloud.","items":{"type":"string"}},"passwordRequirements":{"description":"The password requirements for the organization.","$ref":"#/definitions/PasswordRequirements"}}},"PasswordRequirements":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"minimumDigits":{"type":"integer","format":"int32"},"minimumLetters":{"type":"integer","format":"int32"},"minimumUpper":{"type":"integer","format":"int32"},"minimumLower":{"type":"integer","format":"int32"},"minimumSpecials":{"type":"integer","format":"int32"},"minimumAgeSeconds":{"type":"integer","format":"int32"},"expirationDays":{"type":"integer","format":"int32"}}},"AuditQueryResponse":{"type":"object"},"Facet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"Filter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"TrusteeAuditQueryRequest":{"type":"object","required":["trusteeOrganizationIds","trusteeUserIds"],"properties":{"trusteeOrganizationIds":{"type":"array","description":"Limit returned audits to these trustee organizationIds.","items":{"type":"string"}},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"TrustEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustee"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trustee":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"usesDefaultRole":{"type":"boolean","description":"Denotes if trustee uses admin role by default."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"trustor":{"description":"The ID of the trustor organization this clone exists in.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents a cloned user in a trustor organization."},"ClonedUserEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ClonedUser"}},"selfUri":{"type":"string","format":"uri"}}},"TrustGroup":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"rolesEnabled":{"type":"boolean","description":"Allow roles to be assigned to this group"},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"dateCreated":{"type":"string","format":"date-time","description":"The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user that added trusted group.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustRequest":{"type":"object","required":["trustee"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"User who created this request.","readOnly":true,"$ref":"#/definitions/OrgUser"},"dateCreated":{"type":"string","format":"date-time","description":"Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustee":{"description":"Trustee organization who generated this request.","readOnly":true,"$ref":"#/definitions/Organization"},"users":{"type":"array","description":"The list of trustee users that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/OrgUser"}},"groups":{"type":"array","description":"The list of trustee groups that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/TrustGroup"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustRequestCreate":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of trustee users that are requesting access. If no users are specified, at least one group is required.","items":{"type":"string"}},"groupIds":{"type":"array","description":"The list of trustee groups that are requesting access. If no groups are specified, at least one user is required.","items":{"type":"string"}}}},"TrustMemberCreate":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Trustee User or Group Id"},"roleIds":{"type":"array","description":"The list of roles to be granted to this user or group. Roles will be granted in all divisions.","items":{"type":"string"}},"roleDivisions":{"description":"The list of trustor organization roles granting this user or group access paired with the divisions for those roles.","$ref":"#/definitions/RoleDivisionGrants"}}},"TrustGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustUpdate":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrustUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustUserDetails":{"$ref":"#/definitions/TrustUserDetails"}}},"TrustUserDetails":{"type":"object","properties":{"dateCreated":{"type":"string","format":"date-time","description":"Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that added trusted user.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustorAuditQueryRequest":{"type":"object","required":["trusteeUserIds","trustorOrganizationId"],"properties":{"trustorOrganizationId":{"type":"string","description":"Limit returned audits to this trustor organizationId."},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"TrustorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustor"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustCreate":{"type":"object","required":["enabled"],"properties":{"pairingId":{"type":"string","description":"The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship. Not required when creating a default pairing with Customer Care."},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"users":{"type":"array","description":"The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"groups":{"type":"array","description":"The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"dateExpired":{"type":"string","format":"date-time","description":"The expiration date of the trust. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"intent":{"type":"string","description":"Indicates the media type scope of this estimated wait time","enum":["ALL","CALL","CALLBACK","CHAT","EMAIL","SOCIALEXPRESSION","VIDEOCOMM","MESSAGE"]},"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCE_ABANDON"]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"UcUserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userId":{"type":"string","description":"User ID of the associated Genesys Cloud user."},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"The registered source ID from where the presence was set"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Presence from a given source for a user"},"MutableUserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The user's id"},"name":{"type":"string"},"source":{"type":"string","description":"Deprecated - The sourceID field should be used as a replacement."},"sourceId":{"type":"string","description":"Represents the ID of a registered source"},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresence":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","description":"The label used for the system presence in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string"},"deactivated":{"type":"boolean"},"primary":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrganizationPresenceDefinition":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of definition","enum":["System","User"]},"languageLabels":{"type":"object","description":"The label used for the definition in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"divisionId":{"type":"string"},"deactivated":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresenceDefinitionEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"PresenceSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"restorePresenceSettings":{"description":"The settings for the restore presence feature","$ref":"#/definitions/RestorePresenceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RestorePresenceSettings":{"type":"object","required":["enabled","restoreOnQueueEnabled","restoreTimeMilliseconds"],"properties":{"enabled":{"type":"boolean","description":"Whether the restore presence feature is enabled"},"restoreTimeMilliseconds":{"type":"integer","format":"int64","description":"How many milliseconds the presence will be restored within"},"restoreOnQueueEnabled":{"type":"boolean","description":"Whether the ON_QUEUE presence will be restored"}}},"Source":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the source"},"description":{"type":"string","description":"The description of the source"},"type":{"type":"string","description":"The type of source","enum":["System","User"]},"deactivated":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Source"}},"selfUri":{"type":"string","format":"uri"}}},"SystemPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserPrimarySource":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sourceId":{"type":"string","description":"The id of the source"},"registered":{"type":"boolean","description":"Whether or not the source is registered"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TestMatchesEventOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matchedTriggers":{"type":"array","description":"Triggers that matched","items":{"$ref":"#/definitions/TestModeTrigger"}},"unmatchedTriggers":{"type":"array","description":"Triggers that did not match","items":{"$ref":"#/definitions/TestModeTrigger"}}},"description":"Results from evaluating matching criteria against test input"},"TestModeEventResults":{"type":"object","properties":{"schemaValidation":{"description":"Information about the validation of the schema of the event body passed in to test mode","$ref":"#/definitions/TestSchemaOperation"},"triggerMatchValidation":{"description":"Information about matched and unmatched triggers","$ref":"#/definitions/TestMatchesEventOperation"}},"description":"Information about event test mode execution"},"TestModeTrigger":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the trigger"},"enabled":{"type":"boolean","description":"Whether or not the trigger is enabled"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Basic identifying information about a trigger"},"TestSchemaOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"type":"string"}}},"description":"Information about the Trigger test mode schema validation step"},"TopicCursorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"string"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}},"description":"Cursor listing of Topics."},"JsonNode":{"type":"object"},"MatchCriteriaTestResult":{"type":"object","properties":{"jsonPath":{"type":"string","description":"The Goessner json path of the field to match"},"operator":{"type":"string","description":"The type of operation to perform for matching check","enum":["GreaterThanOrEqual","LessThanOrEqual","Equal","NotEqual","LessThan","GreaterThan","NotIn","In","Contains","All","Exists","Size"]},"value":{"description":"The value to match on. Only one of value and values can be included","$ref":"#/definitions/JsonNode"},"values":{"type":"array","description":"The list of values to match on. Only one of value and values can be included","items":{"$ref":"#/definitions/JsonNode"}},"generatedJsonPathCondition":{"type":"string","description":"The generated json path condition"},"match":{"type":"boolean","description":"Did the generated json path condition match"},"jsonPathExtraction":{"type":"array","description":"The json paths and their values that were compared","items":{"$ref":"#/definitions/MatchTestResult"}}},"description":"Results of a matching expression"},"MatchTestResult":{"type":"object","properties":{"value":{"description":"The value of the field being matched","$ref":"#/definitions/JsonNode"},"path":{"type":"string","description":"The json path to the json node being matched on. ex: $['things'][1]"}},"description":"Information about the results being matched by the expressions"},"TestMatchesOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"$ref":"#/definitions/MatchCriteriaTestResult"}}},"description":"Information about the Trigger test mode processing step"},"TestModeResults":{"type":"object","properties":{"schemaValidation":{"description":"Information about the validation of the schema of the event body passed in to test mode","$ref":"#/definitions/TestSchemaOperation"},"targetValidation":{"description":"Information about the validation of the trigger target","$ref":"#/definitions/TestTargetOperation"},"jsonPathValidation":{"description":"Information about the json path matching criteria","$ref":"#/definitions/TestMatchesOperation"},"triggerMatches":{"type":"boolean","description":"Whether the trigger would have matched on the provided event body"}},"description":"Information about trigger test mode execution"},"TestTargetOperation":{"type":"object","properties":{"name":{"type":"string","description":"The name of the processing step"},"step":{"type":"integer","format":"int32","description":"The number of the processing step"},"matches":{"type":"boolean","description":"Whether or not the operation matches expectations"},"details":{"type":"array","description":"Details about why the operation did or did not succeed","items":{"type":"string"}}},"description":"Information about the Trigger test mode target validation step"},"MatchCriteria":{"type":"object","properties":{"jsonPath":{"type":"string","description":"The Goessner json path of the field to match"},"operator":{"type":"string","description":"The type of operation to perform for matching check","enum":["GreaterThanOrEqual","LessThanOrEqual","Equal","NotEqual","LessThan","GreaterThan","NotIn","In","Contains","All","Exists","Size"]},"value":{"description":"The value to match on. Only one of value and values can be included","$ref":"#/definitions/JsonNode"},"values":{"type":"array","description":"The list of values to match on. Only one of value and values can be included","items":{"$ref":"#/definitions/JsonNode"}}},"description":"Defines a simple matching condition"},"Trigger":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked"},"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"version":{"type":"integer","format":"int64","description":"Version of this trigger"},"enabled":{"type":"boolean","description":"Whether or not the trigger is enabled"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event","items":{"$ref":"#/definitions/MatchCriteria"}},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a process automation trigger."},"TriggerTarget":{"type":"object","properties":{"type":{"type":"string","description":"The entity type to target","enum":["Workflow"]},"id":{"type":"string","description":"The ID of the entity to target"},"workflowTargetSettings":{"description":"Optional config for the target.","$ref":"#/definitions/WorkflowTargetSettings"}},"description":"The target of a trigger invocation"},"WorkflowTargetSettings":{"type":"object","properties":{"dataFormat":{"type":"string","description":"The data format to use when invoking target.","enum":["Json","TopLevelPrimitives"]}}},"UpdateTriggerRequest":{"type":"object","required":["enabled","name","target","topicName","version"],"properties":{"version":{"type":"integer","format":"int64","description":"Version of this trigger"},"enabled":{"type":"boolean","description":"Boolean indicating if Trigger is enabled"},"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event","items":{"$ref":"#/definitions/MatchCriteria"}},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked. Must match existing trigger topicName."},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."}}},"CreateTriggerRequest":{"type":"object","required":["enabled","name","target","topicName"],"properties":{"target":{"description":"The target to invoke when a matching event is received","$ref":"#/definitions/TriggerTarget"},"enabled":{"type":"boolean","description":"Boolean indicating if Trigger is enabled"},"matchCriteria":{"type":"array","description":"The configuration for when a trigger is considered to be a match for an event. When not provided, all events will fire the trigger","items":{"$ref":"#/definitions/MatchCriteria"}},"name":{"type":"string","description":"The name of the trigger"},"topicName":{"type":"string","description":"The topic that will cause the trigger to be invoked. Cannot be updated after creation. Valid topics can be found at /processautomation/triggers/topics "},"eventTTLSeconds":{"type":"integer","format":"int32","description":"Optional length of time that events are meaningful after origination. Events older than this threshold may be dropped if the platform is delayed in processing events. Unset means events are valid indefinitely, otherwise must be set to at least 10 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"delayBySeconds":{"type":"integer","format":"int32","description":"Optional delay invoking target after trigger fires. Must be in the range of 60 to 900 seconds. Only one of eventTTLSeconds or delayBySeconds can be set."},"description":{"type":"string","description":"Description of the trigger. Can be up to 512 characters in length."}}},"TriggerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trigger"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numCriticalEvaluations":{"type":"integer","format":"int32"},"averageCriticalScore":{"type":"number","format":"float"},"highestEvaluationScore":{"type":"number","format":"float"},"lowestEvaluationScore":{"type":"number","format":"float"},"highestCriticalScore":{"type":"number","format":"float"},"lowestCriticalScore":{"type":"number","format":"float"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string","description":"Conversation id of the result"},"recordingId":{"type":"string","description":"Recording id of the result"},"resultUrl":{"type":"string","description":"URL of results... HTTP GET from this location to download results for this item"},"contentType":{"type":"string","description":"Content type of this result"},"errorMsg":{"type":"string","description":"An error message, in case of failed processing will indicate the cause of the failure"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobStatusResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"jobId":{"type":"string","description":"JobId returned when job was initially submitted"},"expectedResultCount":{"type":"integer","format":"int32","description":"Number of results expected when job is completed"},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available"},"errorCount":{"type":"integer","format":"int32","description":"Number of error results produced so far"},"results":{"type":"array","description":"Current set of results for the job","items":{"$ref":"#/definitions/BatchDownloadJobResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmissionResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmission":{"type":"object","required":["batchDownloadRequestList"],"properties":{"batchDownloadRequestList":{"type":"array","description":"List of up to 100 items requested","items":{"$ref":"#/definitions/BatchDownloadRequest"}}}},"BatchDownloadRequest":{"type":"object","properties":{"conversationId":{"type":"string","description":"Conversation id requested"},"recordingId":{"type":"string","description":"Recording id requested, optional. Leave null for all recordings on the conversation"}}},"CalibrationCreate":{"type":"object","required":["conversation"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"description":"The conversation to use for the calibration.","$ref":"#/definitions/ConversationReference"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CalibrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QualityAuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"userTrusteeOrgId":{"type":"string","description":"Trustee Organization Id if this audit message is from trustee access."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIps":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message.","enum":["RecordingService","RecordingPlaybackService","QualityService"]},"level":{"type":"string","description":"The level of this audit message.","enum":["User","System","GENESYS_INTERNAL"]},"status":{"type":"string","description":"The status of the action of this audit message.","enum":["Success","Failure","Warning"]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageInfo":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place.","enum":["Read","Create","Update","Delete","Abandon","Archive","Export","Download","RestoreRequest","RestoreComplete","ApplyProtection","RevokeProtection","UpdateRetention"]},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted.","enum":["Recording","Evaluation","Calibration","Annotation","ScreenRecording","Survey"]},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}}}},"QualityAuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/QualityAuditLogMessage"}}}},"QualityAuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"]},"dateStart":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/QualityAuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"QualityAuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","TrusteeOnlyAudits","ClientId","Action","EntityType","EntityId","ConversationId","ServiceName"]},"value":{"type":"string","description":"Value of the property to filter."}}},"QMAuditQueryRequest":{"type":"object","required":["filters","interval"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"filters":{"type":"array","description":"List of filters for the query.","items":{"$ref":"#/definitions/QualityAuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"ConversationDeletionProtectionQuery":{"type":"object","required":["conversationIds"],"properties":{"conversationIds":{"type":"array","description":"This is a list of ConversationIds. The list cannot exceed 100 conversationids.","items":{"type":"string"}}}},"EvaluationFormResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"weightMode":{"type":"string","description":"Mode for evaluation form weight","enum":["SCALED","OFF"]},"publishedVersions":{"description":"A list of the published versions of this form. Not populated by default, its availability depends on the endpoint. Use the 'expand=publishHistory' query parameter to retrieve this data where applicable (refer to the endpoint description to see if it is applicable).","$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationFormResponse"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"assignee":{"$ref":"#/definitions/User"},"assigneeApplicable":{"type":"boolean","description":"Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable."},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"assigned":{"type":"boolean","description":"Set to false to unassign the evaluation. This cannot be set to false when assignee is also set."},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"isScoringIndex":{"type":"boolean"},"authorizedActions":{"type":"array","description":"List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit","items":{"type":"string"}},"hasAssistanceFailed":{"type":"boolean","description":"Is true when evaluation assistance didn't execute successfully"},"evaluationSource":{"description":"The source that created the evaluation.","readOnly":true,"$ref":"#/definitions/EvaluationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateBody":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"evaluationForm":{"description":"Evaluation form used for evaluation (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateEvalForm"},"evaluator":{"description":"User ID of the evaluator (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateUser"},"agent":{"description":"User ID of the agent (must be included for a successful request)","$ref":"#/definitions/EvaluationCreateUser"},"agentHasRead":{"type":"boolean"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"calibration":{"$ref":"#/definitions/EvaluationCreateCalibration"},"evaluationContextId":{"type":"string"},"conversation":{"$ref":"#/definitions/EvaluationCreateConversation"},"resourceType":{"type":"string","enum":["EMAIL"]},"evaluationSource":{"$ref":"#/definitions/EvaluationSource"},"rescore":{"type":"boolean"},"queue":{"$ref":"#/definitions/EvaluationCreateQueue"},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED","INREVIEW","RETRACTED"]},"neverRelease":{"type":"boolean"},"dateAssigneeChanged":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignee":{"$ref":"#/definitions/EvaluationCreateUser"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateCalibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateEvalForm":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationCreateUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDiagnosticInfo":{"type":"object","properties":{"lastActionId":{"type":"integer","format":"int32","description":"The step number of the survey invite flow where the error occurred."}}},"QueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Survey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/ConversationReference"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"]},"queue":{"$ref":"#/definitions/QueueReference"},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"completedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"surveyErrorDetails":{"description":"Additional information about what happened when the survey is in Error status.","$ref":"#/definitions/SurveyErrorDetails"},"agentTeam":{"description":"The team that the agent belongs to","$ref":"#/definitions/Team"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyErrorDetails":{"type":"object","properties":{"flowDiagnosticInfo":{"description":"Additional information about any errors that occurred in the survey invite flow.","$ref":"#/definitions/FlowDiagnosticInfo"},"surveyErrorReason":{"type":"string","description":"An error code indicating the reason for the survey failure."}}},"EvaluationAggregationQueryMe":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]},"contextId":{"type":"string","description":"Evaluation context Id"}}},"EvaluationFormResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationFormResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Annotation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64","description":"Offset of annotation in milliseconds."},"durationMs":{"type":"integer","format":"int64","description":"Duration of annotation in milliseconds."},"absoluteLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses)."},"absoluteDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds)."},"recordingLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"},"recordingDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds), adjusted for any recording cuts."},"user":{"description":"User that created this annotation (if any).","$ref":"#/definitions/User"},"description":{"type":"string","description":"Text of annotation. Maximum character limit is 500."},"reason":{"type":"string","description":"Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue","readOnly":true,"enum":["Hold","SecurePause","FlowOrQueue"]},"annotations":{"type":"array","description":"List of annotations","readOnly":true,"items":{"$ref":"#/definitions/Annotation"}},"realtimeLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ButtonResponse":{"type":"object","properties":{"type":{"type":"string","description":"Button response type that captures Button and QuickReply type responses","enum":["Button","QuickReply"]},"text":{"type":"string","description":"Text to show inside the Button reply. This is also used as the response text after clicking on the Button."},"payload":{"type":"string","description":"Content of the textback payload after clicking a button"},"messageType":{"type":"string","description":"Button response message type that captures QuickReply , Cards and Carousel .This is used as label for Card selection","enum":["QuickReply","Card","Carousel"]}}},"Card":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"url":{"type":"string","description":"URL of an image."},"defaultAction":{"description":"The default action to be taken.","$ref":"#/definitions/CardAction"},"actions":{"type":"array","description":"List of possible action objects.","items":{"$ref":"#/definitions/CardAction"}}}},"CardAction":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of action.","enum":["Link","Postback"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"Content of the textback payload after clicking a button."},"url":{"type":"string","description":"The location of the image file associated with action."},"isSelected":{"type":"boolean","description":"Indicates if the card option is selected by end customer."}},"description":"A card action that a user can take."},"ChatMessage":{"type":"object","properties":{"body":{"type":"string","description":"The message body"},"id":{"type":"string"},"to":{"type":"string","description":"The message recipient"},"from":{"type":"string","description":"The message sender"},"utc":{"type":"string"},"chat":{"type":"string","description":"The interaction id (if available)"},"message":{"type":"string","description":"The message id"},"type":{"type":"string"},"bodyType":{"type":"string","description":"Type of the message body (v2 chats only)","enum":["STANDARD","ACTIVITY","TYPING","NOTICE","MEMBERJOIN","MEMBERLEAVE","MEDIAREQUEST"]},"senderCommunicationId":{"type":"string","description":"Communication of sender (v2 chats only)"},"participantPurpose":{"type":"string","description":"Participant purpose of sender (v2 chats only)"},"user":{"description":"The user information for the sender (if available)","$ref":"#/definitions/ChatMessageUser"}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"MediaResult":{"type":"object","properties":{"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"MessageMediaAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object.If null then the media type should be dictated by the url.","enum":["image/png","image/jpeg","image/gif"]},"contentLength":{"type":"integer","format":"int64","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The name of the media object."},"id":{"type":"string","description":"A globally unique identifier for the media object."}}},"MessageStickerAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"id":{"type":"string","description":"A globally unique identifier for the media object."}}},"QuickReply":{"type":"object","properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"},"url":{"type":"string","description":"The location of the image file associated with quick reply"},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.","enum":["Message"]},"isSelected":{"type":"boolean","description":"Indicates if the quick reply option is selected by end customer"}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording. Null when there is no playable media."},"endTime":{"type":"string","description":"The end time of the recording. Null when there is no playable media."},"media":{"type":"string","description":"The media type of the recording. This could be audio, chat, messaging, email, or screen."},"mediaSubtype":{"type":"string","description":"The media subtype of the recording.","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string","description":"The media subject of the recording."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"messagingTranscript":{"type":"array","description":"Represents a messaging transcript","items":{"$ref":"#/definitions/RecordingMessagingMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording. Null when there is no playable media.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outputDurationMs":{"type":"integer","format":"int32","description":"Duration of transcoded media in milliseconds"},"outputSizeInBytes":{"type":"integer","format":"int32","description":"Size of transcoded media in bytes. 0 if there is no transcoded media."},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"users":{"type":"array","description":"The users participating in the conversation","items":{"$ref":"#/definitions/User"}},"recordingFileRole":{"type":"string","description":"Role of the file recording. It can be either customer_experience or adhoc.","enum":["CUSTOMER_EXPERIENCE","ADHOC"]},"recordingErrorStatus":{"type":"string","description":"Status of a recording that cannot be returned because of an error","enum":["EMAIL_TRANSCRIPT_TOO_LARGE"]},"originalRecordingStartTime":{"type":"string","format":"date-time","description":"The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingAnnotationFlow":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The flow name"},"id":{"type":"string","description":"The flow Id"}}},"RecordingAnnotationQueue":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string","description":"The queue name"},"id":{"type":"string","description":"The queue Id"}}},"RecordingContentStory":{"type":"object","properties":{"type":{"type":"string","description":"Type of ephemeral story attachment.","enum":["Mention","Reply"]},"url":{"type":"string","description":"URL to the ephemeral story."},"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."}},"description":"Story object."},"RecordingEmailMessage":{"type":"object","properties":{"htmlBody":{"type":"string"},"textBody":{"type":"string"},"id":{"type":"string"},"to":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"$ref":"#/definitions/EmailAddress"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingMessagingMessage":{"type":"object","properties":{"from":{"type":"string","description":"The message sender session id."},"fromUser":{"description":"The user who sent this message.","$ref":"#/definitions/User"},"fromExternalContact":{"description":"The PureCloud external contact sender details.","$ref":"#/definitions/ExternalContact"},"to":{"type":"string","description":"The message recipient."},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"A globally unique identifier for this communication."},"purpose":{"type":"string","description":"A well known string that specifies the purpose or type of the participant on this communication."},"participantId":{"type":"string","description":"A globally unique identifier for the participant on this communication."},"queue":{"description":"A globally unique identifier for the queue involved in this communication.","$ref":"#/definitions/AddressableEntityRef"},"workflow":{"description":"A globally unique identifier for the workflow involved in this communication.","$ref":"#/definitions/AddressableEntityRef"},"messageText":{"type":"string","description":"The content of this message."},"messageMediaAttachments":{"type":"array","description":"List of media objects attached with this message.","items":{"$ref":"#/definitions/MessageMediaAttachment"}},"messageStickerAttachments":{"type":"array","description":"List of message stickers attached with this message.","items":{"$ref":"#/definitions/MessageStickerAttachment"}},"quickReplies":{"type":"array","description":"List of quick reply options offered with this message.","items":{"$ref":"#/definitions/QuickReply"}},"buttonResponse":{"description":"Button Response selected by user for this message.","$ref":"#/definitions/ButtonResponse"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/RecordingContentStory"},"cards":{"type":"array","description":"List of cards offered for this message","items":{"$ref":"#/definitions/Card"}},"contentType":{"type":"string","description":"Indicates the content type for this message","enum":["QuickReply","Story","Card","Carousel","Attachment","Location","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention","ButtonResponse"]}}},"Endpoint":{"type":"object","required":["name","schema"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"description":"Schema","$ref":"#/definitions/DomainEntityRef"},"enabled":{"type":"boolean"},"site":{"$ref":"#/definitions/DomainEntityRef"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL","SCREEN_RECORDING","PUREENGAGE","PURECONNECT"]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL","SCREEN"]},"mediaSubtype":{"type":"string","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string"},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"orphanStatus":{"type":"string","description":"The status of the orphaned recording's conversation.","enum":["NO_CONVERSATION","UNKNOWN_CONVERSATION","CONVERSATION_NOT_COMPLETE","CONVERSATION_NOT_EVALUATED","EVALUATED"]},"sourceOrphaningId":{"type":"string","description":"An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with"},"region":{"type":"string","enum":["af-south-1","ap-east-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-south-1","ap-southeast-1","ap-southeast-2","ap-southeast-3","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","me-central-1","sa-east-1","us-east-1","us-west-2"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanUpdateRequest":{"type":"object","properties":{"archiveDate":{"type":"string","format":"date-time","description":"The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The orphan recording's delete date. Must be greater than archiveDate and exportDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The orphan recording's export date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"integrationId":{"type":"string","description":"IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set."},"conversationId":{"type":"string","description":"A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media."}}},"OrphanRecordingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishForm":{"type":"object","required":["id","published"],"properties":{"published":{"type":"boolean","description":"Is this form published"},"id":{"type":"string","description":"Unique Id for this version of this form"}}},"SurveyFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording for screen recordings. Null for other types."},"endTime":{"type":"string"},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, email, or message."},"mediaSubtype":{"type":"string","description":"The recording media subtype.","enum":["Trunk","Station","Consult","Screen"]},"mediaSubject":{"type":"string","description":"The recording media subject."},"annotations":{"type":"array","description":"Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.","items":{"$ref":"#/definitions/Annotation"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingRetention":{"type":"object","properties":{"conversationId":{"type":"string"},"recordingId":{"type":"string"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingRetentionCursorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingRetention"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"FailedRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJobFailedRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingJobFailedRecording":{"type":"object","properties":{"conversation":{"description":"Conversation","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"recording":{"description":"Recording","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJob":{"type":"object","required":["state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The current state of the job.","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"]},"recordingJobsQuery":{"description":"Original query of the job.","readOnly":true,"$ref":"#/definitions/RecordingJobsQuery"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"totalConversations":{"type":"integer","format":"int32","description":"Total number of conversations affected.","readOnly":true},"totalRecordings":{"type":"integer","format":"int32","description":"Total number of recordings affected.","readOnly":true},"totalSkippedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings that have been skipped.","readOnly":true},"totalFailedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings that the bulk job failed to process.","readOnly":true},"totalProcessedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings have been processed.","readOnly":true},"percentProgress":{"type":"integer","format":"int32","description":"Progress in percentage based on the number of recordings","readOnly":true},"errorMessage":{"type":"string","description":"Error occurred during the job execution","readOnly":true},"failedRecordings":{"type":"string","description":"Get IDs of recordings that the bulk job failed for","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJobsQuery":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":"Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date.","enum":["ARCHIVE","DELETE","EXPORT"]},"actionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"actionAge":{"type":"integer","format":"int32","description":"The number of days after each recording's creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings."},"screenRecordingActionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"screenRecordingActionAge":{"type":"integer","format":"int32","description":"The number of days after each screen recording's creation date when the action will be performed. If this is provided then includeScreenRecordings must be true."},"integrationId":{"type":"string","description":"IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action."},"includeRecordingsWithSensitiveData":{"type":"boolean","description":"Whether to include recordings with PCI DSS and/or PII data, default value = false "},"includeScreenRecordings":{"type":"boolean","description":"Whether to include Screen recordings for the action, default value = true "},"clearExport":{"type":"boolean","description":"For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false"},"conversationQuery":{"description":"Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. This result depends on the analytics data lake job completion. See also: https://developer.genesys.cloud/analyticsdatamanagement/analytics/jobs/conversation-details-job#data-availability.This is supported only when querying for conversations up to and including 5 years old.","$ref":"#/definitions/AsyncConversationQuery"},"agedConversationInterval":{"type":"string","description":"As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}},"ExecuteRecordingJobsQuery":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The desired state for the job to be set to.","enum":["PROCESSING"]}}},"RecordingJobEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32","description":"Maximum number of simultaneous screen recording streams"},"maxConfigurableScreenRecordingStreams":{"type":"integer","format":"int32","description":"Upper limit that maxSimultaneousStreams can be configured"},"regionalRecordingStorageEnabled":{"type":"boolean","description":"Store call recordings in the region where they are intended to be recorded, otherwise in the organization's home region"}}},"RecordingUploadReport":{"type":"object","properties":{"id":{"type":"string","description":"The report id."},"name":{"type":"string"},"state":{"type":"string","description":"The current status of the upload report.","enum":["InProgress","Completed","Failed"]},"signedUrl":{"type":"string","description":"For COMPLETED tasks, the signed url to download the report."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingUploadReportRequest":{"type":"object","required":["dateSince"],"properties":{"dateSince":{"type":"string","format":"date-time","description":"Report will include uploads since this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadStatus":{"type":"string","description":"Report will include uploads with this status","enum":["Pending","Success","Failure","WaitForConversation"]}}},"ScreenRecordingMetaData":{"type":"object","properties":{"trackId":{"type":"string"},"mediaId":{"type":"string"},"screenId":{"type":"string"},"originX":{"type":"integer","format":"int32"},"originY":{"type":"integer","format":"int32"},"primary":{"type":"boolean"},"main":{"type":"boolean"}}},"ScreenRecordingMetaDataRequest":{"type":"object","properties":{"participantJid":{"type":"string"},"roomId":{"type":"string"},"metaData":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingMetaData"}}}},"ScreenRecordingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"communicationId":{"type":"string","description":"The id of the communication that is being recorded on the conversation"},"conversation":{"$ref":"#/definitions/Conversation"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScreenRecordingSessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingSession"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScreenRecordingActiveSessions":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Current concurrent active screen recordings count for organization"}}},"ScreenRecordingSessionRequest":{"type":"object","properties":{"state":{"type":"string","description":"The screen recording session's state. Values can be: 'stopped'","enum":["STOPPED"]},"archiveDate":{"type":"string","format":"date-time","description":"The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AcknowledgeScreenRecordingRequest":{"type":"object","properties":{"participantJid":{"type":"string"},"roomId":{"type":"string"},"conversationId":{"type":"string"}}},"SurveyFormAndScoringSet":{"type":"object","properties":{"surveyForm":{"$ref":"#/definitions/SurveyForm"},"answers":{"$ref":"#/definitions/SurveyScoringSet"}}},"AlertNotification":{"type":"object","required":["notificationTypes","recipient"],"properties":{"recipient":{"type":"string","description":"The entity to receive the notification."},"notificationTypes":{"type":"array","description":"The notification types the user will receive.","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}},"locale":{"type":"string","description":"The locale whose language will be used when sending alerts. Locale should be in theformat language_COUNTRY where language is always lower case and country is always upper case."}}},"AlertRuleProperties":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"type":{"type":"string","description":"The type of rule being alerted.","readOnly":true,"enum":["ConversationMetrics","UserPresence","WorkforceManagement","Unknown"]}}},"AlertSummary":{"type":"object","required":["entities","entitiesAreTeamMembers","metricType"],"properties":{"entities":{"type":"array","description":"The entities who violated the rule condition over the duration of the alert.","items":{"$ref":"#/definitions/AlertSummaryEntity"}},"conversation":{"description":"The id of the conversation that triggered the alert. Only used for alerts based on instance-based conversation metrics.","$ref":"#/definitions/AddressableEntityRef"},"metricType":{"type":"string","description":"The metric type that is monitored.","enum":["Interval","Instance"]},"entitiesAreTeamMembers":{"type":"boolean","description":"Flag that indicated whether or not the alert is for a rule with a condition for all members of a team."}}},"AlertSummaryEntity":{"type":"object","required":["alerting","entityType"],"properties":{"entityType":{"type":"string","description":"Specifies the type of entity being evaluated","enum":["User","Group","Queue","Team","TeamMembers"]},"user":{"description":"User id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"group":{"description":"Group id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"Queue id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"team":{"description":"Team id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"alerting":{"type":"boolean","description":"Flag that indicated if the entity is current causing the alert to be triggered"}}},"CommonAlert":{"type":"object","required":["active","conditions","dateMutedUntil","dateSnoozedUntil","dateStart","muted","notifications","rule","snoozed","unread","user","waitBetweenNotificationMs"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user who created the rule that triggered the alert.","$ref":"#/definitions/UserReference"},"rule":{"description":"The properties of the rule that triggered the alert.","$ref":"#/definitions/AlertRuleProperties"},"notifications":{"type":"array","description":"The collection of notification methods and the ids of users who were notified by those methods.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"dateStart":{"type":"string","format":"date-time","description":"The timestamp of when the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The timestamp of when the alert ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean","description":"Indicates if an alert is currently active."},"unread":{"type":"boolean","description":"Indicates if an alert has not been read."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time to wait between notification. Time is in milliseconds."},"muted":{"type":"boolean","description":"Flag indicating if the alert is in a muted state."},"snoozed":{"type":"boolean","description":"Flag indicating if the alert is in a snoozed state."},"dateMutedUntil":{"type":"string","format":"date-time","description":"Timestamp of when the mute status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateSnoozedUntil":{"type":"string","format":"date-time","description":"Timestamp of when the snooze status of the alert should end. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conditions":{"description":"The conditions that make up the rule.","$ref":"#/definitions/CommonRuleConditions"},"conversationId":{"type":"string","description":"The id of the conversation instance that caused the alert to trigger."},"alertSummary":{"description":"Summary of the alert status of the entities defined in the conditions. Is set when rule has instance-based or team member based rule predicates","$ref":"#/definitions/AlertSummary"},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonRuleConditions":{"type":"object","required":["predicates","type"],"properties":{"clauses":{"type":"array","description":"The list of predicates groups to be evaluated","items":{"$ref":"#/definitions/CommonRuleConditions"}},"predicates":{"type":"array","description":"The list of rule metric predicates to be evaluated.","items":{"$ref":"#/definitions/CommonRulePredicate"}},"type":{"type":"string","description":"the logic operator performed.","enum":["And","Or","Not"]},"id":{"type":"string","description":"The id."}}},"CommonRulePredicate":{"type":"object","required":["comparisonOperator","entity","metric","metricType","metricValueType","value"],"properties":{"metricType":{"type":"string","description":"The type of metric being evaluated.","enum":["Interval","Instance"]},"metricValueType":{"type":"string","description":"The type of metric value being evaluated.","enum":["Count","Min","Timer","Max","Percentage","Average","Observation"]},"comparisonOperator":{"type":"string","description":"The comparison operator being performed on the metric.","enum":["Gt","Gte","Lt","Lte","Eq","Ne"]},"value":{"type":"number","format":"double","description":"The value the metric will be compared to."},"status":{"type":"string","description":"The status of the entity corresponding to the metric."},"entity":{"description":"The entity whose metric is being represented.","$ref":"#/definitions/CommonRulePredicateEntity"},"mediaType":{"type":"string","description":"The media type of the conversation the metric describes.","enum":["Voice","Chat","Email","Callback","Message"]},"metric":{"type":"string","description":"The metric being evaluated.","enum":["nAbandon","nConnected","nInteractions","nOffered","nOutbound","nTransferred","serviceLevel","oServiceLevel","oWaiting","tAbandon","tAcw","tAlert","tAnswered","tHandle","tHeldComplete","tTalkComplete","tWait","tTalk","tHeld","tOrganizationPresence","tSystemPresence","tAgentRoutingStatus","oUserRoutingStatuses","oUserPresences","oInteracting","tFlowOut","tAdherenceStatus"]}}},"CommonRulePredicateEntity":{"type":"object","required":["entityType"],"properties":{"entityType":{"type":"string","description":"Specifies the type of entity being evaluated","enum":["User","Group","Queue","Team","TeamMembers"]},"user":{"description":"User id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"group":{"description":"Group id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"queue":{"description":"Queue id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"},"team":{"description":"Team id of the entity being monitored","$ref":"#/definitions/AddressableEntityRef"}}},"AlertRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The action being taken on the alert.","enum":["Mute","Snooze","Unread"]},"dateStart":{"type":"string","format":"date-time","description":"The start date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The end date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"unread":{"description":"The fields need for an unread update requests","$ref":"#/definitions/UnreadFields"},"validRequest":{"type":"boolean"}}},"UnreadFields":{"type":"object","required":["state"],"properties":{"state":{"type":"boolean","description":"The new unread state of the alert"}}},"AlertingUnreadStatus":{"type":"object","required":["unread"],"properties":{"unread":{"type":"boolean","description":"True is alert is unread, false if it has not been."}}},"CommonAlertBulkUpdateRequest":{"type":"object","required":["alertIds","type"],"properties":{"type":{"type":"string","description":"The action to take","enum":["Mute","Snooze","Unread"]},"alertIds":{"type":"array","description":"The user supplied alert ids to be muted","uniqueItems":true,"items":{"type":"string"}},"muteSnooze":{"description":"The fields need for a mute or snooze requests","$ref":"#/definitions/MuteSnoozeFields"},"unread":{"description":"The fields need for an unread update requests","$ref":"#/definitions/UnreadFields"}}},"MuteSnoozeFields":{"type":"object","required":["dateEnd","dateStart"],"properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The end date of the mute/snooze period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AlertListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GetAlertQuery":{"type":"object","required":["queryType","ruleType"],"properties":{"ruleType":{"type":"string","description":"The rule type of the alerts the query will return","enum":["Conversation","Presence","All"]},"queryType":{"type":"string","description":"The type of query being performed.","enum":["Info","Count"]},"alertStatus":{"type":"string","description":"The status of the alerts the query will return.","enum":["Active","Inactive","All"]},"viewedStatus":{"type":"string","description":"The view status of the alerts the query will return.","enum":["Unread","Read","All"]},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The field to sort responses by. The accepted choices are Name and DateStart","enum":["Name","DateStart"]},"sortOrder":{"type":"string","description":"The order in which response will be sorted. The accepted choices are Asc and Desc","enum":["Asc","Desc"]}}},"CommonRule":{"type":"object","required":["name","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"description":{"type":"string","description":"The description of the rule."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"notifications":{"type":"array","description":"The alert notification types to trigger when alarm state changes as well as the users they will be sent to.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"sendExitingAlarmNotifications":{"type":"boolean","description":"Indicates if the alert will send a notification when it is closed."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time in milliseconds to wait between notification."},"conditions":{"description":"The set of metric conditions that would trigger an alert.","$ref":"#/definitions/CommonRuleConditions"},"type":{"type":"string","description":"The type of the rule.","enum":["ConversationMetrics","UserPresence","WorkforceManagement","Unknown"]},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state."},"user":{"description":"The entity that created the rule.","$ref":"#/definitions/UserReference"},"version":{"type":"integer","format":"int32","description":"The current version number of the rule."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the rule when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateLastModified":{"type":"string","format":"date-time","description":"The timestamp of the last update to the rule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ModifiableRuleProperties":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"description":{"type":"string","description":"The description of the rule."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"notifications":{"type":"array","description":"The alert notification types to trigger when alarm state changes as well as the users they will be sent to.","uniqueItems":true,"items":{"$ref":"#/definitions/AlertNotification"}},"sendExitingAlarmNotifications":{"type":"boolean","description":"Indicates if the alert will send a notification when it is closed."},"waitBetweenNotificationMs":{"type":"integer","format":"int64","description":"The amount of time in milliseconds to wait between notification."},"conditions":{"description":"The set of metric conditions that would trigger an alert.","$ref":"#/definitions/CommonRuleConditions"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonRuleBulkUpdateNotificationsRequest":{"type":"object","required":["ruleIds"],"properties":{"ruleIds":{"type":"array","description":"The user supplied rules ids to be updated","uniqueItems":true,"items":{"type":"string"}},"properties":{"description":"The rule properties to be updated","$ref":"#/definitions/ModifiableRuleProperties"},"typesToAdd":{"type":"array","description":"Collection of alerting notification types to add for all entities in the rules","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}},"typesToRemove":{"type":"array","description":"Collection of alerting notification types to remove for all entities in the rules","uniqueItems":true,"items":{"type":"string","enum":["Sms","Device","Email","Push"]}}}},"CommonRuleBulkDeleteRequest":{"type":"object","required":["ruleIds"],"properties":{"ruleIds":{"type":"array","description":"The user supplied rule ids to be deleted","items":{"type":"string"}}}},"CommonRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GetRulesQuery":{"type":"object","required":["queryType","ruleType"],"properties":{"ruleType":{"type":"string","description":"The rule type of the alerts the query will return","enum":["Conversation","Presence","All"]},"queryType":{"type":"string","description":"The type of query being performed.","enum":["Info","Count"]},"enabledType":{"type":"string","description":"The state of the rule the query will return. The accepted choices are Enabled, Disabled, or All","enum":["Enabled","Disabled","All"]},"pageNumber":{"type":"integer","format":"int32","description":"The page number of the queried response"},"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return of the queried response. The max is 25"},"sortBy":{"type":"string","description":"The field to sort responses by. The accepted choices are Name and DateStart","enum":["Name","DateCreated"]},"sortOrder":{"type":"string","description":"The order in which response will be sorted. The accepted choices are Asc and Desc","enum":["Asc","Desc"]},"ruleName":{"type":"string","description":"The name of the rule being queries."},"nameSearchType":{"type":"string","description":"Specifies how strict the name search needs to be. Expected values are Exact and Contains if querying by name.","enum":["Exact","Contains","Unknown"]}}},"Library":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The library name."},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"createdBy":{"description":"User that created the library.","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"responseType":{"type":"string","description":"This value is deprecated. Responses representing message templates may be added to any library.","enum":["MessagingTemplate","CampaignSmsTemplate","CampaignEmailTemplate","Footer"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LibraryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LibraryBatchRequest":{"type":"object","required":["libraryIds"],"properties":{"libraryIds":{"type":"array","description":"List of Library IDs","items":{"type":"string"}}}},"FooterTemplate":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type represented by Footer.","enum":["Signature"]},"applicableResources":{"type":"array","description":"Specifies the canned response template where the footer can be used.","items":{"type":"string","enum":["Campaign"]}}},"description":"The Footer template identifies the Footer type and its footerUsage"},"MessagingTemplate":{"type":"object","properties":{"whatsApp":{"description":"Defines a messaging template for a WhatsApp messaging channel","$ref":"#/definitions/WhatsAppDefinition"}},"description":"The messaging template identifies a structured message templates supported by a messaging channel."},"Response":{"type":"object","required":["libraries","texts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"libraries":{"type":"array","description":"One or more libraries response is associated with.","items":{"$ref":"#/definitions/DomainEntityRef"}},"texts":{"type":"array","description":"One or more texts associated with the response.","items":{"$ref":"#/definitions/ResponseText"}},"createdBy":{"description":"User that created the response","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"substitutions":{"type":"array","description":"Details about any text substitutions used in the texts for this response.","items":{"$ref":"#/definitions/ResponseSubstitution"}},"substitutionsSchema":{"description":"Metadata about the text substitutions in json schema format.","$ref":"#/definitions/JsonSchemaDocument"},"responseType":{"type":"string","description":"The response type represented by the response.","enum":["MessagingTemplate","CampaignSmsTemplate","CampaignEmailTemplate","Footer"]},"messagingTemplate":{"description":"An optional messaging template definition for responseType.MessagingTemplate.","$ref":"#/definitions/MessagingTemplate"},"assets":{"type":"array","description":"Assets used in the response","items":{"$ref":"#/definitions/AddressableEntityRef"}},"footer":{"description":"Footer template definition for responseType.Footer.","$ref":"#/definitions/FooterTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"ResponseEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"ResponseSubstitution":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Response substitution identifier."},"description":{"type":"string","description":"Response substitution description."},"defaultValue":{"type":"string","description":"Response substitution default value."}},"description":"Contains information about the substitutions associated with a response."},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name","namespace"],"properties":{"name":{"type":"string","description":"The messaging template name."},"namespace":{"type":"string","description":"The messaging template namespace."},"language":{"type":"string","description":"The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US'"}},"description":"A WhatsApp messaging template definition as defined in the WhatsApp Business Manager"},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name', 'libraryId', 'text.contentType', 'messagingTemplate' and 'responseType'"},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"]},"values":{"type":"array","description":"Values to filter on. If name is 'responseType' then allowed values are 'CampaignSmsTemplate', 'CampaignEmailTemplate', 'Footer' and 'Signature'","items":{"type":"string"}}},"description":"Used to filter response queries"},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseFilter"}}},"description":"Used to query for responses"},"ResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"contentLength":{"type":"integer","format":"int64","description":"response asset size in bytes"},"contentLocation":{"type":"string","description":"response asset location."},"contentType":{"type":"string","description":"MIME type of response asset"},"dateCreated":{"type":"string","format":"date-time","description":"Created date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User who created the response asset","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"User who last modified the response asset","$ref":"#/definitions/DomainEntityRef"},"responses":{"type":"array","description":"Canned responses actively using this asset","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseAssetRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"divisionId":{"type":"string","description":"Division to associate to this asset. Can only be used with this division."}}},"ResponseAssetStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"Upload status of the asset","readOnly":true,"enum":["InProgress","Uploaded","Failed"]},"errorCode":{"type":"string","description":"Error code. Used for localization","readOnly":true},"errorMessage":{"type":"string","description":"Error message that explains upload failure status ","readOnly":true}}},"CreateResponseAssetResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"url":{"type":"string","description":"Pre-signed URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"CreateResponseAssetRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"divisionId":{"type":"string","description":"Division to associate to this asset. Can only be used with this division."},"contentMd5":{"type":"string","description":"Content MD-5 of the file to upload"}}},"ResponseAssetSearchResults":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/ResponseAsset"}}}},"ResponseAssetFilter":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format"},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format"},"fields":{"type":"array","description":"Field name to search against. Allowed Values: divisionId, name, contentLength, contentType, dateCreated","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"type":{"type":"string","description":"How to apply this search criteria against other criteria. Filter type supported for each field:- name:[STARTS_WITH, TERM], divisionId:[TERM, TERMS], contentLength:[RANGE, GREATER_THAN_EQUAL_TO, LESS_THAN_EQUAL_TO], contentType:[STARTS_WITH, TERM] dateCreated:[DATE_RANGE]","enum":["TERM","TERMS","STARTS_WITH","RANGE","GREATER_THAN_EQUAL_TO","LESS_THAN_EQUAL_TO","DATE_RANGE"]}}},"ResponseAssetSearchRequest":{"type":"object","required":["query"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of results per page. Default: 25, Maximum: 100."},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"query":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseAssetFilter"}}}},"AvailableMediaType":{"type":"object","properties":{"mediaType":{"type":"string","description":"Name of the available media type"},"availableSubTypes":{"type":"array","description":"List of available subtypes for this media type","items":{"type":"string"}}}},"AvailableMediaTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableMediaType"}}}},"ComparisonPeriod":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"kpi":{"type":"string","description":"Key Performance Indicator optimised during the comparison period.","readOnly":true},"dateStarted":{"type":"string","format":"date-time","description":"Start date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateEnded":{"type":"string","format":"date-time","description":"End date of the comparison period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"percentageBenefit":{"type":"number","format":"double","description":"The percentage benefit on this queue for the duration of the comparison period","readOnly":true},"kpiResults":{"type":"array","description":"KPI results for each metric","readOnly":true,"items":{"$ref":"#/definitions/KpiResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ComparisonPeriodListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ComparisonPeriod"}},"selfUri":{"type":"string","format":"uri"}}},"KpiResult":{"type":"object","properties":{"kpiTotalOn":{"type":"integer","format":"int64","description":"Absolute metric (in which the KPI is based) total for the interactions handled by predictive routing (GPR was on)","readOnly":true},"kpiTotalOff":{"type":"integer","format":"int64","description":"Absolute metric (in which the KPI is based) total for the interactions not routed by predictive routing (GPR was off)","readOnly":true},"interactionCountOn":{"type":"integer","format":"int64","description":"Total interactions handled by predictive routing (GPR was on)","readOnly":true},"interactionCountOff":{"type":"integer","format":"int64","description":"Total interactions not routed by predictive routing (GPR was off)","readOnly":true},"mediaType":{"type":"string","description":"Media type used for the KPI","readOnly":true,"enum":["voice","email","message"]},"percentageBenefit":{"type":"number","format":"double","description":"The percentage benefit for this media type for the duration of the comparison period","readOnly":true}}},"QueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapupCodeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WrapUpCodeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"joined":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserQueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateQueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The total number of members in the queue.","readOnly":true},"userMemberCount":{"type":"integer","format":"int32","description":"The number of user members (i.e., non-group members) in the queue.","readOnly":true},"joinedMemberCount":{"type":"integer","format":"int32","description":"The number of joined members in the queue.","readOnly":true},"mediaSettings":{"description":"The media settings for the queue.","$ref":"#/definitions/QueueMediaSettings"},"routingRules":{"type":"array","description":"The routing rules for the queue, used for Preferred Agent Routing.","items":{"$ref":"#/definitions/RoutingRule"}},"conditionalGroupRouting":{"description":"The Conditional Group Routing settings for the queue.","$ref":"#/definitions/ConditionalGroupRouting"},"bullseye":{"description":"The bullseye settings for the queue.","$ref":"#/definitions/Bullseye"},"scoringMethod":{"type":"string","description":"The Scoring Method for the queue","enum":["TimestampAndPriority","PriorityOnly"]},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"]},"memberGroups":{"type":"array","description":"The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes.","uniqueItems":true,"items":{"$ref":"#/definitions/MemberGroup"}},"queueFlow":{"description":"The in-queue flow to use for call conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"emailInQueueFlow":{"description":"The in-queue flow to use for email conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"messageInQueueFlow":{"description":"The in-queue flow to use for message conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"onHoldPrompt":{"description":"The audio to be played when calls on this queue are on hold. If not configured, the default on-hold music will play.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableAudioMonitoring":{"type":"boolean","description":"Indicates whether audio monitoring is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"agentOwnedRouting":{"description":"The Agent Owned Routing settings for the queue","$ref":"#/definitions/AgentOwnedRouting"},"directRouting":{"description":"The Direct Routing settings for the queue","$ref":"#/definitions/DirectRouting"},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"peerId":{"type":"string","description":"The ID of an associated external queue."},"suppressInQueueCallRecording":{"type":"boolean","description":"Indicates whether recording in-queue calls is suppressed for this queue."},"sourceQueueId":{"type":"string","description":"The id of an existing queue to copy the settings (does not include GPR settings) from when creating a new queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptionSettings":{"type":"object","required":["transcription","transcriptionConfidenceThreshold"],"properties":{"transcription":{"type":"string","description":"Setting to enable/disable transcription capability","enum":["Disabled","EnabledGlobally","EnabledQueueFlow"]},"transcriptionConfidenceThreshold":{"type":"integer","format":"int32","description":"Configure confidence threshold. The possible values are from 1 to 100."},"lowLatencyTranscriptionEnabled":{"type":"boolean","description":"Boolean flag indicating whether low latency transcription via Notification API is enabled"},"contentSearchEnabled":{"type":"boolean","description":"Setting to enable/disable content search"},"pciDssRedactionEnabled":{"type":"boolean","description":"Setting to enable/disable PCI DSS Redaction"},"piiRedactionEnabled":{"type":"boolean","description":"Setting to enable/disable PII Redaction"}}},"ContactCenterSettings":{"type":"object","properties":{"removeSkillsFromBlindTransfer":{"type":"boolean","description":"Strip skills from transfer"}}},"RoutingSettings":{"type":"object","properties":{"resetAgentScoreOnPresenceChange":{"type":"boolean","description":"Reset agent score when agent presence changes from off-queue to on-queue"}}},"RoutingSkill":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the skill."},"dateModified":{"type":"string","format":"date-time","description":"Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UtilizationLabel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateUtilizationLabelRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization label name."}}},"UtilizationLabelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UtilizationLabel"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateUtilizationLabelRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization label name."},"utilization":{"description":"Org level utilization settings for the new label. If not specified, default utilization settings will be applied.","$ref":"#/definitions/LabelUtilizationRequest"}}},"LabelUtilizationRequest":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of interactions with this label that an agent can handle at one time."},"interruptingLabelIds":{"type":"array","description":"Defines other labels that can interrupt an interaction with this label.","uniqueItems":true,"items":{"type":"string"}}}},"LabelUtilizationResponse":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of interactions with this label that an agent can handle at one time."},"interruptingLabelIds":{"type":"array","description":"Defines other labels that can interrupt an interaction with this label.","uniqueItems":true,"items":{"type":"string"}},"labelName":{"type":"string","description":"Name of the label this utilization relates to."}}},"MediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type. Values include call, chat, email, callback, and message.","items":{"type":"string"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization"}}},"UtilizationResponse":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}},"labelUtilizations":{"type":"object","description":"Map of label ids to utilization settings.","additionalProperties":{"$ref":"#/definitions/LabelUtilizationResponse"}}}},"UtilizationRequest":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}},"labelUtilizations":{"type":"object","description":"Map of label ids to utilization settings.","additionalProperties":{"$ref":"#/definitions/LabelUtilizationRequest"}}}},"BenefitAssessment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"queues":{"type":"array","description":"The list of queues that are assessed for Predictive Routing benefit.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}},"kpiAssessments":{"type":"array","description":"A set of key performance indicators applied on the queue to determine suitability of Predictive Routing.","readOnly":true,"items":{"$ref":"#/definitions/KeyPerformanceIndicatorAssessment"}},"state":{"type":"string","description":"State of the benefit assessment.","readOnly":true,"enum":["Created","Finished","Failed"]},"jobId":{"type":"string","description":"The unique identifier of job that created this benefit assessment.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Creation Date of the benefit assessment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Modified Date of the benefit assessment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Check":{"type":"object","properties":{"result":{"type":"string","description":"The result of a check executed. This indicates if the check was successful or not.","readOnly":true,"enum":["Passed","Failed","Unknown","Skipped","Error"]},"type":{"type":"string","description":"The type of check executed.","readOnly":true,"enum":["HandleTimeValue","TransferRateValue","SalesConversionRateValue","SalesAmountValue","RetentionRateValue","ChurnRateValue","InteractionVolume","UserVariance","DataCoverage","ModelQuality"]}}},"KeyPerformanceIndicatorAssessment":{"type":"object","properties":{"kpi":{"type":"string","description":"Name of the key performance indicator assessed.","readOnly":true},"assessmentResult":{"type":"string","description":"The overall result of the assessment for a key performance indicator.","readOnly":true,"enum":["Unknown","NotSupported","High","Low","Error"]},"checks":{"type":"array","description":"Set of checks executed as part of an assessment.","readOnly":true,"items":{"$ref":"#/definitions/Check"}}}},"CreateBenefitAssessmentRequest":{"type":"object","required":["queueIds"],"properties":{"queueIds":{"type":"array","description":"The list of queue ids that are to be assessed for Predictive Routing benefit.","items":{"type":"string"}}}},"AssessmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BenefitAssessment"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"BenefitAssessmentJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"State of the benefit assessment job.","readOnly":true,"enum":["Created","Finished"]},"dateCreated":{"type":"string","format":"date-time","description":"Creation Date of the benefit assessment job. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Modified Date of the benefit assessment job. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateBenefitAssessmentJobRequest":{"type":"object","properties":{"divisionIds":{"type":"array","description":"The list of division ids for routing queues that are to be assessed for Predictive Routing benefit.","items":{"type":"string"}}}},"AssessmentJobListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/BenefitAssessmentJob"}},"selfUri":{"type":"string","format":"uri"}}},"RoutingConversationAttributesResponse":{"type":"object","properties":{"priority":{"type":"integer","format":"int32","description":"Current priority value on in-queue conversation. Range:[-25000000, 25000000]"},"skills":{"type":"array","description":"Current routing skills on in-queue conversation","items":{"$ref":"#/definitions/RoutingSkill"}},"language":{"description":"Current language on in-queue conversation","$ref":"#/definitions/Language"},"scoredAgents":{"type":"array","description":"Current scored agents on in-queue conversation","items":{"$ref":"#/definitions/ScoredAgent"}}}},"RequestScoredAgent":{"type":"object","properties":{"id":{"type":"string","description":"Agent's user ID"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"RoutingConversationAttributesRequest":{"type":"object","properties":{"priority":{"type":"integer","format":"int32","description":"Priority for the conversation. Each point of priority is equivalent to one minute of time in queue. Range:[-25000000, 25000000]. To reset, specify 0.","minimum":-25000000,"maximum":25000000},"skillIds":{"type":"array","description":"Skill requirements for the conversation. To remove all skill requirements, specify an empty list, i.e. [].","items":{"type":"string"}},"languageId":{"type":"string","description":"Language requirement for the conversation. To remove the language requirement, specify an empty string, i.e., \"\"."},"requestScoredAgents":{"type":"array","items":{"$ref":"#/definitions/RequestScoredAgent"}}}},"EmailErrorInfo":{"type":"object","properties":{"message":{"type":"string","description":"Error Message","readOnly":true},"code":{"type":"string","description":"Error Code","readOnly":true}}},"ImapSettings":{"type":"object","properties":{"integration":{"description":"The IMAP server integration to use for ingesting emails.","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"Imap Server Status","readOnly":true,"enum":["Active","AwaitingFolders","Error","Inactive","IntegrationDeleted","Unknown"]},"errorInfo":{"description":"Additional Imap Server error information","readOnly":true,"$ref":"#/definitions/EmailErrorInfo"}}},"InboundDomain":{"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"mxRecordStatus":{"type":"string","description":"Mx Record Status","enum":["VALID","INVALID","NOT_AVAILABLE"]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email."},"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"imapSettings":{"description":"The IMAP server integration and settings to use for processing inbound emails.","$ref":"#/definitions/ImapSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MailFromResult":{"type":"object","required":["mailFromDomain"],"properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}},"mailFromDomain":{"type":"string","description":"The custom MAIL FROM domain."}}},"Record":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the record."},"type":{"type":"string","description":"The type of the record. (Example values: MX, TXT, CNAME)"},"value":{"type":"string","description":"The value of the record."}}},"InboundDomainPatchRequest":{"type":"object","properties":{"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"imapSettings":{"description":"The IMAP server integration and settings to use for processing inbound emails.","$ref":"#/definitions/ImapSettings"}}},"VerificationResult":{"type":"object","properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}}}},"TestMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"After the message has been sent, this is the value of the Message-ID email header.","readOnly":true},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message"},"time":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"InboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"OutboundDomain":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"cnameVerificationResult":{"description":"CNAME registration Status","$ref":"#/definitions/VerificationResult"},"dkimVerificationResult":{"description":"DKIM registration Status","$ref":"#/definitions/VerificationResult"},"senderType":{"type":"string","description":"Sender Type","enum":["Unknown","EmailDomain","MockEmailDomain"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DnsRecordEntry":{"type":"object","properties":{"host":{"type":"string","description":"the hostname of the DNS entry"},"recordContents":{"type":"string","description":"the payload of the DNS entry"},"verificationStatus":{"type":"string","description":"the current status of the related verification process","enum":["Pending","Verified","Failed","Unknown"]}}},"EmailOutboundDomainResult":{"type":"object","properties":{"dnsCnameBounceRecord":{"$ref":"#/definitions/DnsRecordEntry"},"dnsTxtSendingRecord":{"$ref":"#/definitions/DnsRecordEntry"},"domainName":{"type":"string"},"senderStatus":{"type":"string","enum":["RequestReceived","ProvisionRequestSentVendor","Provisioned","Error","Deprovisioned"]},"senderType":{"type":"string","enum":["Unknown","EmailDomain","MockEmailDomain"]}}},"OutboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Flow":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"type":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"lockedUser":{"description":"User that has the flow locked.","$ref":"#/definitions/User"},"lockedClient":{"description":"OAuth client that has the flow locked.","$ref":"#/definitions/DomainEntityRef"},"active":{"type":"boolean"},"system":{"type":"boolean"},"deleted":{"type":"boolean"},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"inputSchema":{"type":"object","description":"json schema describing the inputs for the flow"},"outputSchema":{"type":"object","description":"json schema describing the outputs for the flow"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"debugVersion":{"$ref":"#/definitions/FlowVersion"},"publishedBy":{"$ref":"#/definitions/User"},"currentOperation":{"$ref":"#/definitions/Operation"},"nluInfo":{"description":"Information about the natural language understanding configuration for the published version of the flow","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"compatibleFlowTypes":{"type":"array","description":"Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration. Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.","readOnly":true,"items":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The flow version identifier"},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"]},"secure":{"type":"boolean"},"debug":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdByClient":{"$ref":"#/definitions/DomainEntityRef"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"dateCheckedIn":{"type":"integer","format":"int64"},"dateSaved":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"inputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"datePublished":{"type":"string","format":"date-time","description":"The date this version became the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublishedEnd":{"type":"string","format":"date-time","description":"The date this version was no longer the published version of the flow. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"nluInfo":{"description":"Information about the natural language understanding configuration for the flow version","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for this version of the flow","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"compatibleFlowTypes":{"type":"array","description":"Compatible flow types designate which flow types are allowed to embed a flow’s configuration within their own flow configuration. Currently the only flows that can be embedded are Common Module flows and the embedding flow can invoke them using the Call Common Module action.","readOnly":true,"items":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Intent":{"type":"object","properties":{"name":{"type":"string"}}},"NluInfo":{"type":"object","properties":{"domain":{"readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"intents":{"type":"array","items":{"$ref":"#/definitions/Intent"}},"engineVersion":{"type":"string"},"nluData":{"$ref":"#/definitions/NluDomainVersion"}}},"Operation":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","CHECKOUT","DEBUG","DELETE","HISTORY","PUBLISH","REVERT","SAVE","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]}}},"Recipient":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this recipient.","$ref":"#/definitions/Flow"},"dateCreated":{"type":"string","format":"date-time","description":"Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this recipient","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that modified this recipient","$ref":"#/definitions/User"},"messengerType":{"type":"string","description":"The messenger type for this recipient","enum":["sms","facebook","twitter","line","whatsapp","webmessaging","instagram","open"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SupportedLanguage":{"type":"object","properties":{"language":{"type":"string","description":"Architect supported language tag, e.g. en-us, es-us","readOnly":true},"isDefault":{"type":"boolean","description":"Whether or not this language is the default language","readOnly":true}}},"RecipientFlow":{"type":"object","properties":{"id":{"type":"string","description":"The flow identifier"}}},"RecipientRequest":{"type":"object","properties":{"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this recipient.","$ref":"#/definitions/RecipientFlow"}}},"RecipientListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Recipient"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsAddress":{"type":"object","properties":{"id":{"type":"string","description":"The id of this address.","readOnly":true},"name":{"type":"string"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"validated":{"type":"boolean","description":"In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressProvision":{"type":"object","required":["city","countryCode","name","postalCode","region","street"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name associated with this address"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"autoCorrectAddress":{"type":"boolean","description":"This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAddress"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Compliance":{"type":"object","required":["helpSettings","optInSettings","stopSettings"],"properties":{"stopSettings":{"type":"array","description":"List of configurations for 'StopSettings' compliance","items":{"$ref":"#/definitions/StopSettings"}},"optInSettings":{"type":"array","description":"List of configurations for 'OptInSettings' compliance","items":{"$ref":"#/definitions/OptInSettings"}},"helpSettings":{"type":"array","description":"List of configurations for 'HelpSettings' compliance","items":{"$ref":"#/definitions/HelpSettings"}}}},"ComplianceResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Message response"}}},"HelpSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"OptInSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"SmsPhoneNumber":{"type":"object","required":["phoneNumber","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications."},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","readOnly":true,"enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"provisionedThroughPureCloud":{"type":"boolean","description":"Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud"},"phoneNumberStatus":{"type":"string","description":"Status of the provisioned phone number.","enum":["INVALID","ACTIVE","PORTING","PENDING","PENDING_CANCELLATION","INITIATED"]},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","readOnly":true,"items":{"type":"string","enum":["sms","mms","voice"]}},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"dateCreated":{"type":"string","format":"date-time","description":"Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that provisioned this phone number","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that last modified this phone number","$ref":"#/definitions/User"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"purchaseDate":{"type":"string","format":"date-time","description":"Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cancellationDate":{"type":"string","format":"date-time","description":"Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"renewalDate":{"type":"string","format":"date-time","description":"Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoRenewable":{"type":"string","description":"Renewal time period of this phone number, if the phoneNumberType is shortcode.","enum":["Quarterly"]},"addressId":{"description":"The id of an address attached to this phone number.","$ref":"#/definitions/SmsAddress"},"shortCodeBillingType":{"type":"string","description":"BillingType of this phone number, if the phoneNumberType is shortcode.","enum":["Basic","Vanity"]},"provisioningStatus":{"description":"Status of latest asynchronous provisioning action","$ref":"#/definitions/SmsProvisioningStatus"},"country":{"type":"string","description":"Localized country name for the country code this phone number belongs too"},"supportsSms":{"type":"boolean","description":"Set to true if this phone number has the capability to support SMS"},"supportsMms":{"type":"boolean","description":"Set to true if this phone number has the capability to support MMS"},"supportsVoice":{"type":"boolean","description":"Set to true if this phone number has the capability to support voice"},"integration":{"description":"The Genesys Cloud integration this phone number belongs to.","$ref":"#/definitions/DomainEntityRef"},"compliance":{"description":"Compliance configuration for short codes, including help, stop and opt in.","$ref":"#/definitions/Compliance"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsProvisioningStatus":{"type":"object","properties":{"action":{"type":"string","description":"Provisioning action","enum":["Unknown","Create","Update","Delete"]},"state":{"type":"string","description":"Provisioning state","enum":["Running","Completed","Failed"]},"error":{"description":"Any error associated with a Failed state","$ref":"#/definitions/ErrorBody"},"version":{"type":"integer","format":"int64","description":"The phone number version associated with the provisioning action"}}},"StopSettings":{"type":"object","required":["keyword","response"],"properties":{"keyword":{"type":"array","description":"List of keywords for compliance","items":{"type":"string"}},"response":{"description":"The response configuration for the keywords","$ref":"#/definitions/ComplianceResponse"}}},"SMSAvailablePhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAvailablePhoneNumber"}}}},"SmsAvailablePhoneNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234"},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"region":{"type":"string","description":"The region/province/state the phone number is associated with."},"city":{"type":"string","description":"The city the phone number is associated with."},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","items":{"type":"string","enum":["sms","mms","voice"]}},"phoneNumberType":{"type":"string","description":"The type of phone number available for provisioning.","enum":["local","mobile","tollfree","shortcode","alphanumeric"]},"addressRequirement":{"type":"string","description":"The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.","enum":["none","any","local","foreign"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberImport":{"type":"object","required":["countryCode","integrationId","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"integrationId":{"type":"string","description":"The id of the Genesys Cloud integration this phone number belongs to."},"compliance":{"description":"Compliance configuration for short codes, including help, stop and opt in.","$ref":"#/definitions/Compliance"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberProvision":{"type":"object","required":["countryCode","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"name":{"type":"string"},"addressId":{"type":"string","description":"The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsPhoneNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Predictor":{"type":"object","required":["kpi","queues"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"queues":{"type":"array","description":"The queue IDs associated with the predictor.","items":{"$ref":"#/definitions/AddressableEntityRef"}},"kpi":{"type":"string","description":"The KPI that the predictor attempts to maximize/minimize."},"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"state":{"type":"string","description":"The predictor state.","readOnly":true,"enum":["Created","Error","Active"]},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing.","$ref":"#/definitions/PredictorWorkloadBalancing"},"errorCode":{"type":"string","description":"Predictor error code - optional details on why the predictor went into error state.","readOnly":true},"models":{"type":"array","description":"Predictor's models","readOnly":true,"items":{"$ref":"#/definitions/PredictorModelBrief"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PredictorModelBrief":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type of the model.","readOnly":true,"enum":["voice","email","message"]},"dateModified":{"type":"string","format":"date-time","description":"The date the model was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"retrainingErrors":{"type":"array","description":"The model's retraining errors.","readOnly":true,"items":{"$ref":"#/definitions/PredictorModelRetrainingError"}},"state":{"type":"string","description":"The state of the model","readOnly":true,"enum":["Trained","Error","InvalidDataset","Inactive"]}}},"PredictorModelRetrainingError":{"type":"object","required":["dateOfFirstOccurrence","errorCode"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"errorCode":{"type":"string","description":"Error code describing model training failure.","readOnly":true,"enum":["NotEnoughData","ServiceError","UnknownError"]},"dateOfFirstOccurrence":{"type":"string","format":"date-time","description":"Date when the first retraining failure happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PredictorSchedule":{"type":"object","required":["scheduleType"],"properties":{"scheduleType":{"type":"string","description":"The predictor schedule type.","enum":["HourOnHourOff","OngoingValueMonitoring"]},"dateStarted":{"type":"string","format":"date-time","description":"DateTime indicating when the predictor schedule was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PredictorWorkloadBalancing":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Flag to activate and deactivate workload balancing."},"minimumOccupancy":{"type":"integer","format":"int32","description":"Desired minimum occupancy threshold of agents. Must be between 0 and 100."},"maximumOccupancy":{"type":"integer","format":"int32","description":"Desired maximum occupancy threshold of agents. Must be between 0 and 100."}}},"PatchPredictorRequest":{"type":"object","properties":{"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing","$ref":"#/definitions/PredictorWorkloadBalancing"}}},"CreatePredictorRequest":{"type":"object","required":["kpi","queueIds"],"properties":{"queueIds":{"type":"array","description":"The queue IDs associated with the predictor.","items":{"type":"string"}},"kpi":{"type":"string","description":"The KPI that the predictor attempts to maximize/minimize."},"routingTimeoutSeconds":{"type":"integer","format":"int32","description":"Number of seconds allocated to predictive routing before attempting a different routing method. This is a value between 12 and 900 seconds."},"schedule":{"description":"The predictor schedule that determines when the predictor is used for routing interactions.","$ref":"#/definitions/PredictorSchedule"},"workloadBalancingConfig":{"description":"The predictor balancing configuration to enable workload balancing","$ref":"#/definitions/PredictorWorkloadBalancing"}}},"PredictorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Predictor"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KeyPerformanceIndicator":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Key Performance Indicator.","readOnly":true},"optimizationType":{"type":"string","description":"The optimization type of the Key Performance Indicator.","readOnly":true,"enum":["Maximization","Minimization"]},"problemType":{"type":"string","description":"The problem type of the Key Performance Indicator.","readOnly":true,"enum":["Classification","Regression"]},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the Key Performance Indicator was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"DateTime indicating when the Key Performance Indicator was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"description":{"type":"string","description":"The description of the Key Performance Indicator.","readOnly":true},"kpiType":{"type":"string","description":"The type of Key Performance Indicator.","readOnly":true,"enum":["SalesConversion","Churn","Retention","SalesValue","HandleTime"]},"source":{"type":"string","description":"Source of values for Key Performance Indicator.","readOnly":true,"enum":["WrapUpCode","Outcome","None"]},"wrapUpCodeConfig":{"description":"Defines what wrap up codes are mapped to Key Performance Indicator.","readOnly":true,"$ref":"#/definitions/WrapUpCodeConfig"},"outcomeConfig":{"description":"Defines what outcome ids are mapped to Key Performance Indicator.","readOnly":true,"$ref":"#/definitions/OutcomeConfig"},"status":{"type":"string","description":"The status of the Key Performance Indicator.","readOnly":true,"enum":["Enabled","Disabled"]},"kpiGroup":{"type":"string","description":"The group the Key Performance Indicator belongs to.","readOnly":true,"enum":["Standard","Custom"]},"queues":{"type":"array","description":"Queue IDs on which KPI specification is used.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeConfig":{"type":"object","properties":{"values":{"type":"array","description":"A set of valid Outcome UUIDs used to optimize a KPI.","uniqueItems":true,"items":{"type":"string"}}}},"WrapUpCodeConfig":{"type":"object","required":["values"],"properties":{"values":{"type":"array","description":"A set of valid Wrap Up Code UUIDs used to optimize a KPI.","uniqueItems":true,"items":{"type":"string"}}}},"PredictorModelFeature":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of feature.","readOnly":true,"enum":["User","Customer","Other"]},"percentageImportance":{"type":"number","format":"double","description":"The percentage of how important a feature is in the model.","readOnly":true}}},"PredictorModelFeatureListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PredictorModelFeature"}}}},"PredictorModel":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"kpi":{"type":"string","description":"The key performance indicator used in the model.","readOnly":true},"queues":{"type":"array","description":"The List of Queues that are assessed for Predictive Routing.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}},"dateCreated":{"type":"string","format":"date-time","description":"DateTime indicating when the model was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"DateTime indicating when the model was last trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"mediaType":{"type":"string","description":"The media type of the model.","readOnly":true,"enum":["voice","email","message"]},"features":{"type":"array","items":{"$ref":"#/definitions/PredictorModelFeature"}}}},"PredictorModels":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PredictorModel"}},"predictorModels":{"type":"array","items":{"$ref":"#/definitions/PredictorModel"}}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The queue member's id."},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean"},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"previousUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"}}},"QueueMemberEntityListingV1":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SkillGroupMemberDivisions":{"type":"object","properties":{"addDivisionIds":{"type":"array","items":{"type":"string"}},"removeDivisionIds":{"type":"array","items":{"type":"string"}}}},"SkillGroupMemberDivisionList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Division"}}}},"SkillGroup":{"type":"object","required":["name","skillConditions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Group's filling status","readOnly":true,"enum":["InProgress","Complete"]},"skillConditions":{"type":"array","description":"Conditions for this group","items":{"$ref":"#/definitions/SkillGroupCondition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupCondition":{"type":"object","required":["languageSkillConditions","operation","routingSkillConditions"],"properties":{"routingSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/SkillGroupRoutingCondition"}},"languageSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/SkillGroupLanguageCondition"}},"operation":{"type":"string","description":"Operator that will be applied to the conditions","enum":["And","Not","Or"]}}},"SkillGroupLanguageCondition":{"type":"object","required":["comparator","languageSkill","proficiency"],"properties":{"languageSkill":{"type":"string","example":"English-Written","description":"The language skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the language skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/SkillGroupCondition"}}}},"SkillGroupRoutingCondition":{"type":"object","required":["comparator","proficiency","routingSkill"],"properties":{"routingSkill":{"type":"string","description":"The routing skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the routing skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/SkillGroupCondition"}}}},"SkillGroupMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReferenceWithName"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"SkillGroupWithMemberDivisions":{"type":"object","required":["name","skillConditions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Group's filling status","readOnly":true,"enum":["InProgress","Complete"]},"skillConditions":{"type":"array","description":"Conditions for this group","items":{"$ref":"#/definitions/SkillGroupCondition"}},"memberDivisions":{"type":"array","description":"Member divisions for this skill group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupDefinition":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"Group description"},"memberCount":{"type":"integer","format":"int64","description":"Estimated number of members in this group. It can take some time for the count to be updated after expressions are changed.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Created date/time of the skill group. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SkillGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillGroupDefinition"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"AgentMaxUtilizationResponse":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}},"labelUtilizations":{"type":"object","description":"Map of label ids to utilization settings.","additionalProperties":{"$ref":"#/definitions/LabelUtilizationResponse"}},"level":{"type":"string","enum":["Agent","Organization"]}}},"WrapupCodeRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableStarrableDivision"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the wrap-up code was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date when the wrap-up code was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","description":"The ID of the user that created the wrap-up code."},"modifiedBy":{"type":"string","description":"The ID of the user that modified the wrap-up code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScimConfigResourceType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the resource type.","readOnly":true},"description":{"type":"string","description":"The description of the resource type.","readOnly":true},"schema":{"type":"string","description":"The URI of the primary or base schema for the resource type.","readOnly":true},"schemaExtensions":{"type":"array","description":"The list of schema extensions for the resource type.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceTypeSchemaExtension"}},"endpoint":{"type":"string","description":"The HTTP-addressable endpoint of the resource type. Appears after the base URL.","readOnly":true},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM resource."},"ScimConfigResourceTypeSchemaExtension":{"type":"object","properties":{"schema":{"type":"string","description":"The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether a schema extension is required.","readOnly":true}},"description":"Defines a SCIM resource type's schema extension."},"ScimMetadata":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"lastModified":{"type":"string","format":"date-time","description":"The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true},"location":{"type":"string","format":"uri","description":"The URI of the resource.","readOnly":true},"version":{"type":"string","description":"The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true}},"description":"Defines the SCIM metadata."},"ScimConfigResourceTypesListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceType"}}},"description":"Defines a response for a list of SCIM resource types."},"ScimV2SchemaAttribute":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","readOnly":true},"type":{"type":"string","description":"The data type of the attribute.","readOnly":true,"enum":["string","boolean","decimal","integer","dateTime","reference","complex"]},"subAttributes":{"type":"array","description":"The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"multiValued":{"type":"boolean","description":"Indicates whether an attribute contains multiple values.","readOnly":true},"description":{"type":"string","description":"The description of the attribute.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether an attribute is required.","readOnly":true},"canonicalValues":{"type":"array","description":"The list of standard values that service providers may use. Service providers may ignore unsupported values.","readOnly":true,"items":{"type":"string"}},"caseExact":{"type":"boolean","description":"Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.","readOnly":true},"mutability":{"type":"string","description":"The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".","readOnly":true,"enum":["readWrite","readOnly","immutable","writeOnly"]},"returned":{"type":"string","description":"The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.","readOnly":true,"enum":["always","never","default","request"]},"uniqueness":{"type":"string","description":"The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".","readOnly":true,"enum":["none","server","global"]},"referenceTypes":{"type":"array","description":"The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".","readOnly":true,"items":{"type":"string","enum":["User","Group","external","uri"]}}},"description":"A complex type that defines service provider attributes or subattributes and their qualities."},"ScimV2SchemaDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"name":{"type":"string","description":"The name of the schema.","readOnly":true},"description":{"type":"string","description":"The description of the schema.","readOnly":true},"attributes":{"type":"array","description":"The list of service provider attributes.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM schema."},"ScimV2SchemaListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaDefinition"}}},"description":"Defines the list response for SCIM resource types."},"ScimGroupListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2Group"}}},"description":"Defines a response for a list of SCIM groups."},"ScimV2Group":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"displayName":{"type":"string","description":"The display name of the group.","readOnly":true},"externalId":{"type":"string","description":"The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"members":{"type":"array","description":"The list of members in the group.","items":{"$ref":"#/definitions/ScimV2MemberReference"}},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM group."},"ScimV2MemberReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM group members."},"ScimError":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of schemas for the SCIM error.","readOnly":true,"items":{"type":"string"}},"status":{"type":"string","description":"The HTTP status code returned for the SCIM error.","readOnly":true},"scimType":{"type":"string","description":"The type of SCIM error when httpStatus is a \"400\" error.","readOnly":true,"enum":["invalidFilter","tooMany","uniqueness","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"]},"detail":{"type":"string","description":"The detailed description of the SCIM error.","readOnly":true}},"description":"Defines a SCIM error."},"ScimV2PatchOperation":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"The PATCH operation to perform.","enum":["add","replace","remove"]},"path":{"type":"string","description":"The attribute path that describes the target of the operation. Required for a \"remove\" operation."},"value":{"description":"The value to set in the path.","$ref":"#/definitions/JsonNode"}},"description":"Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimV2PatchRequest":{"type":"object","required":["schemas"],"properties":{"schemas":{"type":"array","description":"The list of schemas used in the PATCH request.","items":{"type":"string"}},"Operations":{"type":"array","description":"The list of operations to perform for the PATCH request.","items":{"$ref":"#/definitions/ScimV2PatchOperation"}}},"description":"Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimServiceProviderConfig":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the service provider's documentation.","readOnly":true},"patch":{"description":"The \"patch\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"filter":{"description":"The \"filter\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigFilterFeature"},"etag":{"description":"The \"etag\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"sort":{"description":"The \"sort\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"bulk":{"description":"The \"bulk\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigBulkFeature"},"changePassword":{"description":"The \"changePassword\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"authenticationSchemes":{"type":"array","description":"The list of supported authentication schemes.","readOnly":true,"items":{"$ref":"#/definitions/ScimServiceProviderConfigAuthenticationScheme"}},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM service provider's configuration."},"ScimServiceProviderConfigAuthenticationScheme":{"type":"object","required":["description","name","type"],"properties":{"name":{"type":"string","description":"The name of the authentication scheme, for example, HTTP Basic.","readOnly":true},"description":{"type":"string","description":"The description of the authentication scheme.","readOnly":true},"specUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's specification.","readOnly":true},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's usage documentation.","readOnly":true},"type":{"type":"string","description":"The type of authentication scheme.","readOnly":true,"enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"]},"primary":{"type":"boolean","description":"Indicates whether this authentication scheme is the primary method of authentication.","readOnly":true}},"description":"Defines an authentication scheme in the SCIM service provider's configuration."},"ScimServiceProviderConfigBulkFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxOperations":{"type":"integer","format":"int32","description":"The maximum number of operations for each bulk request.","readOnly":true},"maxPayloadSize":{"type":"integer","format":"int32","description":"The maximum payload size.","readOnly":true}},"description":"Defines a \"bulk\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigFilterFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxResults":{"type":"integer","format":"int32","description":"The maximum number of results returned from a filtered query.","readOnly":true}},"description":"Defines a \"filter\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigSimpleFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true}},"description":"Defines a request in the SCIM service provider's configuration."},"Manager":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the manager."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the manager's user record.","readOnly":true}},"description":"Defines a SCIM manager."},"ScimEmail":{"type":"object","properties":{"value":{"type":"string","description":"The email address. Is immutable if \"type\" is set to \"other\"."},"type":{"type":"string","description":"The type of email address. \"value\" is immutable if \"type\" is set to \"other\".","enum":["work","other"]},"primary":{"type":"boolean","description":"Indicates whether the email address is the primary email address."}},"description":"Defines a SCIM email address."},"ScimGenesysUserExternalId":{"type":"object","required":["authority","value"],"properties":{"authority":{"type":"string","description":"Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier."},"value":{"type":"string","description":"Identifier of the user in an external system."}},"description":"External Identifiers of user. The external identifier must be unique within the organization and the 'authority'"},"ScimPhoneNumber":{"type":"object","properties":{"value":{"type":"string","description":"The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx."},"type":{"type":"string","description":"The type of phone number.","enum":["work","work2","work3","work4","home","mobile","other","microsoftteams","zoomphone","eightbyeight"]},"primary":{"type":"boolean","description":"Indicates whether the phone number is the primary phone number."}},"description":"Defines a SCIM phone number."},"ScimUserExtensions":{"type":"object","properties":{"routingSkills":{"type":"array","description":"The list of routing skills assigned to a user. Maximum 50 skills.","items":{"$ref":"#/definitions/ScimUserRoutingSkill"}},"routingLanguages":{"type":"array","description":"The list of routing languages assigned to a user. Maximum 50 languages.","items":{"$ref":"#/definitions/ScimUserRoutingLanguage"}},"externalIds":{"type":"array","description":"The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\". ExternalIds are searchable with complex filter query parameter using 'authority' and 'value', e.g., filter=urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds[authority eq \"matchAuthName\" and value eq \"matchingExternalKeyValue\"].","items":{"$ref":"#/definitions/ScimGenesysUserExternalId"}}},"description":"Genesys Cloud user extensions to SCIM RFC."},"ScimUserListResponse":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}},"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2User"}}},"description":"Defines a response for a list of SCIM users."},"ScimUserRole":{"type":"object","properties":{"value":{"type":"string","description":"The role of the Genesys Cloud user."}},"description":"Defines a user role."},"ScimUserRoutingLanguage":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing language configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."}},"description":"The routing language assigned to a user."},"ScimUserRoutingSkill":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing skill configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."}},"description":"The routing skill assigned to a user."},"ScimV2EnterpriseUser":{"type":"object","properties":{"division":{"type":"string","description":"The division that the user belongs to."},"department":{"type":"string","description":"The department that the user belongs to."},"manager":{"description":"The user's manager.","$ref":"#/definitions/Manager"},"employeeNumber":{"type":"string","description":"The user's employee number."}},"description":"Defines a SCIM enterprise user."},"ScimV2GroupReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM groups."},"ScimV2User":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"},"meta":{"description":"The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM user."},"ScimV2CreateUser":{"type":"object","required":["displayName","userName"],"properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"}},"description":"Defines the creation of a SCIM user."},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING","MATCH_ALL","REGEX"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["addresses.email","addresses.voice","addresses.address","addresses.voicemailEnabled","chat.jabberId","department","email","username","siteId","manager.id","hr.employeeId","integration","groups.social.id","groups.official.id","groups.distribution.id","state","id","languages.guid","languages.name","languages.namespace","languages.proficiency","name","primaryContactInfo.voice","primaryContactInfo.sms","primaryContactInfo.email","profileSkills","queueMembership.added","queueMembership.joined","routingSkills.guid","routingSkills.name","routingSkills.namespace","routingSkills.proficiency","title","divisionId","teamId","description","notes","addressFields.city","addressFields.country","addressFields.state","addressFields.street1","addressFields.street2","addressFields.zipcode","addressVerified","emergencyNumber","voicemailId","ownerId","ownerType","deleted","read","callerAddress","callerUser","createdDate","modifiedDate","queueId","wrapupCodeId","body","created","fromUserJid","targetJids"]}}}},"SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","description":"A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.","items":{"type":"string"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/SearchAggregation"}}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SuggestSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"SuggestSearchRequest":{"type":"object","required":["query","types"],"properties":{"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"Suggest query","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"TranscriptConversationDetailSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE"]}}},"TranscriptConversationDetailSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}}}},"CategoriesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/StaCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InfixOperator":{"type":"object","required":["operatorType"],"properties":{"operatorType":{"type":"string","description":"The logical operation that is applied on the operand against the following operand","enum":["Or","And","Near"]},"operatorPosition":{"description":"Dictates when the following operand should occur relative to current operand","$ref":"#/definitions/OperatorPosition"}}},"Operand":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The Operand type of the category","enum":["Term","Topic","OperandGroup"]},"occurrence":{"type":"integer","format":"int32","description":"The minimum number of occurrences of the defined operand type"},"inverted":{"type":"boolean","description":"Applies a NOT modifier to the operand group"},"term":{"description":"Filter interaction by word(s)","$ref":"#/definitions/Term"},"topicId":{"type":"string","description":"Filter interaction by topic ID"},"voiceSecondsPosition":{"description":"Dictates when the operand must occur in a voice interaction","$ref":"#/definitions/OperandPosition"},"digitalWordsPosition":{"description":"Dictates when the operand must occur in a digital interaction","$ref":"#/definitions/OperandPosition"},"infixOperator":{"description":"Defines a logical operation that is applied on the current operand, against the following operand","$ref":"#/definitions/InfixOperator"},"operands":{"type":"array","description":"Contains a new level of operands","items":{"$ref":"#/definitions/Operand"}}}},"OperandPosition":{"type":"object","properties":{"startingPositionValue":{"type":"integer","format":"int32","description":"Defines starting point of a position range - number of seconds or words from the start or from the end of the interaction"},"startingPositionDirection":{"type":"string","description":"Dictates starting position directionality","enum":["FromStart","FromEnd"]},"endingPositionValue":{"type":"integer","format":"int32","description":"Defines ending point of a position range - number of seconds or words from the start or from the end of the interaction"},"endingPositionDirection":{"type":"string","description":"Dictates ending position directionality","enum":["FromStart","FromEnd"]}}},"OperatorPosition":{"type":"object","properties":{"voiceSecondsPosition":{"type":"integer","format":"int32","description":"Number of seconds (for voice interactions) from operand match"},"digitalWordsPosition":{"type":"integer","format":"int32","description":"Number of words (for digital interactions) from operand match"}}},"StaCategory":{"type":"object","required":["criteria","interactionType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description of the category"},"interactionType":{"type":"string","description":"The type of interaction the category will apply to","enum":["Voice","Digital","All"]},"criteria":{"description":"A collection of conditions joined together by logical operation to provide more refined filtering of conversations","$ref":"#/definitions/Operand"},"createdBy":{"description":"The user who created the record","$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who last modified the record","$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The last modified date of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Term":{"type":"object","required":["participantType","word"],"properties":{"word":{"type":"string","description":"Find term in interaction"},"participantType":{"type":"string","description":"Dictates if term operand must come from the internal, external or both participants","enum":["Internal","External","Both"]}}},"CategoryRequest":{"type":"object","required":["criteria","interactionType","name"],"properties":{"name":{"type":"string","description":"The name of the category"},"description":{"type":"string","description":"The description of the category"},"interactionType":{"type":"string","description":"The type of interaction the category will apply to","enum":["Voice","Digital","All"]},"criteria":{"description":"A collection of conditions joined together by logical operation to provide more refined filtering of conversations","$ref":"#/definitions/Operand"}}},"ConversationMetrics":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"sentimentScore":{"type":"number","format":"double","description":"The Sentiment Score"},"sentimentTrend":{"type":"number","format":"double","description":"The Sentiment Trend"},"sentimentTrendClass":{"type":"string","description":"The Sentiment Trend Class","enum":["NotCalculated","Declining","SlightlyDeclining","NoChange","SlightlyImproving","Improving"]},"empathyScores":{"type":"array","description":"The Empathy Scores","items":{"$ref":"#/definitions/EmpathyScore"}},"participantMetrics":{"description":"The Participant Metrics","$ref":"#/definitions/ParticipantMetrics"}}},"EmpathyScore":{"type":"object","properties":{"score":{"type":"number","format":"double","description":"Empathy score of the agent involved in the conversation"},"userId":{"type":"string","description":"UserId of the agent involved in the conversation"}}},"ParticipantMetrics":{"type":"object","properties":{"agentDurationPercentage":{"type":"number","format":"double","description":"Percentage of Agent duration in the conversation"},"customerDurationPercentage":{"type":"number","format":"double","description":"Percentage of Customer duration in the conversation"},"silenceDurationPercentage":{"type":"number","format":"double","description":"Percentage of Silence duration in the conversation"},"ivrDurationPercentage":{"type":"number","format":"double","description":"Percentage of IVR duration in the conversation"},"acdDurationPercentage":{"type":"number","format":"double","description":"Percentage of ACD duration in the conversation"},"overtalkDurationPercentage":{"type":"number","format":"double","description":"Percentage of Overtalk duration in the conversation"},"otherDurationPercentage":{"type":"number","format":"double","description":"Percentage of Other events duration in the conversation"},"overtalkCount":{"type":"integer","format":"int32","description":"Number of Overtalks in the conversation"}}},"DictionaryFeedback":{"type":"object","required":["dialect","examplePhrases","term"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"term":{"type":"string","description":"The dictionary term which needs to be added to dictionary feedback system"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"boostValue":{"type":"number","format":"float","description":"A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0"},"source":{"type":"string","description":"The source of the given dictionary feedback","readOnly":true,"enum":["Manual"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of the user who created the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The Id of the user who modified the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"examplePhrases":{"type":"array","description":"A list of at least 3 and up to 20 unique phrases that are example usage of the term","items":{"$ref":"#/definitions/DictionaryFeedbackExamplePhrase"}},"soundsLike":{"type":"array","description":"A list of up to 10 terms that give examples of how the term sounds","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DictionaryFeedbackExamplePhrase":{"type":"object","required":["phrase"],"properties":{"phrase":{"type":"string","description":"The Example Phrase text. At least 3 words and up to 20 words"},"source":{"type":"string","description":"The source of the given Example Phrase","enum":["Manual"]}}},"DictionaryFeedbackEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedDictionaryFeedback"}},"pageSize":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"selfUri":{"type":"string"},"nextUri":{"type":"string"}}},"ListedDictionaryFeedback":{"type":"object","required":["dialect","term"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"term":{"type":"string","description":"The dictionary term which needs to be added to dictionary feedback system"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"boostValue":{"type":"number","format":"float","description":"A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0"},"source":{"type":"string","description":"The source of the given dictionary feedback","readOnly":true,"enum":["Manual"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of the user who created the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The Id of the user who modified the dictionary feedback","readOnly":true,"$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SentimentFeedback":{"type":"object","required":["dialect","feedbackValue","phrase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phrase":{"type":"string","description":"The phrase for which sentiment feedback is provided"},"dialect":{"type":"string","example":"en-US","description":"The dialect for the given phrase, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard"},"feedbackValue":{"type":"string","description":"The sentiment feedback value for the given phrase","enum":["Neutral","Positive","Negative"]},"dateCreated":{"type":"string","format":"date-time","description":"The Timestamp when sentiment feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The Id of user who created the sentiment feedback","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SentimentFeedbackEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SentimentFeedback"}}}},"BaseProgramEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EngineIntegration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramTranscriptionEngine":{"type":"object","properties":{"engine":{"type":"string","enum":["Genesys","GenesysExtended","TranscriptionConnector"]},"dialects":{"type":"array","items":{"type":"string"}},"engineIntegration":{"$ref":"#/definitions/EngineIntegration"}}},"ProgramTranscriptionEngines":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"program":{"description":"The ID of the program","$ref":"#/definitions/BaseProgramEntity"},"transcriptionEngines":{"type":"array","description":"The program transcription engine settings","items":{"$ref":"#/definitions/ProgramTranscriptionEngine"}},"modifiedBy":{"description":"The user last modified the record","$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The last modified date of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptionEnginesRequest":{"type":"object","required":["transcriptionEngines"],"properties":{"transcriptionEngines":{"type":"array","description":"The transcription engine setting","items":{"$ref":"#/definitions/ProgramTranscriptionEngine"}}}},"SupportedDialectsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SupportedDialectsTranscriptionEngine"}}}},"SupportedDialectsTranscriptionEngine":{"type":"object","properties":{"engine":{"type":"string","enum":["Genesys","GenesysExtended","TranscriptionConnector"]},"dialects":{"type":"array","items":{"type":"string"}},"engineIntegration":{"$ref":"#/definitions/EngineIntegration"}}},"SpeechTextAnalyticsSettingsResponse":{"type":"object","properties":{"defaultProgram":{"description":"Setting to choose name for the default program for topic detection","$ref":"#/definitions/AddressableEntityRef"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}},"textAnalyticsEnabled":{"type":"boolean","description":"Setting to enable/disable text analytics"},"agentEmpathyEnabled":{"type":"boolean","description":"Setting to enable/disable Agent Empathy setting"}}},"SpeechTextAnalyticsSettingsRequest":{"type":"object","properties":{"defaultProgramId":{"type":"string","description":"Setting to choose name for the default program for topic detection"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}},"textAnalyticsEnabled":{"type":"boolean","description":"Setting to enable/disable text analytics"},"agentEmpathyEnabled":{"type":"boolean","description":"Setting to enable/disable Agent Empathy setting"}}},"ConversationCategoriesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ConversationCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationCategory":{"type":"object","properties":{"id":{"type":"string","description":"The id of the category"},"name":{"type":"string","description":"The name of the category"},"description":{"type":"string","description":"The description of the category"},"interactionType":{"type":"string","description":"The type of interaction the category will apply to","enum":["Voice","Digital","All"]},"criteria":{"description":"A collection of conditions joined together by logical operation to provide more refined filtering of conversations","$ref":"#/definitions/Operand"}}},"GeneralProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeneralProgramJobRequest":{"type":"object","required":["dialect"],"properties":{"dialect":{"type":"string","description":"The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","enum":["ar-001","ar-AE","ar-BH","ar-EG","ar-IL","ar-SA","ar-TN","da-DK","de-CH","de-DE","en-AU","en-GB","en-HK","en-IE","en-IN","en-NZ","en-SG","en-US","en-ZA","es-ES","es-US","fi-FI","fr-CA","fr-FR","he-IL","it-IT","ja-JP","ko-KR","nb-NO","nl-NL","pl-PL","pt-BR","pt-PT","sv-SE"]},"mode":{"type":"string","description":"The mode to use for the general program job, default value is Skip","enum":["Skip","Merge","ReplaceMerge"]}}},"GeneralTopic":{"type":"object","properties":{"name":{"type":"string"}}},"GeneralTopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GeneralTopic"}}}},"ProgramMappings":{"type":"object","properties":{"program":{"$ref":"#/definitions/BaseProgramEntity"},"queues":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}},"flows":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ProgramMappingsRequest":{"type":"object","required":["flowIds","queueIds"],"properties":{"queueIds":{"type":"array","description":"The program queues","items":{"type":"string"}},"flowIds":{"type":"array","description":"The program flows","items":{"type":"string"}}}},"ProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramJobRequest":{"type":"object","required":["programIds"],"properties":{"programIds":{"type":"array","description":"The ids of the programs used for this job","items":{"type":"string"}}}},"BaseTopicEntitiy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Program":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The program name"},"description":{"type":"string","description":"The program description"},"topicIds":{"type":"array","description":"The ids of topics associated to the program","items":{"type":"string"}},"tags":{"type":"array","description":"The program tags","items":{"type":"string"}}}},"ProgramsMappingsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ProgramMappings"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ListedProgram":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topicsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedProgram"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TopicJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"]},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicJobRequest":{"type":"object","required":["topicIds"],"properties":{"topicIds":{"type":"array","description":"The ids of the topics used for this job","items":{"type":"string"}}}},"Phrase":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The phrase text"},"strictness":{"type":"string","description":"The phrase strictness, default value is null","enum":["1","55","65","72","85","90"]},"sentiment":{"type":"string","description":"The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system.","enum":["Unspecified","Positive","Neutral","Negative"]}}},"Topic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"]},"phrases":{"type":"array","items":{"$ref":"#/definitions/Phrase"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicRequest":{"type":"object","required":["dialect","name"],"properties":{"name":{"type":"string","description":"The topic name"},"description":{"type":"string","description":"The topic description"},"strictness":{"type":"string","description":"The topic strictness, default value is 72","enum":["1","55","65","72","85","90"]},"programIds":{"type":"array","description":"The ids of programs associated to the topic","items":{"type":"string"}},"tags":{"type":"array","description":"The topic tags","items":{"type":"string"}},"dialect":{"type":"string","description":"The topic dialect"},"participants":{"type":"string","description":"The topic participants, default value is All","enum":["External","Internal","All"]},"phrases":{"type":"array","description":"The topic phrases","items":{"$ref":"#/definitions/Phrase"}}}},"ListedTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"]},"programsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"]},"phrasesCount":{"type":"integer","format":"int32"},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedTopic"}},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UnifiedGeneralTopic":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["Deprecated","Outdated","Modified","UpToDate","ToBeCreated","CreatedByUser"]}}},"UnifiedGeneralTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnifiedGeneralTopic"}}}},"UnpublishedProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Program"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"JsonSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"TranscriptSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE","RANGE","GREATER_THAN","LESS_THAN"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["transcript.content","language","mediaType","divisionId","communicationId","conversationId","conversationSentimentScore","conversationSentimentTrend","participants.initialDirection","participants.participantPurpose","participants.queueId","participants.userId","topic","transcriptId"]}}}},"TranscriptSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}}}},"TranscriptUrl":{"type":"object","properties":{"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"SegmentUrl":{"type":"object","properties":{"recording":{"description":"The Recording Reference","$ref":"#/definitions/AddressableEntityRef"},"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"TranscriptUrls":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"communicationId":{"type":"string","description":"The Communication ID"},"urls":{"type":"array","description":"List of Transcript URLs","items":{"$ref":"#/definitions/SegmentUrl"}}}},"TeamMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReferenceWithName"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"TeamAddMemberFailure":{"type":"object","properties":{"id":{"type":"string"},"reason":{"type":"string","description":"Specific reason the member could not be added.","readOnly":true,"enum":["UserNotFound","UserGroupLimitExceeded","UserGroupDivisionMismatch"]}}},"TeamMemberAddListingResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}},"failures":{"type":"array","description":"List of any user ids that were not added.","readOnly":true,"items":{"$ref":"#/definitions/TeamAddMemberFailure"}}}},"TeamMembers":{"type":"object","required":["memberIds"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add or remove","items":{"type":"string"}}}},"TeamEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Team"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"TeamsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Team"}}}},"TeamSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TeamSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["description","name"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH"]}}},"TeamSearchRequest":{"type":"object","required":["query"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","description":"Team Search Criteria","items":{"$ref":"#/definitions/TeamSearchCriteria"}}}},"MediaRegions":{"type":"object","properties":{"awsHomeRegion":{"type":"string","description":"The AWS region your organization is in.","readOnly":true},"awsCoreRegions":{"type":"array","description":"The list of AWS regions to which Genesys Cloud is deployed with full functionality including media streaming.","readOnly":true,"items":{"type":"string"}},"awsSatelliteRegions":{"type":"array","description":"The list of AWS regions that Genesys Cloud uses only for media streaming.","readOnly":true,"items":{"type":"string"}}}},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"]},"userId":{"type":"string","description":"The Id of the user currently logged in and associated with the station."},"webRtcUserId":{"type":"string","description":"The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone."},"primaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"secondaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"webRtcMediaDscp":{"type":"integer","format":"int32","description":"The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcPersistentEnabled":{"type":"boolean","description":"The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcForceTurn":{"type":"boolean","description":"Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcCallAppearances":{"type":"integer","format":"int32","description":"The number of call appearances on the station.","readOnly":true},"webRtcRequireMediaHelper":{"type":"boolean","description":"True when the media helper required.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Callheader":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"headers":{"type":"object","description":"parsed SIP headers","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Callmessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"message":{"type":"string","description":"raw SIP message"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubscriberResponse":{"type":"object","required":["status"],"properties":{"messageReturned":{"type":"array","description":"Suggested valid addresses","items":{"type":"string"}},"status":{"type":"string","description":"http status"}}},"ValidateAddressResponse":{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","description":"Was the passed in address valid"},"response":{"description":"Subscriber schema","$ref":"#/definitions/SubscriberResponse"}}},"StreetAddress":{"type":"object","required":["A1","A3","HNO","PC","RD","country"],"properties":{"country":{"type":"string","description":"2 Letter Country code, like US or GB"},"A1":{"type":"string","description":"State or Province"},"A3":{"type":"string","description":"City or township"},"RD":{"type":"string","description":"Number and street"},"HNO":{"type":"string","description":"House Number"},"LOC":{"type":"string","description":"extra location info like suite 300"},"NAM":{"type":"string","description":"Name of the customer"},"PC":{"type":"string","description":"Postal code"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"description":"Address schema","$ref":"#/definitions/StreetAddress"}}},"DomainCertificateAuthority":{"type":"object","required":["certificate","name","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type. Managed certificate authorities are generated and maintained by Interactive Intelligence. These are read-only and not modifiable by clients. Remote authorities are customer managed.","enum":["MANAGED","REMOTE"]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"CertificateAuthorityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeNetworkDiagnostic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeNetworkDiagnosticRequest":{"type":"object","required":["host"],"properties":{"host":{"type":"string","description":"IPv4/6 address or host to be probed for connectivity. No port allowed."}}},"EdgeNetworkDiagnosticResponse":{"type":"object","properties":{"commandCorrelationId":{"type":"string","description":"UUID of each executed command on edge"},"diagnostics":{"type":"string","description":"Response string of executed command from edge"}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if this address family on the interface is enabled."},"dhcp":{"type":"boolean","description":"True if this address family on the interface is using DHCP."},"metric":{"type":"integer","format":"int32","description":"The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge."},"autoMetric":{"type":"boolean","description":"True if the metric is being calculated automatically for the address family on this interface."},"supportsMetric":{"type":"boolean","description":"True if metric configuration is supported.","readOnly":true},"pingEnabled":{"type":"boolean","description":"Set to true to enable this address family on this interface to respond to ping requests."}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string","description":"The type of address.","enum":["ip","dns","gateway","tdm"]},"address":{"type":"string","description":"An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask."},"persistent":{"type":"boolean","description":"True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false."},"family":{"type":"integer","format":"int32","description":"The address family for this address.","enum":[2,23]}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string","description":"The IPv4 or IPv6 route prefix in CIDR notation."},"nexthop":{"type":"string","description":"The IPv4 or IPv6 nexthop IP address."},"persistent":{"type":"boolean","description":"True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false."},"metric":{"type":"integer","format":"int32","description":"The metric being used for route. Lower values will have a higher priority."},"family":{"type":"integer","format":"int32","description":"The address family for this route.","enum":[2,23]}}},"EdgeRebootParameters":{"type":"object","properties":{"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"ConnectedEdge":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"interfaceName":{"type":"string","description":"Edge interface name used for the connection","readOnly":true},"interfaceIpAddress":{"type":"string","description":"Edge interface IP address","readOnly":true},"edgeConnectionList":{"type":"array","items":{"$ref":"#/definitions/EdgeConnectionInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEdgeSoftwareUpdateDto":{"type":"object","required":["version"],"properties":{"version":{"description":"Version","$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeOnIdle":{"type":"boolean"},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"]},"edgeUri":{"type":"string","format":"uri"},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int64"},"current":{"type":"boolean"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"edgeUri":{"type":"string","format":"uri"},"latestRelease":{"type":"boolean"},"current":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"interfaces":{"type":"array","description":"The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string","description":"The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE."},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","description":"The current status of the Edge.","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED","INITIALIZING"]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"description":"The Site to which the Edge is assigned.","$ref":"#/definitions/Site"},"softwareStatus":{"description":"Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge.","$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean"},"managed":{"type":"boolean"},"edgeDeploymentType":{"type":"string","enum":["HARDWARE","LDM","CDM","CHS","INVALID"]},"certType":{"type":"string","description":"The type of certificate used to communicate with edge-proxy.","enum":["PureCloud","Public","China","NotRequested"]},"callDrainingState":{"type":"string","description":"The current state of the Edge's call draining process before it can be safely rebooted or updated.","readOnly":true,"enum":["NONE","WAIT","WAIT_TIMEOUT","TERMINATE","COMPLETE"]},"conversationCount":{"type":"integer","format":"int32","description":"The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0.","readOnly":true},"proxy":{"type":"string","description":"Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed."},"offlineConfigCalled":{"type":"boolean","description":"True if the offline edge configuration endpoint has been called for this edge.","readOnly":true},"osName":{"type":"string","description":"The name provided by the operating system of the Edge.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeAutoUpdateConfig":{"type":"object","required":["end","rrule","start","timeZone"],"properties":{"timeZone":{"type":"string","description":"The timezone of the window in which any updates to the edges assigned to the site can be applied. The minimum size of the window is 2 hours."},"rrule":{"type":"string","description":"The recurrence rule for updating the Edges assigned to the site. The only supported frequencies are daily and weekly. Weekly frequencies require a day list with at least oneday specified. All other configurations are not supported."},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"}}},"EdgeConnectionInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"interfaceName":{"type":"string","description":"Interface used for the connection on the edge","readOnly":true},"interfaceIpAddress":{"type":"string","description":"IP address of the interface","readOnly":true},"connectionErrors":{"type":"array","description":"Connection errors","readOnly":true,"items":{"type":"string"}},"site":{"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroup":{"type":"object","required":["edgeTrunkBaseAssignment","name","phoneTrunkBases"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"managed":{"type":"boolean","description":"Is this edge group being managed remotely."},"hybrid":{"type":"boolean","description":"Is this edge group hybrid."},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/TrunkBase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"]}},"addressFamilyId":{"type":"string"}}},"NTPSettings":{"type":"object","properties":{"servers":{"type":"array","description":"List of NTP servers, in priority order","items":{"type":"string"}}}},"Site":{"type":"object","required":["location","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"primarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"mediaRegionsUseLatencyBased":{"type":"boolean"},"location":{"description":"Location","$ref":"#/definitions/LocationDefinition"},"managed":{"type":"boolean"},"ntpSettings":{"description":"Network Time Protocol settings for the site","$ref":"#/definitions/NTPSettings"},"mediaModel":{"type":"string","description":"Media model for the site","enum":["Premises","Cloud"]},"coreSite":{"type":"boolean","description":"Is this site a core site"},"siteConnections":{"type":"array","description":"The site connections","items":{"$ref":"#/definitions/SiteConnection"}},"mediaRegions":{"type":"array","description":"The ordered list of AWS regions through which media can stream.","items":{"type":"string"}},"callerId":{"type":"string","description":"The caller ID value for the site."},"callerName":{"type":"string","description":"The caller name for the site."},"cloudProxyForceTurn":{"type":"boolean","description":"Enables premises Edge Force Turn "},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SiteConnection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"managed":{"type":"boolean"},"type":{"type":"string","description":"Connection method from site to site (Direct, Indirect, CloudProxy","enum":["Direct","Indirect","CloudProxy"]},"enabled":{"type":"boolean","description":"Indicates if the current site is linked"},"mediaModel":{"type":"string","description":"Media model for the current site.","readOnly":true,"enum":["Premises","Cloud"]},"edgeList":{"type":"array","description":"All of the edges to which the site connects","readOnly":true,"items":{"$ref":"#/definitions/ConnectedEdge"}},"coreSite":{"type":"boolean","description":"The core site","readOnly":true},"primaryCoreSites":{"type":"array","description":"List of site ids names and selfUris for the primary core sites","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"secondaryCoreSites":{"type":"array","description":"List of site ids names and selfUris for the secondary core sites","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"TrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned."},"site":{"description":"Used to determine the media regions for inbound and outbound calls through a trunk. Also determines the dial plan to use for calls that came in on a trunk and have to be sent out on it as well.","$ref":"#/definitions/DomainEntityRef"},"inboundSite":{"description":"Allows a customer to set the site to which inbound calls will be routed","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/TrunkBase"}}},"EdgeServiceStateRequest":{"type":"object","required":["inService"],"properties":{"inService":{"type":"boolean","description":"A boolean that sets the Edge in-service or out-of-service."},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"DomainEdgeSoftwareVersionDtoEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RegionTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RegionTimeZone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"DomainLogicalInterface":{"type":"object","required":["friendlyName","hardwareAddress","name","physicalAdapterId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string","description":"Friendly Name"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string","description":"Hardware Address"},"physicalAdapterId":{"type":"string","description":"Physical Adapter Id"},"ifStatus":{"type":"string"},"interfaceType":{"type":"string","description":"The type of this network interface.","readOnly":true,"enum":["DIAGNOSTIC","SYSTEM"]},"publicNatAddressIpV4":{"type":"string","description":"IPv4 NENT IP Address"},"publicNatAddressIpV6":{"type":"string","description":"IPv6 NENT IP Address"},"routes":{"type":"array","description":"The list of routes assigned to this interface.","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","description":"The list of IP addresses on this interface. Priority of dns addresses are based on order in the list.","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"description":"IPv4 interface settings.","$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"description":"IPv6 interface settings.","$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group."},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 phone trunk base assignment will be inherited from the Edge Group."},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group."},"useForIndirectEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end."},"useForCloudProxyEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option."},"useForWanInterface":{"type":"boolean","description":"This interface will be used for all communication with the internet.","readOnly":true},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"traceEnabled":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean"},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean"},"team":{"type":"boolean"}}},"DomainPhysicalInterface":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDPool":{"type":"object","required":["endPhoneNumber","name","startPhoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"number":{"type":"string","description":"The number of the DID formatted as E164."},"assigned":{"type":"boolean","description":"True if this DID is assigned to an entity. False otherwise."},"didPool":{"description":"A Uri reference to the DID Pool this DID is a part of.","$ref":"#/definitions/AddressableEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID. The owner's type can be found in ownerType. If the DID is unassigned, this will be NULL.","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","description":"The type of the entity that owns this DID. If the DID is unassigned, this will be NULL.","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an unassigned or assigned DID in a DID Pool."},"DIDNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DID":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/DomainEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeTrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"]},"site":{"description":"Used to determine the media regions for inbound and outbound calls through a trunk. Also determines the dial plan to use for calls that came in on a trunk and have to be sent out on it as well.","$ref":"#/definitions/DomainEntityRef"},"inboundSite":{"description":"Allows a customer to set the site to which inbound calls will be routed","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPool":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. The number must be between 3 and 9 digits in length and the same length as the endNumber."},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. The number must be between 3 and 9 digits in length and the same length as the startNumber."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPoolDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The extension pool identifier"},"name":{"type":"string","description":"The start number of the extension pool."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPoolDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPoolDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Extension":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"extensionPool":{"$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineBase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"lineMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Line":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"description":"The edge group associated with the line. (Deprecated)","$ref":"#/definitions/DomainEntityRef"},"template":{"$ref":"#/definitions/DomainEntityRef"},"site":{"$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"description":"The primary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"secondaryEdge":{"description":"The secondary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/DomainEntityRef"},"defaultForUser":{"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJob":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobFile":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud. Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobUploadRequest":{"type":"object","required":["fileIds"],"properties":{"fileIds":{"type":"array","description":"A list of file ids to upload.","items":{"type":"string"}}}},"EdgeLogsJobResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string","description":"A relative directory to the root Edge log folder to query from."},"query":{"type":"string","description":"The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter."},"recurse":{"type":"boolean","description":"Boolean whether or not to recurse into directories."}}},"EdgeMetrics":{"type":"object","properties":{"edge":{"$ref":"#/definitions/DomainEntityRef"},"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"upTimeMsec":{"type":"integer","format":"int64"},"processors":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsProcessor"}},"memory":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsMemory"}},"disks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsDisk"}},"subsystems":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsSubsystem"}},"networks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsNetwork"}}}},"EdgeMetricsDisk":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"partitionName":{"type":"string","description":"Disk partition name."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsMemory":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"type":{"type":"string","description":"Type of memory. Virtual or physical."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsNetwork":{"type":"object","properties":{"ifname":{"type":"string","description":"Identifier for the network adapter."},"sentBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes sent per second."},"receivedBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes received per second."},"bandwidthBitsPerSec":{"type":"number","format":"double","description":"Total bandwidth of the adapter in bits per second."},"utilizationPct":{"type":"number","format":"double","description":"Percent utilization of the network adapter."}}},"EdgeMetricsProcessor":{"type":"object","properties":{"activeTimePct":{"type":"number","format":"double","description":"Percent time processor was active."},"cpuId":{"type":"string","description":"Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources."},"idleTimePct":{"type":"number","format":"double","description":"Percent time processor was idle."},"privilegedTimePct":{"type":"number","format":"double","description":"Percent time processor spent in privileged mode."},"userTimePct":{"type":"number","format":"double","description":"Percent time processor spent in user mode."}}},"EdgeMetricsSubsystem":{"type":"object","properties":{"delayMs":{"type":"integer","format":"int32","description":"Delay in milliseconds."},"processName":{"type":"string","description":"Name of the Edge process."},"mediaSubsystem":{"description":"Subsystem for an Edge device.","$ref":"#/definitions/EdgeMetricsSubsystem"}}},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"NumberPlan":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRoute":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"site":{"description":"The site associated to the outbound route.","readOnly":true,"$ref":"#/definitions/Site"},"managed":{"type":"boolean","description":"Is this outbound route being managed remotely.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneBase":{"type":"object","required":["lines","name","phoneMetaBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"phoneMetaBase":{"description":"A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.","$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"The list of linebases associated with the phone base.","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean"},"registers":{"type":"boolean"},"dualRegisters":{"type":"boolean"},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean"},"noRebalance":{"type":"boolean"},"noCloudProvisioning":{"type":"boolean"},"mediaCodecs":{"type":"array","items":{"type":"string","enum":["audio/opus","audio/pcmu","audio/pcma","audio/g729","audio/g722"]}},"cdm":{"type":"boolean"}}},"PhoneBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Metabase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"type":{"type":"string","enum":["EXTERNAL","EXTERNAL_PCV","EXTERNAL_PCV_AWS","EXTERNAL_BYOC_CARRIER","EXTERNAL_BYOC_PBX","STATION_CDM","STATION_CDM_WEBRTC","STATION","TIE","TIE_DIRECT","TIE_INDIRECT","TIE_CLOUD_PROXY"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line."},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Phone":{"type":"object","required":["lines","name","phoneBaseSettings","site"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"site":{"description":"The site associated to the phone.","$ref":"#/definitions/DomainEntityRef"},"phoneBaseSettings":{"description":"Phone Base Settings","$ref":"#/definitions/PhoneBaseSettings"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"phoneMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"Lines","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"userAgentInfo":{"description":"User Agent Information for this phone. This includes model, firmware version, and manufacturer.","readOnly":true,"$ref":"#/definitions/UserAgentInfo"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.","$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneBaseSettings":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this phone base settings"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE","UNKNOWN"]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"]},"eventCreationTime":{"type":"string","description":"Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London"},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object. Deprecated. Do not use."}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"UserAgentInfo":{"type":"object","properties":{"firmwareVersion":{"type":"string","description":"The firmware version of the phone."},"manufacturer":{"type":"string","description":"The manufacturer of the phone."},"model":{"type":"string","description":"The model of the phone."}}},"PhoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","description":"The list of phone Ids to reboot.","items":{"type":"string"}},"siteId":{"type":"string","description":"ID of the site for which to reboot all phones at that site.\nno.active.edge and phone.cannot.resolve errors are ignored."}}},"ExpiredEdgeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"SiteConnections":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"siteConnections":{"type":"array","description":"List of site connections","readOnly":true,"items":{"$ref":"#/definitions/SiteConnection"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DisableSiteConnectionsRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"SiteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRouteBase":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRouteBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetrics":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logicalInterface":{"$ref":"#/definitions/DomainEntityRef"},"trunk":{"$ref":"#/definitions/DomainEntityRef"},"calls":{"$ref":"#/definitions/TrunkMetricsCalls"},"qos":{"$ref":"#/definitions/TrunkMetricsQoS"}}},"TrunkMetricsCalls":{"type":"object","properties":{"inboundCallCount":{"type":"integer","format":"int32"},"outboundCallCount":{"type":"integer","format":"int32"}}},"TrunkMetricsQoS":{"type":"object","required":["mismatchCount"],"properties":{"mismatchCount":{"type":"integer","format":"int32","description":"Total number of QoS mismatches over the course of the last 24-hour period (sliding window)."}}},"TrunkBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrunkBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"Trunk":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/DomainEntityRef"},"inService":{"type":"boolean","description":"True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.","readOnly":true},"enabled":{"type":"boolean","description":"True if the Edge used by this trunk is in-service"},"logicalInterface":{"description":"The Logical Interface on the Edge to which the trunk is assigned.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"connectedStatus":{"description":"The connected status of the trunk","readOnly":true,"$ref":"#/definitions/TrunkConnectedStatus"},"optionsStatus":{"type":"array","description":"The trunk optionsStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsOptions"}},"registersStatus":{"type":"array","description":"The trunk registersStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsRegisters"}},"ipStatus":{"description":"The trunk ipStatus","readOnly":true,"$ref":"#/definitions/TrunkMetricsNetworkTypeIp"},"optionsEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"]},"registersEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"]},"family":{"type":"integer","format":"int32","description":"The IP Network Family of the trunk","readOnly":true},"proxyAddressList":{"type":"array","description":"The list of proxy addresses (ports if provided) for the trunk","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkConnectedStatus":{"type":"object","properties":{"connected":{"type":"boolean"},"connectedStateTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrunkEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkErrorInfo":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string"},"details":{"$ref":"#/definitions/TrunkErrorInfoDetails"}}},"TrunkErrorInfoDetails":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"hostname":{"type":"string"}}},"TrunkMetricsNetworkTypeIp":{"type":"object","properties":{"address":{"type":"string","description":"Assigned IP Address for the interface"},"errorInfo":{"description":"Information about the error.","$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsOptions":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this options array element represents."},"optionState":{"type":"boolean"},"optionStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the option state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsRegisters":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this registers array element represents."},"registerState":{"type":"boolean","description":"True if last REGISTER message had positive response; false if error response or no response."},"registerStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the register state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"MetaData":{"type":"object","properties":{"pairing-token":{"type":"string"},"pairing-trust":{"type":"array","items":{"type":"string"}},"pairing-url":{"type":"string"}}},"VmPairingInfo":{"type":"object","properties":{"meta-data":{"description":"This is to be used to complete the setup process of a locally deployed virtual edge device.","$ref":"#/definitions/MetaData"},"edge-id":{"type":"string"},"auth-token":{"type":"string"},"org-id":{"type":"string"}}},"HomerRecord":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"date":{"type":"string","format":"date-time","description":"metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milliTs":{"type":"string","description":"metadata associated to the SIP calls"},"microTs":{"type":"string","description":"metadata associated to the SIP calls"},"method":{"type":"string","description":"metadata associated to the SIP calls"},"replyReason":{"type":"string","description":"metadata associated to the SIP calls"},"ruri":{"type":"string","description":"metadata associated to the SIP calls"},"ruriUser":{"type":"string","description":"metadata associated to the SIP calls"},"ruriDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromUser":{"type":"string","description":"metadata associated to the SIP calls"},"fromDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromTag":{"type":"string","description":"metadata associated to the SIP calls"},"toUser":{"type":"string","description":"metadata associated to the SIP calls"},"toDomain":{"type":"string","description":"metadata associated to the SIP calls"},"toTag":{"type":"string","description":"metadata associated to the SIP calls"},"pidUser":{"type":"string","description":"metadata associated to the SIP calls"},"contactUser":{"type":"string","description":"metadata associated to the SIP calls"},"authUser":{"type":"string","description":"metadata associated to the SIP calls"},"callid":{"type":"string","description":"metadata associated to the SIP calls"},"callidAleg":{"type":"string","description":"metadata associated to the SIP calls"},"via1":{"type":"string","description":"metadata associated to the SIP calls"},"via1Branch":{"type":"string","description":"metadata associated to the SIP calls"},"cseq":{"type":"string","description":"metadata associated to the SIP calls"},"diversion":{"type":"string","description":"metadata associated to the SIP calls"},"reason":{"type":"string","description":"metadata associated to the SIP calls"},"contentType":{"type":"string","description":"metadata associated to the SIP calls"},"auth":{"type":"string","description":"metadata associated to the SIP calls"},"userAgent":{"type":"string","description":"metadata associated to the SIP calls"},"sourceIp":{"type":"string","description":"metadata associated to the SIP calls"},"sourcePort":{"type":"string","description":"metadata associated to the SIP calls"},"destinationIp":{"type":"string","description":"metadata associated to the SIP calls"},"destinationPort":{"type":"string","description":"metadata associated to the SIP calls"},"contactIp":{"type":"string","description":"metadata associated to the SIP calls"},"contactPort":{"type":"string","description":"metadata associated to the SIP calls"},"originatorIp":{"type":"string","description":"metadata associated to the SIP calls"},"originatorPort":{"type":"string","description":"metadata associated to the SIP calls"},"correlationId":{"type":"string","description":"metadata associated to the SIP calls"},"proto":{"type":"string","description":"metadata associated to the SIP calls"},"family":{"type":"string","description":"metadata associated to the SIP calls"},"rtpStat":{"type":"string","description":"metadata associated to the SIP calls"},"type":{"type":"string","description":"metadata associated to the SIP calls"},"node":{"type":"string","description":"metadata associated to the SIP calls"},"trans":{"type":"string","description":"metadata associated to the SIP calls"},"dbnode":{"type":"string","description":"metadata associated to the SIP calls"},"msg":{"type":"string","description":"metadata associated to the SIP calls"},"sourceAlias":{"type":"string","description":"metadata associated to the SIP calls"},"destinationAlias":{"type":"string","description":"metadata associated to the SIP calls"},"conversationId":{"type":"string","description":"metadata associated to the SIP calls"},"participantId":{"type":"string","description":"metadata associated to the SIP calls"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipSearchResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"integer","format":"int32","description":"Status of the search request"},"sid":{"type":"string","description":"Session id associated to the search request"},"auth":{"type":"string","description":"Auth token used for this search request"},"message":{"type":"string","description":"Any messages returned from homer as part of the response"},"data":{"type":"array","description":"Homer search data that is returned","items":{"$ref":"#/definitions/HomerRecord"}},"count":{"type":"integer","format":"int32","description":"Number of records returned"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipDownloadResponse":{"type":"object","properties":{"downloadId":{"type":"string","description":"unique id of the downloaded file"},"documentId":{"type":"string","description":"Document id of pcap file"}}},"SIPSearchPublicRequest":{"type":"object","required":["dateEnd","dateStart"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"callId":{"type":"string","description":"unique identification of the placed call"},"toUser":{"type":"string","description":"SIP user to who the call was placed"},"fromUser":{"type":"string","description":"SIP user who placed the call"},"conversationId":{"type":"string","description":"Unique identification of the conversation"},"participantId":{"type":"string","description":"Unique identification of the participant"},"dateStart":{"type":"string","format":"date-time","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SignedUrlResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","format":"url","description":"Url of the downloaded pcap file"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AcceleratorSpecification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"name of this accelerator","readOnly":true},"description":{"type":"string","description":"a description of the general purpose of this accelerator","readOnly":true},"origin":{"type":"string","description":"where the accelerator originated","readOnly":true,"enum":["Community","Partner","Genesys"]},"type":{"type":"string","description":"type of the artifact","readOnly":true,"enum":["Module","Accelerator","Blueprint"]},"classification":{"type":"string","description":"architectural classification into which the accelerator belongs","readOnly":true},"tags":{"type":"array","description":"tags","readOnly":true,"items":{"type":"string"}},"permissions":{"type":"array","description":"Genesys Cloud permissions required to install the accelerator","readOnly":true,"items":{"type":"string"}},"products":{"type":"array","description":"Genesys Cloud products required to install the accelerator","readOnly":true,"items":{"type":"string"}},"documentation":{"type":"array","description":"additional documentation about the artifact","readOnly":true,"items":{"$ref":"#/definitions/MetadataDocumentation"}},"presentation":{"type":"array","description":"presentation of data fields to be gathered for the accelerator","readOnly":true,"items":{"$ref":"#/definitions/MetadataPresentation"}},"results":{"description":"resources created or modified as a result of running the accelerator","readOnly":true,"$ref":"#/definitions/MetadataResults"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Metadata for a CX infrastructure as code accelerator"},"MetadataDocumentation":{"type":"object","properties":{"description":{"type":"string","description":"description of the documentation","readOnly":true},"location":{"type":"string","description":"location where the documentation can be accessed","readOnly":true}},"description":"Additional documentation about an artifact"},"MetadataPresentation":{"type":"object","properties":{"title":{"type":"string","description":"title for a set of data to be gathered","readOnly":true},"schema":{"description":"description of the contents of the data gathering interface","readOnly":true,"$ref":"#/definitions/MetadataSchema"}},"description":"A representation of data fields to be gathered for installing the accelerator"},"MetadataProperty":{"type":"object","properties":{"type":{"type":"string","description":"the data type of the input property","readOnly":true},"displayname":{"type":"string","description":"user-friendly name of the input property","readOnly":true},"description":{"type":"string","description":"brief description of the input property","readOnly":true},"sensitive":{"type":"string","description":"whether the property's value should be hidden from display","readOnly":true},"help":{"type":"string","description":"optional URL with addition information about the input property","readOnly":true},"default":{"type":"string","description":"optional default value of the input property","readOnly":true},"enum":{"type":"array","description":"set of possible values if the input property is an enumeration","readOnly":true,"items":{"type":"string"}}},"description":"Data property required as input for installing an accelerator"},"MetadataResultEntity":{"type":"object","properties":{"type":{"type":"string","description":"object type of the modified resource","readOnly":true},"description":{"type":"string","description":"description of the modified resource","readOnly":true},"visibility":{"type":"string","description":"whether the modified resource is visible or hidden","readOnly":true,"enum":["Visible","Hidden"]}},"description":"A Genesys Cloud resource created or modified as a result of running an accelerator"},"MetadataResults":{"type":"object","properties":{"entities":{"type":"array","description":"list of resources","readOnly":true,"items":{"$ref":"#/definitions/MetadataResultEntity"}}},"description":"List of resources created or modified as a result of running an accelerator"},"MetadataSchema":{"type":"object","properties":{"title":{"type":"string","description":"title for the data gathering page","readOnly":true},"description":{"type":"string","description":"description of the data being gathered on this page","readOnly":true},"type":{"type":"string","description":"type of data being gathered","readOnly":true},"properties":{"type":"array","description":"list of properties for which input is to be gathered, bother required and optional","readOnly":true,"items":{"type":"object","additionalProperties":{"$ref":"#/definitions/MetadataProperty"}}},"required":{"type":"array","description":"list of required properties","readOnly":true,"items":{"type":"string"}}},"description":"A description of the contents of a data gathering interface for an accelerator"},"AcceleratorList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AcceleratorMetadata"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AcceleratorMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"name of this accelerator","readOnly":true},"description":{"type":"string","description":"a description of the general purpose of this accelerator","readOnly":true},"origin":{"type":"string","description":"where the accelerator originated","readOnly":true,"enum":["Community","Partner","Genesys"]},"type":{"type":"string","description":"type of the artifact","readOnly":true,"enum":["Module","Accelerator","Blueprint"]},"classification":{"type":"string","description":"architectural classification into which the accelerator belongs","readOnly":true},"tags":{"type":"array","description":"tags","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Metadata for a CX infrastructure as code accelerator"},"InfrastructureascodeJob":{"type":"object","required":["dryRun"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dryRun":{"type":"boolean","description":"dryRun"},"acceleratorId":{"type":"string","description":"acceleratorId","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"dateSubmitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"submittedBy":{"description":"submittedBy","readOnly":true,"$ref":"#/definitions/UserReference"},"status":{"type":"string","description":"status","readOnly":true,"enum":["Created","Queued","Running","Complete","Failed","Incomplete"]},"errorInfo":{"description":"errorInfo","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"results":{"type":"string","description":"results","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Information about a CX infrastructure as code job"},"AcceleratorInput":{"type":"object","required":["acceleratorId"],"properties":{"dryRun":{"type":"boolean","description":"Set this true to test the job without making any changes. Defaults to false."},"acceleratorId":{"type":"string","description":"Accelerator ID"},"parameters":{"type":"array","description":"Parameters required for this accelerator","items":{"$ref":"#/definitions/AcceleratorParameter"}}},"description":"Identity of a CX infrastructure as code accelerator to be run and its inputs"},"AcceleratorParameter":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Parameter Name"},"value":{"type":"string","description":"Parameter Value"}},"description":"Input parameter for a CX infrastructure as code accelerator"},"Format":{"type":"object","properties":{"flags":{"type":"array","description":"The Set of prompt segment format flags i.e. each entry is a part of describing the overall format. E.g. \"format\": { \"flags\": [StringPlayChars] }","uniqueItems":true,"items":{"type":"string","enum":["BoolPlayYesNo","CurrencyAsMinorUnits","CurrencyMajorUnitsOnly","CurrencyMinorUnitsOnly","CurrencyPlayDigits","DateLongYear","DateShortYear","DateShortMonthAndDay","DateDayOfWeekOnly","DateDayOnly","DateMonthOnly","DateShortYearOnly","DateLongYearOnly","TimeTwentyFourHours","TimeTwelveHours","TimePartDays","TimePartHours","TimePartMinutes","TimePartSeconds","StringPlayChars","NumberPlayDigits","NumberOrdinal","LanguageCaseArticle","LanguageCaseAccusative","LanguageCaseDative","LanguageCaseGenitive","LanguageCaseNominative","LanguageQuantityPlural","LanguageQuantitySingular","LanguageGenderCommon","LanguageGenderFeminine","LanguageGenderMasculine","LanguageGenderNeuter","CaseArticle","CaseAccusative","CaseDative","CaseGenitive","CaseNominative","QuantityPlural","QuantitySingular","GenderCommon","GenderFeminine","GenderMasculine","GenderNeuter"]}}}},"TextBotDisconnectAction":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason for the disconnect.","enum":["TriggeredByUser","TriggeredByFlow","SessionExpired","Error","RecognitionFailure"]},"reasonExtendedInfo":{"type":"string","description":"Extended information related to the reason, if available."},"flowLocation":{"description":"Describes where in the Bot Flow the user was when the disconnect occurred.","$ref":"#/definitions/TextBotFlowLocation"},"flowOutcomes":{"type":"array","description":"The list of Flow Outcomes for the bot flow and their details.","items":{"$ref":"#/definitions/TextBotFlowOutcome"}}},"description":"Settings for a next-action of disconnecting, including the reason code for the disconnect."},"TextBotExitAction":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason for the exit.","enum":["TriggeredByUser","AgentRequestedByUser","TriggeredByFlow","Error","RecognitionFailure"]},"reasonExtendedInfo":{"type":"string","description":"Extended information related to the reason, if available."},"activeIntent":{"type":"string","description":"The active intent at the time of the exit."},"flowLocation":{"description":"Describes where in the Bot Flow the user was when the exit occurred.","$ref":"#/definitions/TextBotFlowLocation"},"outputData":{"description":"The output data for the bot flow.","$ref":"#/definitions/TextBotInputOutputData"},"flowOutcomes":{"type":"array","description":"The list of Flow Outcomes for the bot flow and their details.","items":{"$ref":"#/definitions/TextBotFlowOutcome"}}},"description":"Settings for a next-action of exiting the bot flow. Any output variables are available in the details."},"TextBotFlowLocation":{"type":"object","required":["actionName","actionNumber","sequenceName"],"properties":{"actionName":{"type":"string","description":"The name of the action that was active when the event of interest happened."},"actionNumber":{"type":"integer","format":"int32","description":"The number of the action that was active when the event of interest happened."},"sequenceName":{"type":"string","description":"The name of the state or task which was active when the event of interest happened."}},"description":"Describes a flow location."},"TextBotFlowMilestone":{"type":"object","required":["dateReached","id","sequence"],"properties":{"id":{"type":"string","description":"The Milestone's ID."},"dateReached":{"type":"string","format":"date-time","description":"The timestamp of when the milestone was reached. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sequence":{"type":"integer","format":"int64","description":"The sequence number of the milestone."}}},"TextBotFlowOutcome":{"type":"object","properties":{"outcomeId":{"type":"string","description":"The Flow Outcome ID."},"outcomeValue":{"type":"string","description":"The value of the FlowOutcome.","enum":["SUCCESS","FAILURE"]},"dateStart":{"type":"string","format":"date-time","description":"The timestamp for when the Flow Outcome began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"The timestamp for when the Flow Outcome finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milestones":{"type":"array","description":"The Flow Milestones for the Flow Outcome.","items":{"$ref":"#/definitions/TextBotFlowMilestone"}}},"description":"Flow Outcome data related to a bot flow which is exiting gracefully."},"TextBotFlowTurnResponse":{"type":"object","required":["id","nextActionType"],"properties":{"id":{"type":"string","description":"The ID of the bot flow turn. If additional turns are needed, supply this ID as the previous turn in your next turn request."},"previousTurn":{"description":"The reference to a previous turn, if applicable.","$ref":"#/definitions/TextBotTurnReference"},"prompts":{"description":"The output prompts for this turn.","$ref":"#/definitions/TextBotOutputPrompts"},"nextActionType":{"type":"string","description":"Indicates the suggested next action. If appropriate, the matching output event object includes additional information.","enum":["NoOp","Disconnect","WaitForInput","Exit"]},"nextActionDisconnect":{"description":"The next action directive for this turn if it is a Disconnect type.","$ref":"#/definitions/TextBotDisconnectAction"},"nextActionWaitForInput":{"description":"The next action directive for this turn if it is a WaitForInput type.","$ref":"#/definitions/TextBotWaitForInputAction"},"nextActionExit":{"description":"The next action directive for this turn if it is an Exit type.","$ref":"#/definitions/TextBotExitAction"}},"description":"Information related to a success bot flow turn request."},"TextBotInputOutputData":{"type":"object","required":["variables"],"properties":{"variables":{"type":"object","description":"The input/output variables using the format as appropriate for the variable data type in the flow definition.","additionalProperties":{"type":"object"}}},"description":"Input/Output data related to a bot flow which is exiting gracefully."},"TextBotModeConstraints":{"type":"object","properties":{"text":{"description":"Mode constraints that apply to text scenarios.","$ref":"#/definitions/TextBotTextModeConstraints"}},"description":"Mode constraints to observe when operating on a bot flow."},"TextBotModeOutputPrompts":{"type":"object","required":["segments"],"properties":{"segments":{"type":"array","description":"The list of prompt segments.","items":{"$ref":"#/definitions/TextBotPromptSegment"}}},"description":"Prompt information related to a bot flow turn."},"TextBotOutputPrompts":{"type":"object","required":["outputLanguage"],"properties":{"outputLanguage":{"type":"string","description":"The ISO code of the output language for this prompt item."},"textPrompts":{"description":"Text output prompts, if any.","$ref":"#/definitions/TextBotModeOutputPrompts"}},"description":"Prompt information related to a bot flow turn."},"TextBotPromptSegment":{"type":"object","required":["text","type"],"properties":{"text":{"type":"string","description":"The text of this prompt segment."},"type":{"type":"string","description":"The segment type which describes any semantics about the 'text' and also indicates which other field might include additional relevant info.","enum":["Text","RichMedia"]},"format":{"description":"Additional details describing the segment’s contents, which the client should honour where possible.","$ref":"#/definitions/Format"},"content":{"type":"array","description":"Details to display Rich Media content. This is only populated when the segment 'type' is 'Rich Media'.","items":{"$ref":"#/definitions/MessageContent"}}},"description":"Data for a single bot flow prompt segment."},"TextBotTextModeConstraints":{"type":"object","required":["languagePreferences"],"properties":{"languagePreferences":{"type":"array","description":"The list of language preferences by their ISO language code.","items":{"type":"string"}},"noInputTimeoutMilliseconds":{"type":"integer","format":"int32","description":"The amount of time, in milliseconds, before the client should send the 'NoInput' event\n to trigger the \"no input\" bot response and handling on digital channels.\n Note: This optional field will only be returned for 'Digital Bot Flow' turns."}},"description":"Mode constraints to observe when operating on a bot flow."},"TextBotTurnReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the turn."}},"description":"A reference to a bot flow turn."},"TextBotWaitForInputAction":{"type":"object","required":["modeConstraints"],"properties":{"modeConstraints":{"description":"The mode constraints for the user input.","$ref":"#/definitions/TextBotModeConstraints"}},"description":"Settings for a next-action of waiting for additional user input and sending the data as an input action to the bot flow."},"TextBotErrorInputEvent":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"The error code."},"message":{"type":"string","description":"The error message."}},"description":"Settings for an input event to the bot flow indicating an error has occurred."},"TextBotFlowTurnRequest":{"type":"object","required":["inputEventType"],"properties":{"previousTurn":{"description":"The reference to a previous turn if appropriate, used to avoid race conditions.","$ref":"#/definitions/TextBotTurnReference"},"inputEventType":{"type":"string","description":"Indicates the type of input event being requested. If appropriate, fill out the matching user input object details on this request.","enum":["NoOp","UserInput","Error","NoMatch","NoInput","UserDisconnect","ClientSessionExpired"]},"inputEventUserInput":{"description":"The data for the input event of this turn if it is a user input event. Only one inputEvent may be set.","$ref":"#/definitions/TextBotUserInputEvent"},"inputEventError":{"description":"The data for the input event of this turn if it is an error event. Only one inputEvent may be set.","$ref":"#/definitions/TextBotErrorInputEvent"}},"description":"Settings for a turn request to a bot flow."},"TextBotTranscript":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the transcript item."},"confidence":{"type":"number","format":"float","description":"The confidence factor, expressed as a decimal between 0.0 and 1.0, of the transcript item."}},"description":"Data for a single bot flow transcript."},"TextBotUserInputAlternative":{"type":"object","required":["transcript"],"properties":{"transcript":{"description":"The user input transcript.","$ref":"#/definitions/TextBotTranscript"}},"description":"User input data used in a bot flow turn."},"TextBotUserInputEvent":{"type":"object","required":["alternatives","mode"],"properties":{"mode":{"type":"string","description":"The input mode.","enum":["Text"]},"alternatives":{"type":"array","description":"The input alternatives.","items":{"$ref":"#/definitions/TextBotUserInputAlternative"}}},"description":"Settings for an input event to the bot flow indicating user input is available."},"TextBotFlowLaunchResponse":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The session ID of the bot flow, used to send to subsequent turn requests"}},"description":"Information related to a successful launch of a bot flow. The ID will be used in subsequent turn requests of the bot flow."},"TextBotChannel":{"type":"object","required":["inputModes","name","outputModes","userAgent"],"properties":{"name":{"type":"string","description":"The name of the channel.","enum":["Chat","Call","Messaging"]},"inputModes":{"type":"array","description":"The input modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text"]}},"outputModes":{"type":"array","description":"The output modes for the channel.","uniqueItems":true,"items":{"type":"string","enum":["Text"]}},"userAgent":{"description":"Information about the end user agent calling the bot flow.","$ref":"#/definitions/TextBotUserAgent"}},"description":"Channel information relevant to a bot flow."},"TextBotFlow":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Bot Flow ID."}},"description":"Description of the Bot Flow."},"TextBotFlowLaunchRequest":{"type":"object","required":["channel","externalSessionId","flow"],"properties":{"flow":{"description":"Specifies which Bot Flow to launch.","$ref":"#/definitions/TextBotFlow"},"externalSessionId":{"type":"string","description":"The ID of the external session that is associated with the bot flow."},"conversationId":{"type":"string","description":"A conversation ID to associate with the bot flow, if available."},"inputData":{"description":"Input values to the flow. Valid values are defined by the flow's input JSON schema.","$ref":"#/definitions/TextBotInputOutputData"},"channel":{"description":"Channel information relevant to the bot flow.","$ref":"#/definitions/TextBotChannel"},"language":{"type":"string","description":"The language that the bot will use in the session. Validated against list of supported languages and if the value is omitted or is invalid, the default language will be used."}},"description":"Settings for launching an instance of a bot flow."},"PostTextMessage":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Message type","enum":["Text","Structured","Receipt","Event","Message","Unknown"]},"text":{"type":"string","description":"Message text. If type is structured, used as fallback for clients that do not support particular structured content"},"content":{"type":"array","description":"A list of content elements in message","items":{"$ref":"#/definitions/ConversationMessageContent"}}}},"PostTextResponse":{"type":"object","required":["botState"],"properties":{"botState":{"type":"string","description":"The state of the bot after completion of the request","enum":["Complete","Failed","MoreData"]},"replyMessages":{"type":"array","description":"The list of messages to respond with, if any","items":{"$ref":"#/definitions/PostTextMessage"}},"intentName":{"type":"string","description":"The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected."},"slots":{"type":"object","description":"Data parameters detected and filled by the bot.","additionalProperties":{"type":"string"}},"botCorrelationId":{"type":"string","description":"The optional ID specified in the request"},"amazonLex":{"type":"object","description":"Raw data response from AWS (if called)","additionalProperties":{"type":"object"}},"googleDialogFlow":{"type":"object","description":"Raw data response from Google Dialogflow (if called)","additionalProperties":{"type":"object"}},"genesysDialogEngine":{"type":"object","description":"Raw data response from Genesys' Dialogengine (if called)","additionalProperties":{"type":"object"}},"genesysBotConnector":{"type":"object","description":"Raw data response from Genesys' BotConnector (if called)","additionalProperties":{"type":"object"}},"nuanceMixDlg":{"type":"object","description":"Raw data response from Nuance Mix Dlg (if called)","additionalProperties":{"type":"object"}}}},"AmazonLexRequest":{"type":"object","properties":{"requestAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs","additionalProperties":{"type":"string"}},"sessionAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs","additionalProperties":{"type":"string"}}}},"GenesysBotConnector":{"type":"object","properties":{"queryParameters":{"type":"object","description":"User defined name/value parameters passed to the BotConnector bot.","additionalProperties":{"type":"string"}}}},"GoogleDialogflowCustomSettings":{"type":"object","properties":{"environment":{"type":"string","description":"If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions"},"eventName":{"type":"string","description":"If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text. See https://cloud.google.com/dialogflow/es/docs/events-overview"},"webhookQueryParameters":{"type":"object","description":"Parameters passed to the fulfillment webhook of the bot (if any).","additionalProperties":{"type":"string"}},"eventInputParameters":{"type":"object","description":"Parameters passed to the event input of the bot.","additionalProperties":{"type":"string"}}}},"NuanceMixDlgSettings":{"type":"object","properties":{"channelId":{"type":"string","description":"The Nuance channel ID to use when launching the Nuance bot, which must one of the code names of the bot's registered input channels."},"inputParameters":{"type":"object","description":"Name/value pairs of input variables to be sent to the Nuance bot. The values must be in the appropriate format for the variable's type (see https://docs.mix.nuance.com/dialog-grpc/v1/#simple-variable-types for help)","additionalProperties":{"type":"object"}}}},"PostTextRequest":{"type":"object","required":["botId","botSessionId","integrationId","postTextMessage"],"properties":{"botId":{"type":"string","description":"ID of the bot to send the text to."},"botAlias":{"type":"string","description":"Alias/Version of the bot"},"integrationId":{"type":"string","description":"the integration service id for the bot's credentials"},"botSessionId":{"type":"string","description":"GUID for this bot's session"},"postTextMessage":{"description":"Message to send to the bot","$ref":"#/definitions/PostTextMessage"},"languageCode":{"type":"string","description":"The launguage code the bot will run under"},"botSessionTimeoutMinutes":{"type":"integer","format":"int32","description":"Override timeout for the bot session. This should be greater than 10 minutes."},"botChannels":{"type":"array","description":"The channels this bot is utilizing","items":{"type":"string","enum":["Call","Callback","Messaging","Webchat"]}},"botCorrelationId":{"type":"string","description":"Id for tracking the activity - this will be returned in the response"},"messagingPlatformType":{"type":"string","description":"If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"]},"amazonLexRequest":{"description":"Provider specific settings, if any","$ref":"#/definitions/AmazonLexRequest"},"googleDialogflow":{"description":"Provider specific settings, if any","$ref":"#/definitions/GoogleDialogflowCustomSettings"},"genesysBotConnector":{"description":"Provider specific settings, if any","$ref":"#/definitions/GenesysBotConnector"},"nuanceMixDlg":{"description":"Provider specific settings, if any","$ref":"#/definitions/NuanceMixDlgSettings"}}},"BotSearchResponse":{"type":"object","required":["botType","id","name"],"properties":{"id":{"type":"string","description":"The id of the bot"},"name":{"type":"string","description":"The name of the bot"},"botType":{"type":"string","description":"The provider of the bot","enum":["GenesysBotConnector","GenesysDialogEngine","AmazonLex","GoogleDialogFlowES","GoogleDialogFlowCX","NuanceDlg","GenesysBotFlow"]},"description":{"type":"string","description":"The description of the bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BotSearchResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BotSearchResponse"}}}},"IdleTokenTimeout":{"type":"object","properties":{"idleTokenTimeoutSeconds":{"type":"integer","format":"int32","description":"Token timeout length in seconds. Must be at least 5 minutes and 8 hours or less (if HIPAA is disabled) or 15 minutes or less (if HIPAA is enabled).","minimum":300},"enableIdleTokenTimeout":{"type":"boolean","description":"Indicates whether the Token Timeout should be enabled or disabled."}}},"UCI10n":{"type":"object","properties":{"name":{"type":"string"}}},"UCIcon":{"type":"object","required":["vector"],"properties":{"vector":{"type":"string","description":"vector","readOnly":true}}},"UnifiedCommunicationsIntegration":{"type":"object","required":["badgeIcons","i10n","icon","integrationPresenceSource","pbxPermission","polledPresence","ucIntegrationKey","userPermissions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ucIntegrationKey":{"description":"ucIntegrationKey","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"integrationPresenceSource":{"type":"string","description":"integrationPresenceType","readOnly":true,"enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"pbxPermission":{"type":"string","description":"pbxPermission","readOnly":true},"icon":{"description":"icon","readOnly":true,"$ref":"#/definitions/UCIcon"},"badgeIcons":{"type":"object","description":"badgeIcon","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCIcon"}},"i10n":{"type":"object","description":"i10n","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCI10n"}},"polledPresence":{"type":"boolean","description":"polledPresence","readOnly":true},"pollIntervalSec":{"type":"integer","format":"int32","description":"pollIntervalSec","readOnly":true},"userPermissions":{"type":"array","description":"userPermissions","readOnly":true,"items":{"type":"string"}},"oauthScopes":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"UC Integration UI configuration data"},"UnifiedCommunicationsIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UnifiedCommunicationsIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UCIntegration":{"type":"object","required":["badgeIcons","i10n","icon","integrationPresenceSource","pbxPermission","polledPresence","ucIntegrationKey","userPermissions"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"ucIntegrationKey":{"type":"string","description":"ucIntegrationKey","readOnly":true},"integrationPresenceSource":{"type":"string","description":"integrationPresenceType","readOnly":true,"enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"pbxPermission":{"type":"string","description":"pbxPermission","readOnly":true},"icon":{"description":"icon","readOnly":true,"$ref":"#/definitions/UCIcon"},"badgeIcons":{"type":"object","description":"badgeIcon","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCIcon"}},"i10n":{"type":"object","description":"i10n","readOnly":true,"additionalProperties":{"$ref":"#/definitions/UCI10n"}},"polledPresence":{"type":"boolean","description":"polledPresence","readOnly":true},"userPermissions":{"type":"array","description":"userPermissions","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"UC Integration UI configuration data"},"UCIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UCIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UCThirdPartyPresence":{"type":"object","required":["email","presence"],"properties":{"email":{"type":"string","description":"Primary Email address of the associated Genesys Cloud user."},"presence":{"type":"string","description":"Integration presence value."},"message":{"type":"string","description":"Integration presence message."},"dateModified":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of presence value change."}},"description":"Update a Genesys Cloud user's presence from a given 3rd-party integration"},"ApiUsageOrganizationQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"]},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"]}},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","UserId","TemplateUri","HttpMethod"]}}}},"ApiUsageSimpleSearch":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Date","ClientName","HttpMethod","TemplateUri","Status200","Status300","Status400","Status500","Status429"]}},"oauthClientNames":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of OAuth client names to be queried.","items":{"type":"string"}},"httpMethods":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of HTTP methods to be queried.","items":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","HEAD","CONNECT","OPTIONS","TRACE"]}},"templateUris":{"type":"array","description":"Behaves like a SQL WHERE with multiple IN operators. Specifies a list of Template Uris to be queried.","items":{"type":"string"}}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserExternalIdentifier":{"type":"object","required":["authorityName","externalKey"],"properties":{"authorityName":{"type":"string","description":"Authority or System of Record which owns the External Identifier"},"externalKey":{"type":"string","description":"External Key"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a link between an External Identifier and Authority pair to a Entity Type and Entity Identifier pair. Represents the two way, one to one mapping of an External Authority or System of Record's identifier to a PureCloud entity. e.g. (ExternalId='05001',Authority='XyzCRM') to (entityType=user,entityId='8eb03b33-3acb-4bc1-a244-50b9b9f19495')"},"ChangeMyPasswordRequest":{"type":"object","required":["newPassword","oldPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"},"oldPassword":{"type":"string","description":"Your current password"}}},"FieldConfigs":{"type":"object","properties":{"org":{"$ref":"#/definitions/FieldConfig"},"person":{"$ref":"#/definitions/FieldConfig"},"group":{"$ref":"#/definitions/FieldConfig"}}},"UserMe":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"preferredName":{"type":"string","description":"Preferred full name of the agent"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"integrationPresence":{"description":"Integration presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"dateLastLogin":{"type":"string","format":"date-time","description":"The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 non-divisioned presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"divisionedPresenceDefinitions":{"type":"array","description":"The presence definitions that the user has access to","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresenceDefinition"}},"locationDefinitions":{"type":"array","description":"The first 100 site locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/LocationDefinition"}},"orgAuthorization":{"type":"array","description":"The first 100 organization roles, with applicable permission policies, for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationRole"}},"favorites":{"type":"array","description":"The first 50 favorited users.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"superiors":{"type":"array","description":"The first 50 superiors of this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","description":"The first 50 direct reports to this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"adjacents":{"description":"The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.","readOnly":true,"$ref":"#/definitions/Adjacents"},"routingSkills":{"type":"array","description":"The first 50 routing skills for user's organizations","readOnly":true,"items":{"$ref":"#/definitions/RoutingSkill"}},"fieldConfigs":{"description":"The field config for all entities types of user's organization","readOnly":true,"$ref":"#/definitions/FieldConfigs"},"token":{"description":"Information about the current token","readOnly":true,"$ref":"#/definitions/TokenInfo"},"trustors":{"type":"array","description":"Organizations having this user as a trustee","readOnly":true,"items":{"$ref":"#/definitions/Trustor"}},"orgProducts":{"type":"array","description":"Products enabled in this organization","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChangePasswordRequest":{"type":"object","required":["newPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"}}},"UpdateUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email address, phone number, and/or extension for this user. One entry is allowed per media type","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"username":{"type":"string"},"preferredName":{"type":"string","description":"Preferred full name of agent"},"manager":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","items":{"$ref":"#/definitions/Group"}},"state":{"type":"string","description":"The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.","enum":["active","inactive","deleted"]},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguagePost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing language to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings."},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id."},"UserLanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingSkillPost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing skill to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserSkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserSkillGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillGroup"}},"nextUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"}}},"UserState":{"type":"object","properties":{"state":{"type":"string","description":"User's current state.","enum":["active","inactive","deleted"]},"version":{"type":"integer","format":"int32","description":"Version of this user."},"stateChangeReason":{"type":"string","description":"Reason for a change in the user's state.","enum":["Voluntary","Seasonal","Leave","Performance","Conduct","Unknown"]},"stateChangeDate":{"type":"string","format":"date-time","description":"Date that the state was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"PatchUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"preferredName":{"type":"string","description":"Preferred full name of agent"},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"}}},"CreateUser":{"type":"object","required":["divisionId","email","name"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"},"divisionId":{"type":"string","description":"The division to which this user will belong"},"state":{"type":"string","description":"Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.","enum":["active","inactive","deleted"]}}},"UsersSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/User"}}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/UserSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["addresses.email","addresses.voice","addresses.address","addresses.voicemailEnabled","chat.jabberId","department","email","username","siteId","manager.id","hr.employeeId","integration","groups.social.id","groups.official.id","groups.distribution.id","state","id","languages.guid","languages.name","languages.namespace","languages.proficiency","name","primaryContactInfo.voice","primaryContactInfo.sms","primaryContactInfo.email","profileSkills","queueMembership.added","queueMembership.joined","routingSkills.guid","routingSkills.name","routingSkills.namespace","routingSkills.proficiency","title","divisionId","teamId"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL","QUERY_STRING"]}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"integrationPresenceSource":{"type":"string","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.","enum":["MicrosoftTeams","ZoomPhone","EightByEight"]},"enforcePermissions":{"type":"boolean","description":"This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"}}},"VoicemailCopyRecord":{"type":"object","properties":{"user":{"description":"The user that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/Group"},"date":{"type":"string","format":"date-time","description":"The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"description":"The conversation that the voicemail message is associated with","readOnly":true,"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","description":"Whether the voicemail message is marked as read"},"audioRecordingDurationSeconds":{"type":"integer","format":"int32","description":"The voicemail message's audio recording duration in seconds","readOnly":true},"audioRecordingSizeBytes":{"type":"integer","format":"int64","description":"The voicemail message's audio recording size in bytes","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"deletedDate":{"type":"string","format":"date-time","description":"The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"callerAddress":{"type":"string","description":"The caller address","readOnly":true},"callerName":{"type":"string","description":"Optionally the name of the caller that left the voicemail message if the caller was a known user","readOnly":true},"callerUser":{"description":"Optionally the user that left the voicemail message if the caller was a known user","readOnly":true,"$ref":"#/definitions/User"},"deleted":{"type":"boolean","description":"Whether the voicemail message has been marked as deleted"},"note":{"type":"string","description":"An optional note"},"user":{"description":"The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue","readOnly":true,"$ref":"#/definitions/Group"},"queue":{"description":"The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group","readOnly":true,"$ref":"#/definitions/Queue"},"copiedFrom":{"description":"Represents where this voicemail message was copied from","readOnly":true,"$ref":"#/definitions/VoicemailCopyRecord"},"copiedTo":{"type":"array","description":"Represents where this voicemail has been copied to","readOnly":true,"items":{"$ref":"#/definitions/VoicemailCopyRecord"}},"deleteRetentionPolicy":{"description":"The retention policy for this voicemail when deleted is set to true","$ref":"#/definitions/VoicemailRetentionPolicy"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailRetentionPolicy":{"type":"object","properties":{"voicemailRetentionPolicyType":{"type":"string","description":"The retention policy type","enum":["RETAIN_INDEFINITELY","RETAIN_WITH_TTL","IMMEDIATE_DELETE"]},"numberOfDays":{"type":"integer","format":"int32","description":"If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"}},"description":"Governs how the voicemail is retained"},"VoicemailGroupPolicy":{"type":"object","properties":{"name":{"type":"string"},"group":{"description":"The group associated with the policy","readOnly":true,"$ref":"#/definitions/Group"},"enabled":{"type":"boolean","description":"Whether voicemail is enabled for the group"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to group members when a new voicemail is received"},"disableEmailPii":{"type":"boolean","description":"Removes any PII from group emails. This is overridden by the analogous organization configuration value. This is always true if HIPAA is enabled or unknown for an organization."},"includeEmailTranscriptions":{"type":"boolean","description":"Whether to include the voicemail transcription in a group notification email"},"languagePreference":{"type":"string","description":"The language preference for the group. Used for group voicemail transcription"},"rotateCallsSecs":{"type":"integer","format":"int32","description":"How many seconds to ring before rotating to the next member in the group"},"stopRingingAfterRotations":{"type":"integer","format":"int32","description":"How many rotations to go through"},"overflowGroupId":{"type":"string","description":"A fallback group to contact when all of the members in this group did not answer the call."},"groupAlertType":{"type":"string","description":"Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.","enum":["RANDOM","ROUND_ROBIN","SEQUENTIAL"]},"interactiveResponsePromptId":{"type":"string","description":"The prompt to use when connecting a user to a Group Ring call"},"interactiveResponseRequired":{"type":"boolean","description":"Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64","description":"The total number of bytes for all voicemail message audio recordings","readOnly":true},"totalCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages","readOnly":true},"unreadCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as unread","readOnly":true},"deletedCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as deleted","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"newestUnreadDate":{"type":"string","format":"date-time","description":"The date of the most recent unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"oldestUnreadDate":{"type":"string","format":"date-time","description":"The date of the most oldest unread voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"newestReadDate":{"type":"string","format":"date-time","description":"The date of the most recent read voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"oldestReadDate":{"type":"string","format":"date-time","description":"The date of the most oldest read voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the user has voicemail enabled","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds to ring the user's phone before a call is transfered to voicemail"},"pin":{"type":"string","description":"The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to the user when a new voicemail is received"}}},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"CopyVoicemailMessage":{"type":"object","required":["voicemailMessageId"],"properties":{"voicemailMessageId":{"type":"string","description":"The id of the VoicemailMessage to copy"},"userId":{"type":"string","description":"The id of the User to copy the VoicemailMessage to"},"groupId":{"type":"string","description":"The id of the Group to copy the VoicemailMessage to"}},"description":"Used to copy a VoicemailMessage to either a User or a Group"},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voicemail is enabled for this organization","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The organization's default number of seconds to ring a user's phone before a call is transferred to voicemail"},"pinConfiguration":{"description":"The configuration for user PINs to access their voicemail from a phone","$ref":"#/definitions/PINConfiguration"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval. The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone."},"interactiveResponseRequired":{"type":"boolean","description":"Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting."},"includeEmailTranscriptions":{"type":"boolean","description":"Whether to include the voicemail transcription in the notification email"},"disableEmailPii":{"type":"boolean","description":"Removes any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization."},"maximumRecordingTimeSeconds":{"type":"integer","format":"int32","description":"Default value for the maximum length of time in seconds of a recorded voicemail"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/VoicemailMessage"}}}},"VoicemailSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"},"x-genesys-search-fields":{"value":["voicemailId","ownerId","ownerType","deleted","read","callerAddress","callerUser","createdDate","modifiedDate"]}},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL","DATE_RANGE"]}}},"VoicemailSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}}}},"RegisterArchitectJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"presignedUrl":{"type":"string","description":"Presigned URL to upload the file in S3","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArchitectJobMessage":{"type":"object","properties":{"dateTime":{"type":"string","format":"date-time","description":"The DateTime when the message was generated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The message type.","enum":["Error","Warning"]},"text":{"type":"string","description":"The text of the message."}}},"ArchitectJobStateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"Flow created from the Architect Job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"Status of the Architect Job","enum":["Registered","Started","Success","Failure"]},"command":{"type":"string","description":"The command executed by the Architect Job","enum":["Publish","Create","Update"]},"messages":{"type":"array","description":"Warnings and Errors messages of the Architect Job","items":{"$ref":"#/definitions/ArchitectJobMessage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The dependency type identifier"},"name":{"type":"string"},"versioned":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","AUDIOCONNECTORBOT","BOTCONNECTORBOT","BOTCONNECTORINTEGRATION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","DIALOGFLOWCXAGENT","DIGITALBOTFLOW","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GRAMMAR","GROUP","IMAGE","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","INQUEUEEMAILFLOW","INQUEUESHORTMESSAGEFLOW","IVRCONFIGURATION","KNOWLEDGEBASE","KNOWLEDGEBASEDOCUMENT","LANGUAGE","LEXBOT","LEXBOTALIAS","LEXV2BOT","LEXV2BOTALIAS","NLUDOMAIN","NUANCEMIXBOT","NUANCEMIXINTEGRATION","OAUTHCLIENT","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW"]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"User that initiated the build.","$ref":"#/definitions/User"},"client":{"description":"OAuth client that initiated the build.","$ref":"#/definitions/DomainEntityRef"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"DependencyTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmergencyCallFlow":{"type":"object","properties":{"emergencyFlow":{"description":"The call flow to execute in an emergency.","$ref":"#/definitions/DomainEntityRef"},"ivrs":{"type":"array","description":"The IVR(s) to route to the call flow during an emergency.","items":{"$ref":"#/definitions/DomainEntityRef"}}},"description":"An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it."},"EmergencyGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"enabled":{"type":"boolean","description":"True if an emergency is occurring and the associated emergency call flow(s) should be used. False otherwise."},"emergencyCallFlows":{"type":"array","description":"The emergency call flow(s) to use during an emergency.","items":{"$ref":"#/definitions/EmergencyCallFlow"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of emergency call flows to use in an emergency."},"EmergencyGroupDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The emergency group identifier"},"name":{"type":"string","description":"The emergency group name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of call flows."},"EmergencyGroupDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroupDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmergencyGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowRuntimeExecution":{"type":"object","required":["dateLaunched","flowVersion","status"],"properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The Version of the flow definition of the flow execution.","$ref":"#/definitions/FlowVersion"},"dateLaunched":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED","FAILED"]},"dateCompleted":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"outputData":{"type":"object","description":"List of the flow's output variables, if any. Output variables are only supplied for Completed flows.","additionalProperties":{"type":"object"}},"conversation":{"description":"The conversation to which this Flow execution is related","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow execution"},"FlowExecutionLaunchResponse":{"type":"object","properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The version of the flow that launched","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Response object from launching a flow."},"FlowExecutionLaunchRequest":{"type":"object","required":["flowId"],"properties":{"flowId":{"type":"string","description":"ID of the flow to launch."},"flowVersion":{"type":"string","description":"The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version."},"inputData":{"type":"object","description":"Input values to the flow. Valid values are defined by a flow's input JSON schema.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"A displayable name to assign to the new flow execution"}},"description":"Parameters for launching a flow."},"ConfusionInfo":{"type":"object","properties":{"intents":{"type":"array","description":"Confusion details between this utterance and other intents.","items":{"$ref":"#/definitions/ConfusionIntentInfo"}}}},"ConfusionIntentInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances in this intent which are similar to parent utterance."}}},"FlowHealthErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"messageWithParams":{"type":"string","description":"Error message with params included."},"messageParams":{"type":"object","description":"Map of variables and params for the error message.","additionalProperties":{"type":"object"}}}},"FlowHealthIntent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/FlowHealthIntentVersionInfo"},"language":{"type":"string","description":"Language provided for this intent's health.","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]},"health":{"description":"Health computation details for given language.","$ref":"#/definitions/HealthInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthIntentUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found for this utterance."},"staticValidationResults":{"type":"array","description":"Validation results for this utterance.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"outlierInfo":{"description":"Details about this utterance being an outlier or not.","$ref":"#/definitions/OutlierInfo"},"confusionInfo":{"description":"Confusion details with other utterances.","$ref":"#/definitions/ConfusionInfo"}}},"FlowHealthIntentVersionInfo":{"type":"object","properties":{"nluVersion":{"description":"NLU Version Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flowVersion":{"description":"Given flow's Version Info.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"nluDomain":{"description":"NLU Domain Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"HealthInfo":{"type":"object","properties":{"status":{"type":"string","description":"Status of health computation for this intent.","enum":["InProgress","Completed","Error"]},"errorInfo":{"description":"Error details for the intent, if any.","$ref":"#/definitions/FlowHealthErrorInfo"},"overallScore":{"type":"number","format":"float","description":"Overall health score for the intent ranged between 0 and 100 as 100 is the perfect health score."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found in the intent."},"staticValidationResults":{"type":"array","description":"Validation results for the intent.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"utterances":{"type":"array","description":"Utterances for this intent.","items":{"$ref":"#/definitions/FlowHealthIntentUtterance"}}}},"OutlierInfo":{"type":"object","properties":{"outlier":{"type":"boolean","description":"Boolean to identify if an outlier or not."},"score":{"type":"number","format":"float","description":"Outlier score for this utterance. The score is always 0 or greater and higher the score, the more outlier."}}},"ConfusionDetails":{"type":"object","properties":{"intents":{"type":"array","description":"Confusion details between this utterance and other intents.","items":{"$ref":"#/definitions/ConfusionIntentDetails"}}}},"ConfusionIntentDetails":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"utteranceCount":{"type":"integer","format":"int32","description":"Number of utterances in this intent which are similar to parent utterance."},"utterances":{"type":"array","description":"List of utterance which are similar to parent utterance.","items":{"$ref":"#/definitions/ConfusionUtterance"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConfusionUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"similarity":{"type":"number","format":"float","description":"Utterance's similarity score, 0 being dissimilar and 1 being very similar."}}},"FlowHealthUtterance":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"Utterance Text."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found for this utterance."},"language":{"type":"string","description":"Language provided for this utterance's health.","enum":["en-us","en-gb","en-au","en-za","en-nz","en-ie","fr-ca","fr-fr","es-us","es-es","es-mx","de-de","it-it","pt-br","pt-pt","nl-nl"]},"staticValidationResults":{"type":"array","description":"Validation results for the utterance.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}},"outlierInfo":{"description":"Details about this utterance being an outlier or not.","$ref":"#/definitions/OutlierInfo"},"confusionInfo":{"description":"Confusion details with other utterances.","$ref":"#/definitions/ConfusionDetails"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealth":{"type":"object","properties":{"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/FlowHealthVersionInfo"},"languageInfo":{"type":"object","description":"Each language's status about its health computation.","additionalProperties":{"$ref":"#/definitions/LocaleInfo"}},"intents":{"type":"array","description":"Health metrics information for the intents.","items":{"$ref":"#/definitions/FlowHealthIntentInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthIntentInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageHealth":{"type":"object","description":"Health computation info for each language.","additionalProperties":{"$ref":"#/definitions/LocaleHealth"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowHealthVersionInfo":{"type":"object","properties":{"flowVersion":{"description":"Given flow's Version Info.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"nluDomain":{"description":"NLU Domain Info for this flow version.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"LocaleFlowVersionInfo":{"type":"object","properties":{"nluVersion":{"description":"NLU Version Info for this flow version.","$ref":"#/definitions/AddressableEntityRef"}}},"LocaleHealth":{"type":"object","properties":{"overallScore":{"type":"number","format":"float","description":"Overall health score for the intent."},"issueCount":{"type":"integer","format":"int64","description":"Number of issues found in the intent."},"staticValidationResults":{"type":"array","description":"Validation results for the intent.","items":{"type":"string","enum":["TooFewUtterances","TooManyUtterances","UtteranceTooShort","UtteranceTooLong"]}}}},"LocaleInfo":{"type":"object","properties":{"status":{"type":"string","description":"Status of health computation for this flow version.","enum":["InProgress","Completed","Error"]},"errorInfo":{"description":"Error details for the flow version, if any.","$ref":"#/definitions/FlowHealthErrorInfo"},"flowVersionInfo":{"description":"Info about given flow version.","$ref":"#/definitions/LocaleFlowVersionInfo"}}},"FlowMilestone":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier","readOnly":true},"name":{"type":"string","description":"The flow milestone name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The flow milestone description."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowMilestoneDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier"},"name":{"type":"string","description":"The flow milestone name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowMilestoneDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestoneDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowMilestoneListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowOutcome":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"currentOperation":{"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowOutcomeDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowOutcomeDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcomeDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowOutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"HistoryEntry":{"type":"object","properties":{"action":{"type":"string","description":"The action performed","enum":["CHECKIN","CHECKOUT","CREATE","DEACTIVATE","DEBUG","DELETE","PUBLISH","REVERT","SAVE","TRANSCODE","UPDATE","UPLOAD"]},"resource":{"type":"string","description":"For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name. For example, for actions performed on prompt resources, this will be the prompt resource name."},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"User associated with this entry.","$ref":"#/definitions/User"},"client":{"description":"OAuth client associated with this entry.","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"string"},"secure":{"type":"boolean"}}},"HistoryListing":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","CHECKOUT","DEBUG","DELETE","HISTORY","PUBLISH","REVERT","SAVE","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"},"started":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completed":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/HistoryEntry"}},"pageCount":{"type":"integer","format":"int32"}}},"FlowVersionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","enum":["BOT","COMMONMODULE","DIGITALBOT","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","INQUEUEEMAIL","INQUEUESHORTMESSAGE","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","VOICE","VOICEMAIL","VOICESURVEY","WORKFLOW","WORKITEM"]},"description":{"type":"string","description":"the flow description"},"inputSchema":{"description":"json schema describing the inputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"description":"json schema describing the outputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"publishedVersion":{"description":"published version information if there is a published version","$ref":"#/definitions/FlowVersion"},"debugVersion":{"description":"debug version information if there is a debug version","$ref":"#/definitions/FlowVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IVR":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"dnis":{"type":"array","description":"The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number.","items":{"type":"string"}},"openHoursFlow":{"description":"The Architect flow to execute during the hours an organization is open.","$ref":"#/definitions/DomainEntityRef"},"closedHoursFlow":{"description":"The Architect flow to execute during the hours an organization is closed.","$ref":"#/definitions/DomainEntityRef"},"holidayHoursFlow":{"description":"The Architect flow to execute during an organization's holiday hours.","$ref":"#/definitions/DomainEntityRef"},"scheduleGroup":{"description":"The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR."},"IVREntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IVRDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The ivr identifier"},"name":{"type":"string","description":"The ivr name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An ivr."},"IVRDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVRDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"Prompt resource language","readOnly":true},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAssetCreate":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"The prompt language."},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Prompt":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The prompt identifier"},"name":{"type":"string","description":"The prompt name."},"description":{"type":"string"},"resources":{"type":"array","description":"List of resources associated with this prompt","readOnly":true,"items":{"$ref":"#/definitions/PromptAsset"}},"currentOperation":{"description":"Current prompt operation status","readOnly":true,"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"timeZone":{"type":"string","description":"The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones."},"openSchedules":{"type":"array","description":"The schedules defining the hours an organization is open.","items":{"$ref":"#/definitions/DomainEntityRef"}},"closedSchedules":{"type":"array","description":"The schedules defining the hours an organization is closed.","items":{"$ref":"#/definitions/DomainEntityRef"}},"holidaySchedules":{"type":"array","description":"The schedules defining the hours an organization is closed for the holidays.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of schedules that define the operating hours of an organization."},"ScheduleGroupDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The schedule group identifier"},"name":{"type":"string","description":"The schedule group name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A schedule group."},"ScheduleGroupDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroupDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Schedule":{"type":"object","required":["end","name","start"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource.","readOnly":true},"createdBy":{"type":"string","description":"The ID of the user that created the resource.","readOnly":true},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource.","readOnly":true},"createdByApp":{"type":"string","description":"The application that created the resource.","readOnly":true},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string. It is required to be set for schedules determining when upgrades to the Edge software can be applied."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used."},"ScheduleDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SchedulesDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchedulesDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The schedule identifier"},"name":{"type":"string","description":"The schedule name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A schedule."},"ScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPromptAsset":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string","description":"The asset resource language"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"text":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["created","uploaded","transcoded","transcodeFailed"]},"hasDefault":{"type":"boolean"},"languageDefault":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The system prompt identifier"},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WebChatConfig":{"type":"object","properties":{"webChatSkin":{"type":"string","description":"css class to be applied to the web chat widget.","enum":["basic","modern-caret-skin"]}}},"WebChatDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"authenticationRequired":{"type":"boolean"},"authenticationUrl":{"type":"string","description":"URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples"},"disabled":{"type":"boolean"},"webChatConfig":{"$ref":"#/definitions/WebChatConfig"},"allowedDomains":{"type":"array","items":{"type":"string"}},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"WebChatSettings":{"type":"object","properties":{"requireDeployment":{"type":"boolean"}}},"WebChatGuestMediaRequest":{"type":"object","required":["state","types"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"types":{"type":"array","description":"The types of media being requested.","items":{"type":"string","enum":["COBROWSE","SCREENSHARE"]}},"state":{"type":"string","description":"The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED.","enum":["PENDING","ACCEPTED","DECLINED","TIMEDOUT","CANCELLED","ERRORED"]},"communicationId":{"type":"string","description":"The ID of the new media communication, if applicable."},"securityKey":{"type":"string","description":"The security information related to a media request."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Object representing the guest model of a media request of a chat conversation."},"WebChatGuestMediaRequestEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}}},"WebChatMemberInfoEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMemberInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentVideoSettings":{"type":"object","properties":{"allowCamera":{"type":"boolean","description":"whether or not agent camera is allowed"},"allowScreenShare":{"type":"boolean","description":"whether or not agent screen share is allowed"},"background":{"type":"string","description":"background for agent","enum":["BLUR","NONE","IMAGE"]},"backgroundImage":{"description":"background image settings for agent","$ref":"#/definitions/BackgroundImageSettings"}},"description":"The settings for Agent Video"},"AuthenticationSettings":{"type":"object","required":["enabled","integrationId"],"properties":{"enabled":{"type":"boolean","description":"Indicate if these auth is required for this deployment. If, for example, this flag is set to true then webmessaging sessions can not send messages unless the end-user is authenticated."},"integrationId":{"type":"string","description":"The integration identifier which contains the auth settings required on the deployment."},"allowSessionUpgrade":{"type":"boolean","description":"Allow end-users to upgrade an anonymous session to authenticated conversation."}},"description":"Settings for authenticated webdeployments."},"AutoStart":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not auto start is enabled"}}},"BackgroundImageSettings":{"type":"object","properties":{"url":{"type":"string","description":"BackgroundImage URL for agent video settings"}},"description":"The settings to Agent Video background image"},"BotMessengerProfile":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Bot"},"avatarUrl":{"type":"string","description":"Avatar for Bot"}}},"CobrowseSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not cobrowse is enabled"},"allowAgentControl":{"type":"boolean","description":"Whether the viewer should have option to request control"},"allowAgentNavigation":{"type":"boolean","description":"Whether the viewer should have option to request navigation"},"maskSelectors":{"type":"array","description":"Mask patterns that will apply to pages being shared","items":{"type":"string"}},"channels":{"type":"array","description":"Cobrowse channels for web messenger","items":{"type":"string","enum":["Webmessaging","Voice"]}},"readonlySelectors":{"type":"array","description":"Readonly patterns that will apply to pages being shared","items":{"type":"string"}},"pauseCriteria":{"type":"array","description":"Pause criteria that will pause cobrowse if some of them are met in the user's URL","items":{"$ref":"#/definitions/PauseCriteria"}}},"description":"Settings concerning cobrowse"},"ConversationAppSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The toggle to enable or disable conversations"},"showAgentTypingIndicator":{"type":"boolean","description":"The toggle to enable or disable typing indicator for messenger"},"showUserTypingIndicator":{"type":"boolean","description":"The toggle to enable or disable typing indicator for messenger"},"autoStart":{"description":"The auto start for the messenger conversation","$ref":"#/definitions/AutoStart"},"markdown":{"description":"The markdown for the messenger app","$ref":"#/definitions/Markdown"},"conversationDisconnect":{"description":"The conversation disconnect settings for the messenger app","$ref":"#/definitions/ConversationDisconnectSettings"},"conversationClear":{"description":"The conversation clear settings for the messenger app","$ref":"#/definitions/ConversationClearSettings"},"humanize":{"description":"The humanize conversations settings for the messenger app","$ref":"#/definitions/Humanize"}},"description":"Conversation settings that handles chats within the messenger"},"ConversationClearSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not conversation clear setting is enabled"}}},"ConversationDisconnectSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not conversation disconnect setting is enabled"},"type":{"type":"string","description":"Conversation disconnect type","enum":["Send","ReadOnly"]}}},"CustomI18nLabels":{"type":"object","properties":{"language":{"type":"string","description":"Language of localized labels in homescreen app (eg. en-us, de-de)"},"localizedLabels":{"type":"array","description":"Contains localized labels used in homescreen app","items":{"$ref":"#/definitions/LocalizedLabels"}}},"description":"The localization settings for homescreen"},"FileUploadMode":{"type":"object","properties":{"fileTypes":{"type":"array","description":"A list of supported content types for uploading files","items":{"type":"string","enum":["image/jpeg","image/gif","image/png"]}},"maxFileSizeKB":{"type":"integer","format":"int64","description":"The maximum file size for file uploads in kilobytes. Default is 10240 (10 MB)"}}},"FileUploadSettings":{"type":"object","properties":{"enableAttachments":{"type":"boolean","description":"whether or not attachments is enabled"},"modes":{"type":"array","description":"The list of supported file upload modes","items":{"$ref":"#/definitions/FileUploadMode"}}},"description":"File upload settings for messenger"},"FormsTrackTrigger":{"type":"object","required":["captureDataOnFormAbandon","captureDataOnFormSubmit","formName","selector"],"properties":{"selector":{"type":"string","description":"Form element that triggers the form submitted or abandoned event."},"formName":{"type":"string","description":"Prefix for the form submitted or abandoned event name."},"captureDataOnFormAbandon":{"type":"boolean","description":"Whether to capture the form data in the form abandoned event."},"captureDataOnFormSubmit":{"type":"boolean","description":"Whether to capture the form data in the form submitted event."}},"description":"Details about a forms tracking event trigger"},"Humanize":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not humanize conversations setting is enabled"},"bot":{"description":"Bot messenger profile setting","$ref":"#/definitions/BotMessengerProfile"}}},"IdleEventTrigger":{"type":"object","required":["eventName"],"properties":{"eventName":{"type":"string","description":"Name of event triggered after period of inactivity."},"idleAfterSeconds":{"type":"integer","format":"int64","description":"Number of seconds of inactivity before an event is triggered."}},"description":"Details about an idle event trigger"},"JourneyEventsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not journey event collection is enabled."},"excludedQueryParameters":{"type":"array","description":"List of parameters to be excluded from the query string.","items":{"type":"string"}},"shouldKeepUrlFragment":{"type":"boolean","description":"Whether or not to keep the URL fragment."},"searchQueryParameters":{"type":"array","description":"List of query parameters used for search (e.g. 'q').","items":{"type":"string"}},"pageviewConfig":{"type":"string","description":"Controls how the pageview events are tracked.","enum":["Auto","Once","Off"]},"clickEvents":{"type":"array","description":"Tracks when and where a visitor clicks on a webpage.","items":{"$ref":"#/definitions/SelectorEventTrigger"}},"formsTrackEvents":{"type":"array","description":"Controls how the form submitted and form abandoned events are tracked after a visitor interacts with a form element.","items":{"$ref":"#/definitions/FormsTrackTrigger"}},"idleEvents":{"type":"array","description":"Tracks when and where a visitor becomes inactive on a webpage.","items":{"$ref":"#/definitions/IdleEventTrigger"}},"inViewportEvents":{"type":"array","description":"Tracks when elements become visible or hidden on screen.","items":{"$ref":"#/definitions/SelectorEventTrigger"}},"scrollDepthEvents":{"type":"array","description":"Tracks when a visitor scrolls to a specific percentage of a webpage.","items":{"$ref":"#/definitions/ScrollPercentageEventTrigger"}}},"description":"Settings concerning journey events"},"Knowledge":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not knowledge base is enabled"},"knowledgeBase":{"description":"The knowledge base for messenger","$ref":"#/definitions/AddressableEntityRef"}}},"LauncherButtonSettings":{"type":"object","properties":{"visibility":{"type":"string","description":"The visibility settings for the button","enum":["On","Off","OnDemand"]}},"description":"The settings for the launcher button"},"LocalizedLabels":{"type":"object","properties":{"key":{"type":"string","description":"Contains localized label key used in messenger homescreen","enum":["MessengerHomeHeaderTitle","MessengerHomeHeaderSubTitle"]},"value":{"type":"string","description":"Contains localized label value used in messenger homescreen"}},"description":"Contains localized labels used in messenger apps"},"Markdown":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not markdown is enabled"}}},"MessengerApps":{"type":"object","properties":{"conversations":{"description":"The conversation settings that handles chats within the messenger","$ref":"#/definitions/ConversationAppSettings"},"knowledge":{"description":"The knowledge base config for messenger","$ref":"#/definitions/Knowledge"}},"description":"The apps embedded in the messenger"},"MessengerHomeScreen":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not homescreen is enabled"},"logoUrl":{"type":"string","description":"to capture uploaded company logoUrl"}}},"MessengerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not messenger is enabled"},"styles":{"description":"The style settings for messenger","$ref":"#/definitions/MessengerStyles"},"launcherButton":{"description":"The launcher button settings for messenger","$ref":"#/definitions/LauncherButtonSettings"},"fileUpload":{"description":"The file upload settings for messenger","$ref":"#/definitions/FileUploadSettings"},"apps":{"description":"The apps embedded in the messenger","$ref":"#/definitions/MessengerApps"},"homeScreen":{"description":"The homescreen settings for messenger","$ref":"#/definitions/MessengerHomeScreen"}},"description":"Settings concerning messenger"},"MessengerStyles":{"type":"object","properties":{"primaryColor":{"type":"string","example":"#a7017c","description":"The primary color of messenger in hexadecimal"}}},"PauseCriteria":{"type":"object","properties":{"urlFragment":{"type":"string"},"condition":{"type":"string","enum":["Includes","DoesNotInclude","StartsWith","EndsWith","Equals"]}}},"PositionSettings":{"type":"object","properties":{"alignment":{"type":"string","description":"The alignment for position","enum":["Auto","Left","Right"]},"sideSpace":{"type":"integer","format":"int32","description":"The sidespace value for position"},"bottomSpace":{"type":"integer","format":"int32","description":"The bottomspace value for position"}},"description":"Settings concerning position"},"ScrollPercentageEventTrigger":{"type":"object","required":["eventName","percentage"],"properties":{"percentage":{"type":"integer","format":"int32","description":"Percentage of a webpage at which an event is triggered."},"eventName":{"type":"string","description":"Name of event triggered after scrolling to the specified percentage."}},"description":"Details about a scroll percentage event trigger"},"SelectorEventTrigger":{"type":"object","required":["eventName","selector"],"properties":{"selector":{"type":"string","description":"Element that triggers event."},"eventName":{"type":"string","description":"Name of event triggered when element matching selector is interacted with."}},"description":"Details about a selector event trigger"},"SupportCenterCategory":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"selfUri":{"type":"string","format":"uri"},"image":{"description":"Image attributes for a featured category","$ref":"#/definitions/SupportCenterImage"}}},"SupportCenterCompactCategoryModuleTemplate":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Whether this template is active or not"}}},"SupportCenterCustomMessage":{"type":"object","required":["defaultValue","type"],"properties":{"defaultValue":{"type":"string","description":"Default value for the message","minLength":0,"maxLength":300},"type":{"type":"string","description":"Type of the message","enum":["Welcome","Fallback"]}}},"SupportCenterDetailedCategoryModuleSidebar":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether sidebar is enabled or not"}}},"SupportCenterDetailedCategoryModuleTemplate":{"type":"object","required":["active","sidebar"],"properties":{"active":{"type":"boolean","description":"Whether this template is active or not"},"sidebar":{"description":"Sidebar settings for the template","$ref":"#/definitions/SupportCenterDetailedCategoryModuleSidebar"}}},"SupportCenterFeedbackSettings":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether or not requesting customer feedback on article content and article search results is enabled"}}},"SupportCenterGlobalStyle":{"type":"object","required":["backgroundColor","fontFamily","primaryColor","primaryColorDark","primaryColorLight","textColor"],"properties":{"backgroundColor":{"type":"string","description":"Global background color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColor":{"type":"string","description":"Global primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColorDark":{"type":"string","description":"Global dark primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"primaryColorLight":{"type":"string","description":"Global light primary color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"textColor":{"type":"string","description":"Global text color, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"fontFamily":{"type":"string","description":"Global font family"}}},"SupportCenterHeroStyle":{"type":"object","required":["backgroundColor","textColor"],"properties":{"backgroundColor":{"type":"string","description":"Background color for hero section, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"textColor":{"type":"string","description":"Text color for hero section, in hexadecimal format, eg #ffffff","pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"image":{"description":"Background image for hero section","$ref":"#/definitions/SupportCenterImage"}}},"SupportCenterImage":{"type":"object","required":["source"],"properties":{"source":{"description":"Source URLs for image","$ref":"#/definitions/SupportCenterImageSource"}}},"SupportCenterImageSource":{"type":"object","required":["defaultUrl"],"properties":{"defaultUrl":{"type":"string","description":"Default URL for image"}}},"SupportCenterModuleSetting":{"type":"object","required":["enabled","type"],"properties":{"type":{"type":"string","description":"Screen module type","enum":["Search","Categories","FAQ","Contact","Results","Article","TopViewedArticles"]},"enabled":{"type":"boolean","description":"Whether or not knowledge portal (previously support center) screen module is enabled"},"compactCategoryModuleTemplate":{"description":"Compact category module template","$ref":"#/definitions/SupportCenterCompactCategoryModuleTemplate"},"detailedCategoryModuleTemplate":{"description":"Detailed category module template","$ref":"#/definitions/SupportCenterDetailedCategoryModuleTemplate"}}},"SupportCenterScreen":{"type":"object","required":["moduleSettings","type"],"properties":{"type":{"type":"string","description":"The type of the screen","enum":["Home","Category","SearchResults","Article"]},"moduleSettings":{"type":"array","description":"Module settings for the screen, valid modules for each screenType: Home: Search, Categories, TopViewedArticles; Category: Search, Categories; SearchResults: Search, Results; Article: Search, Article;","items":{"$ref":"#/definitions/SupportCenterModuleSetting"}}}},"SupportCenterSettings":{"type":"object","required":["enabled","enabledCategories","knowledgeBase","screens","styleSetting"],"properties":{"enabled":{"type":"boolean","description":"Whether or not knowledge portal (previously support center) is enabled"},"knowledgeBase":{"description":"The knowledge base for knowledge portal (previously support center)","$ref":"#/definitions/AddressableEntityRef"},"customMessages":{"type":"array","description":"Customizable display texts for knowledge portal (previously support center)","items":{"$ref":"#/definitions/SupportCenterCustomMessage"}},"routerType":{"type":"string","description":"Router type for knowledge portal (previously support center)","enum":["Hash","Browser"]},"screens":{"type":"array","description":"Available screens for the knowledge portal (previously support center) with its modules","items":{"$ref":"#/definitions/SupportCenterScreen"}},"enabledCategories":{"type":"array","description":"Featured categories for knowledge portal (previously support center) home screen","items":{"$ref":"#/definitions/SupportCenterCategory"}},"styleSetting":{"description":"Style attributes for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterStyleSetting"},"feedback":{"description":"Customer feedback settings","$ref":"#/definitions/SupportCenterFeedbackSettings"}},"description":"Settings concerning knowledge portal (previously support center)"},"SupportCenterStyleSetting":{"type":"object","required":["globalStyle","heroStyle"],"properties":{"heroStyle":{"description":"Knowledge portal (previously support center) hero customizations","$ref":"#/definitions/SupportCenterHeroStyle"},"globalStyle":{"description":"Knowledge portal (previously support center) global customizations","$ref":"#/definitions/SupportCenterGlobalStyle"}}},"UserVideoSettings":{"type":"object","properties":{"allowCamera":{"type":"boolean","description":"whether or not user camera is allowed"},"allowScreenShare":{"type":"boolean","description":"whether or not user screen share is allowed"}},"description":"The settings for User Video"},"VideoSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not video is enabled"},"agent":{"description":"Video Settings for agent","$ref":"#/definitions/AgentVideoSettings"},"user":{"description":"Video Settings for user","$ref":"#/definitions/UserVideoSettings"}},"description":"The settings to enable video chat"},"WebDeploymentConfigurationVersion":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The configuration version ID","readOnly":true},"name":{"type":"string","description":"The configuration version name"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration","readOnly":true},"headlessMode":{"description":"Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.","$ref":"#/definitions/WebDeploymentHeadlessMode"},"description":{"type":"string","description":"The description of the configuration"},"languages":{"type":"array","example":"en-us, de-de","description":"A list of languages supported on the configuration required if the messenger is enabled","items":{"type":"string"}},"defaultLanguage":{"type":"string","example":"en-us, de-de","description":"The default language to use for the configuration required if the messenger is enabled"},"customI18nLabels":{"type":"array","description":"The localization settings for homescreen app","items":{"$ref":"#/definitions/CustomI18nLabels"}},"messenger":{"description":"The settings for messenger","$ref":"#/definitions/MessengerSettings"},"position":{"description":"The settings for position","$ref":"#/definitions/PositionSettings"},"supportCenter":{"description":"The settings for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterSettings"},"cobrowse":{"description":"The settings for cobrowse","$ref":"#/definitions/CobrowseSettings"},"journeyEvents":{"description":"The settings for journey events","$ref":"#/definitions/JourneyEventsSettings"},"authenticationSettings":{"description":"The settings for authenticated deployments","$ref":"#/definitions/AuthenticationSettings"},"dateCreated":{"type":"string","format":"date-time","description":"The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"createdUser":{"description":"A reference to the user who created the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"publishedUser":{"description":"A reference to the user who published the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The current status of the configuration version","enum":["Pending","Active","Inactive","Error","Deleting"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the configuration version of a Web Deployment"},"WebDeploymentHeadlessMode":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not Headless Mode is enabled"}}},"WebDeploymentConfigurationVersionEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"selfUri":{"type":"string","format":"uri"}}},"WebDeployment":{"type":"object","required":["configuration","name"],"properties":{"id":{"type":"string","description":"The deployment ID","readOnly":true},"name":{"type":"string","description":"The deployment name"},"description":{"type":"string","description":"The description of the config"},"allowAllDomains":{"type":"boolean","description":"Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true."},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"supportedContent":{"description":"The supported content profile for a deployment","$ref":"#/definitions/SupportedContentReference"},"snippet":{"type":"string","description":"Javascript snippet used to load the config","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the deployment","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flow":{"description":"A reference to the inboundshortmessage flow used by this deployment","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"The current status of the deployment","enum":["Pending","Active","Inactive","Error","Deleting"]},"configuration":{"description":"The config version this deployment uses","$ref":"#/definitions/WebDeploymentConfigurationVersionEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a Web Deployment"},"WebDeploymentConfigurationVersionEntityRef":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The configuration version ID"},"name":{"type":"string","description":"The configuration version name"},"selfUri":{"type":"string","format":"uri"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration"}}},"WebDeploymentActiveConfigurationOnDeployment":{"type":"object","properties":{"configurationVersion":{"description":"The active configuration on a deployment","$ref":"#/definitions/WebDeploymentConfigurationVersion"},"deployment":{"description":"The web deployment associated with the active configuration","$ref":"#/definitions/WebDeployment"}},"description":"Details about the active configuration on a deployment"},"ExpandableWebDeployment":{"type":"object","required":["configuration","name"],"properties":{"id":{"type":"string","description":"The deployment ID","readOnly":true},"name":{"type":"string","description":"The deployment name"},"description":{"type":"string","description":"The description of the config"},"allowAllDomains":{"type":"boolean","description":"Property indicates whether all domains are allowed or not. allowedDomains must be empty when this is set as true."},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"supportedContent":{"description":"The supported content profile for a deployment","$ref":"#/definitions/SupportedContentReference"},"snippet":{"type":"string","description":"Javascript snippet used to load the config","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date the deployment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the deployment was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the deployment","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"flow":{"description":"A reference to the inboundshortmessage flow used by this deployment","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"The current status of the deployment","enum":["Pending","Active","Inactive","Error","Deleting"]},"configuration":{"description":"The config version this deployment uses","$ref":"#/definitions/WebDeploymentConfigurationVersionResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about a Web Deployment"},"ExpandableWebDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ExpandableWebDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"WebDeploymentConfigurationVersionResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The configuration version ID"},"name":{"type":"string","description":"The configuration version name"},"version":{"type":"string","example":"DRAFT, 1, 2","description":"The version of the configuration"},"headlessMode":{"description":"Headless Mode Support which Controls UI components. When enabled, native UI components will be disabled and allows for custom-built UI.","$ref":"#/definitions/WebDeploymentHeadlessMode"},"description":{"type":"string","description":"The description of the configuration"},"languages":{"type":"array","example":"en-us, de-de","description":"A list of languages supported on the configuration required if the messenger is enabled","items":{"type":"string"}},"defaultLanguage":{"type":"string","example":"en-us, de-de","description":"The default language to use for the configuration required if the messenger is enabled"},"customI18nLabels":{"type":"array","description":"The localization settings for homescreen app","items":{"$ref":"#/definitions/CustomI18nLabels"}},"messenger":{"description":"The settings for messenger","$ref":"#/definitions/MessengerSettings"},"position":{"description":"The settings for position","$ref":"#/definitions/PositionSettings"},"supportCenter":{"description":"The settings for knowledge portal (previously support center)","$ref":"#/definitions/SupportCenterSettings"},"cobrowse":{"description":"The settings for cobrowse","$ref":"#/definitions/CobrowseSettings"},"journeyEvents":{"description":"The settings for journey events","$ref":"#/definitions/JourneyEventsSettings"},"authenticationSettings":{"description":"The settings for authenticated deployments","$ref":"#/definitions/AuthenticationSettings"},"dateCreated":{"type":"string","format":"date-time","description":"The date the configuration version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date the configuration version was most recently modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date the configuration version was most recently published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastModifiedUser":{"description":"A reference to the user who most recently modified the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"createdUser":{"description":"A reference to the user who created the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"publishedUser":{"description":"A reference to the user who published the configuration version","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The current status of the configuration version","enum":["Pending","Active","Inactive","Error","Deleting"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the configuration version of a Web Deployment"},"WebMessagingAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaType":{"type":"string","description":"The type of attachment this instance represents.","readOnly":true,"enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment.","readOnly":true},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml).","readOnly":true},"text":{"type":"string","description":"Text associated with attachment such as an image caption.","readOnly":true},"sha256":{"type":"string","description":"Secure hash of the attachment content.","readOnly":true},"filename":{"type":"string","description":"Suggested file name for attachment.","readOnly":true},"fileSize":{"type":"integer","format":"int32","description":"The file size associated with the file","readOnly":true}},"description":"Attachment object."},"WebMessagingButtonResponse":{"type":"object","required":["payload","text"],"properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"type":{"type":"string","description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"]},"text":{"type":"string","description":"The response text from the button click."},"payload":{"type":"string","description":"The response payload associated with the clicked button."}},"description":"Button response object representing the click of a structured message button, such as a quick reply."},"WebMessagingChannel":{"type":"object","properties":{"from":{"description":"Information about the recipient the message is received from.","readOnly":true,"$ref":"#/definitions/WebMessagingRecipient"},"to":{"description":"Information about the recipient the message is sent to.","readOnly":true,"$ref":"#/definitions/WebMessagingRecipient"},"time":{"type":"string","format":"date-time","description":"When the message was processed by Genesys Cloud. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"messageId":{"type":"string","description":"Unique provider ID of the message.","readOnly":true}},"description":"Channel-specific information that describes the message and the message channel/provider."},"WebMessagingContent":{"type":"object","properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","readOnly":true,"enum":["Attachment","QuickReply","ButtonResponse","GenericTemplate","Card","Carousel"]},"attachment":{"description":"Attachment content.","readOnly":true,"$ref":"#/definitions/WebMessagingAttachment"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/WebMessagingQuickReply"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/WebMessagingButtonResponse"},"generic":{"description":"Generic content (Deprecated).","$ref":"#/definitions/WebMessagingGeneric"},"card":{"description":"Card content","$ref":"#/definitions/ContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ContentCarousel"}},"description":"Message content element."},"WebMessagingEvent":{"type":"object","required":["eventType"],"properties":{"eventType":{"type":"string","description":"Type of this event element","enum":["CoBrowse","Presence"]},"coBrowse":{"description":"Cobrowse event.","$ref":"#/definitions/WebMessagingEventCoBrowse"},"presence":{"description":"Presence event.","$ref":"#/definitions/WebMessagingEventPresence"}},"description":"Message event element. Examples include: system messages, typing indicators, cobrowse offerings."},"WebMessagingEventCoBrowse":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Cobrowse event.","enum":["Offering","OfferingExpired","OfferingAccepted","OfferingRejected"]},"sessionId":{"type":"string","description":"The Cobrowse session ID."},"sessionJoinToken":{"type":"string","description":"The Cobrowse session join token."}},"description":"A Cobrowse event."},"WebMessagingEventPresence":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Describes the type of Presence event.","enum":["Join","Disconnect","Clear","SignIn"]}},"description":"A Presence event."},"WebMessagingGeneric":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"actions":{"description":"Actions to be taken.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects.","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Generic content object. (Deprecated"},"WebMessagingMessage":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the message. This ID is generated by Messaging Platform. Message receipts will have the same ID as the message they reference."},"channel":{"description":"Channel-specific information that describes the message and the message channel/provider.","$ref":"#/definitions/WebMessagingChannel"},"type":{"type":"string","description":"Message type.","enum":["Text","Structured","Receipt","Event"]},"text":{"type":"string","description":"Message text."},"content":{"type":"array","description":"List of content elements.","items":{"$ref":"#/definitions/WebMessagingContent"}},"events":{"type":"array","description":"List of event elements.","items":{"$ref":"#/definitions/WebMessagingEvent"}},"direction":{"type":"string","description":"The direction of the message. Direction is always from the perspective of the Genesys Cloud platform. An Inbound message is one sent from a guest to the Genesys Cloud Platform. An Outbound message is one sent from the Genesys Cloud Platform to a guest.","enum":["Inbound","Outbound"]},"originatingEntity":{"type":"string","description":"Specifies if this message was sent by a human agent or bot. The platform may use this to apply appropriate provider policies.","enum":["Human","Bot"]},"metadata":{"type":"object","description":"Additional metadata about this message.","additionalProperties":{"type":"string"}}},"description":"A web messaging message"},"WebMessagingMessageEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebMessagingMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"WebMessagingQuickReply":{"type":"object","required":["payload","text"],"properties":{"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying the quick reply response."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"]}},"description":"Quick reply object"},"WebMessagingRecipient":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the recipient.","readOnly":true},"lastName":{"type":"string","description":"Last name of the recipient.","readOnly":true},"nickname":{"type":"string","description":"Nickname or display name of the recipient.","readOnly":true},"image":{"type":"string","description":"URL of an image that represents the recipient.","readOnly":true},"additionalIds":{"type":"array","description":"List of recipient additional identifiers","readOnly":true,"items":{"$ref":"#/definitions/RecipientAdditionalIdentifier"}}},"description":"Information about the recipient the message is sent to or received from."},"CoachingAnnotation":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"The user who created the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"text":{"type":"string","description":"The text of the annotation."},"isDeleted":{"type":"boolean","description":"Flag indicating whether the annotation is deleted.","readOnly":true},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","readOnly":true,"enum":["Public","Private"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAnnotationCreateRequest":{"type":"object","required":["accessType","text"],"properties":{"text":{"type":"string","description":"The text of the annotation."},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","enum":["Public","Private"]}}},"CoachingAnnotationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAnnotation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddConversationResponse":{"type":"object","properties":{"conversation":{"description":"The conversation reference","readOnly":true,"$ref":"#/definitions/ConversationReference"},"appointment":{"description":"The appointment reference","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"}}},"CoachingAppointmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddConversationRequest":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The id of the conversation to add"}},"description":"Update coaching appointment request"},"CoachingAppointmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of coaching appointment","readOnly":true},"description":{"type":"string","description":"The description of coaching appointment","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes","readOnly":true},"status":{"type":"string","description":"The status of coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"facilitator":{"description":"The facilitator of coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"attendees":{"type":"array","description":"The list of attendees attending the coaching","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"createdBy":{"description":"The user who created the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversations":{"type":"array","description":"The list of conversations associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/ConversationReference"}},"documents":{"type":"array","description":"The list of documents associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/DocumentReference"}},"isOverdue":{"type":"boolean","description":"Whether the appointment is overdue.","readOnly":true},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"},"dateCompleted":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was set to completed status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Coaching appointment response"},"DocumentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmBusinessUnitReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the business unit"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmScheduleReference":{"type":"object","required":["businessUnit","id","weekDate"],"properties":{"id":{"type":"string","description":"The ID of the WFM schedule"},"businessUnit":{"description":"A reference to a Workforce Management Business Unit","$ref":"#/definitions/WfmBusinessUnitReference"},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateCoachingAppointmentRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"status":{"type":"string","description":"The status of the coaching appointment.","enum":["Scheduled","InProgress","Completed"]},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","$ref":"#/definitions/WfmScheduleReference"},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","items":{"type":"string"}}},"description":"Update coaching appointment request"},"CoachingAppointmentStatusResponse":{"type":"object","properties":{"appointment":{"description":"The coaching appointment this status belongs to","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"},"createdBy":{"description":"User who updated the status","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]}}},"CoachingAppointmentStatusResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the coaching appointment","enum":["Scheduled","InProgress","Completed"]}}},"CoachingAppointmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/QueryResponseGroupedData"}}}},"QueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},"metrics":{"type":"array","description":"A list of aggregated metrics","items":{"$ref":"#/definitions/QueryResponseMetric"}}}},"QueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/QueryResponseData"}}}},"QueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/QueryResponseStats"}}},"QueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"CoachingAppointmentAggregateRequest":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"A list of metrics to aggregate. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"]}},"groupBy":{"type":"array","description":"An optional list of items by which to group the result data.","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data","$ref":"#/definitions/QueryRequestFilter"}}},"QueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/QueryRequestPredicate"}}}},"QueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data","items":{"$ref":"#/definitions/QueryRequestClause"}}}},"QueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"The dimension to be filtered","enum":["attendeeId","facilitatorId","status"]},"value":{"type":"string","description":"The value to filter by"}}},"CreateCoachingAppointmentRequest":{"type":"object","required":["attendeeIds","dateStart","description","lengthInMinutes","name"],"properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"facilitatorId":{"type":"string","description":"The facilitator ID of coaching appointment."},"attendeeIds":{"type":"array","description":"IDs of attendees in the coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"wfmSchedule":{"description":"The Workforce Management schedule the appointment is associated with.","$ref":"#/definitions/WfmScheduleReference"},"externalLinks":{"type":"array","description":"The list of external links related to the appointment","items":{"type":"string"}}},"description":"Create coaching appointment request"},"CoachingAppointmentResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the appointment for this notification.","readOnly":true},"markedAsRead":{"type":"boolean","description":"Indicates if notification is read or unread"},"actionType":{"type":"string","description":"Action causing the notification.","readOnly":true,"enum":["Create","Update","Delete","StatusChange"]},"relationship":{"type":"string","description":"The relationship of this user to this notification's appointment","readOnly":true,"enum":["Attendee","Creator","Facilitator"]},"dateStart":{"type":"string","format":"date-time","description":"The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of the appointment on this notification","readOnly":true},"status":{"type":"string","description":"The status of the appointment for this notification","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"user":{"description":"The user of this notification","readOnly":true,"$ref":"#/definitions/UserReference"},"appointment":{"description":"The appointment","readOnly":true,"$ref":"#/definitions/CoachingAppointmentResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingNotificationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingNotification"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AvailableTime":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start of the availability period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of availability period in minutes","readOnly":true},"isPaid":{"type":"boolean","description":"Indicates if this availability period is paid in Workforce Management schedule","readOnly":true},"activityCategory":{"type":"string","description":"Workforce Management activity category for this availability period","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]},"wfmSchedule":{"description":"Workforce Management schedule information associated with the available time","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"}}},"CoachingSlot":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start date and time of scheduled coaching appointment slot. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of coaching appointment slot in minutes","readOnly":true},"staffingDifference":{"type":"number","format":"double","description":"Difference between scheduled and forecast headcount for this slot after scheduling the coaching appointment","readOnly":true},"differenceRating":{"type":"string","description":"Rating based on the staffing difference for scheduled slot","readOnly":true,"enum":["Poor","Neutral","Good"]},"wfmSchedule":{"description":"Workforce Management schedule information associated with the slot","readOnly":true,"$ref":"#/definitions/WfmScheduleReference"}}},"CoachingSlotsResponse":{"type":"object","properties":{"suggestedSlots":{"type":"array","description":"List of slots where coaching appointment can be scheduled","readOnly":true,"items":{"$ref":"#/definitions/CoachingSlot"}},"attendeeSchedules":{"type":"array","description":"Periods of availability for attendees to schedule coaching appointment","readOnly":true,"items":{"$ref":"#/definitions/UserAvailableTimes"}},"facilitatorSchedules":{"type":"array","description":"Periods of availability for facilitators to schedule coaching appointment","readOnly":true,"items":{"$ref":"#/definitions/UserAvailableTimes"}},"wfmScheduleActivities":{"type":"array","description":"Detailed data for WFM scheduled activities","readOnly":true,"items":{"$ref":"#/definitions/WfmScheduleActivity"}}}},"FullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"ScheduleActivity":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"UserAvailableTimes":{"type":"object","properties":{"user":{"description":"User reference","readOnly":true,"$ref":"#/definitions/UserReference"},"availableTimes":{"type":"array","description":"Periods of availability to schedule coaching appointment for an user","readOnly":true,"items":{"$ref":"#/definitions/AvailableTime"}}}},"WfmScheduleActivity":{"type":"object","properties":{"userReference":{"description":"ID of user that the schedule is for","readOnly":true,"$ref":"#/definitions/UserReference"},"activities":{"type":"array","description":"List of user's scheduled activities","readOnly":true,"items":{"$ref":"#/definitions/ScheduleActivity"}},"fullDayTimeOffMarkers":{"type":"array","description":"List of user's days off","readOnly":true,"items":{"$ref":"#/definitions/FullDayTimeOffMarker"}}}},"CoachingSlotsRequest":{"type":"object","required":["attendeeIds","interval","lengthInMinutes"],"properties":{"interval":{"type":"string","description":"Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes"},"attendeeIds":{"type":"array","description":"List of attendees to determine coaching appointment slots","uniqueItems":true,"items":{"type":"string"}},"facilitatorIds":{"type":"array","description":"List of facilitators to determine coaching appointment slots","uniqueItems":true,"items":{"type":"string"}},"interruptibleAppointmentIds":{"type":"array","description":"List of appointment ids to exclude from consideration when determining blocked slots","uniqueItems":true,"items":{"type":"string"}}}},"DevelopmentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created activity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date activity was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this activity","readOnly":true},"isPassed":{"type":"boolean","description":"True if the activity was passed","readOnly":true},"isLatest":{"type":"boolean","description":"True if this is the latest version of assignment assigned to the user"},"isModuleArchived":{"type":"boolean","description":"True if the associated module is archived"},"archivalMode":{"type":"string","description":"Module archive type","enum":["Graceful","Immediate"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","position":2,"description":"The name of the activity"},"type":{"type":"string","position":3,"description":"The type of activity","enum":["Informational","Coaching","AssessedContent","Assessment","External"]},"status":{"type":"string","position":4,"description":"The status of the activity","enum":["Planned","InProgress","Completed","InvalidSchedule","NotCompleted"]},"dateDue":{"type":"string","format":"date-time","position":5,"description":"Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"facilitator":{"position":6,"description":"Facilitator of the activity","$ref":"#/definitions/UserReference"},"attendees":{"type":"array","position":7,"description":"List of users attending the activity","items":{"$ref":"#/definitions/UserReference"}},"isOverdue":{"type":"boolean","position":8,"description":"Indicates if the activity is overdue"}},"description":"Development Activity object"},"DevelopmentActivityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DevelopmentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DevelopmentActivityAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseMetric"}}}},"DevelopmentActivityAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseData"}}}},"DevelopmentActivityAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseStatistics"}}},"DevelopmentActivityAggregateQueryResponseStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"},"min":{"type":"number","description":"The minimum value in this metric"},"max":{"type":"number","description":"The maximum value in this metric"},"sum":{"type":"number","description":"The total of the values for this metric"}}},"DevelopmentActivityAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseGroupedData"}}}},"DevelopmentActivityAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter.","$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestFilter"}}},"DevelopmentActivityAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestPredicate"}}}},"DevelopmentActivityAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestClause"}}}},"DevelopmentActivityAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId","isPassed"]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational, AssessedContent, Assessment, Coaching, External"}}},"AssessmentQuestionGroupScore":{"type":"object","required":["questionGroupId"],"properties":{"questionGroupId":{"type":"string","description":"The ID of the question group"},"totalScore":{"type":"number","format":"float","description":"The total score for the questions","readOnly":true},"maxTotalScore":{"type":"number","format":"float","description":"The maximum total score for the questions","readOnly":true},"markedNA":{"type":"boolean","description":"True if this question group is marked NA"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"totalCriticalScore":{"type":"number","format":"float","description":"The total score for the critical questions","readOnly":true},"maxTotalCriticalScore":{"type":"number","format":"float","description":"The maximum total score for the critical questions","readOnly":true},"totalNonCriticalScore":{"type":"number","format":"float","description":"The total score for the non-critical questions","readOnly":true},"maxTotalNonCriticalScore":{"type":"number","format":"float","description":"The maximum total score for the non-critical questions","readOnly":true},"totalScoreUnweighted":{"type":"number","format":"float","description":"The unweighted total score for this question group","readOnly":true},"maxTotalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for this question group","readOnly":true},"totalCriticalScoreUnweighted":{"type":"number","format":"float","description":"The unweighted total score for the critical questions","readOnly":true},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for the critical questions","readOnly":true},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"The total unweighted score for the non-critical questions","readOnly":true},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float","description":"The maximum unweighted total score for the non-critical questions","readOnly":true},"questionScores":{"type":"array","description":"The individual question scores","items":{"$ref":"#/definitions/AssessmentQuestionScore"}}}},"AssessmentQuestionScore":{"type":"object","required":["questionId"],"properties":{"failedKillQuestion":{"type":"boolean","description":"True if this was a failed Kill question","readOnly":true},"comments":{"type":"string","description":"Comments provided for the answer"},"questionId":{"type":"string","description":"The ID of the question"},"answerId":{"type":"string","description":"The ID of the selected answer"},"score":{"type":"integer","format":"int32","description":"The score received for this question","readOnly":true},"markedNA":{"type":"boolean","description":"True if this question was marked as NA"},"systemMarkedNA":{"type":"boolean","description":"If markedNA is true, systemMarkedNA indicates whether it was marked by a user or by the system due to visibility conditions. Always false if markedNA is false."},"freeTextAnswer":{"type":"string","description":"Answer for free text answer type"}}},"AssessmentScoringSet":{"type":"object","required":["questionGroupScores"],"properties":{"totalScore":{"type":"number","format":"float","description":"The total score of the answers","readOnly":true},"totalCriticalScore":{"type":"number","format":"float","description":"The total score for the critical questions","readOnly":true},"totalNonCriticalScore":{"type":"number","format":"float","description":"The total score for the non-critical questions","readOnly":true},"questionGroupScores":{"type":"array","description":"The individual scores for each question group","items":{"$ref":"#/definitions/AssessmentQuestionGroupScore"}},"failureReasons":{"type":"array","description":"If the assessment was not passed, the reasons for failure.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["Score","CriticalScore","KillQuestion"]}},"comments":{"type":"string","description":"Comments provided for these answers."},"agentComments":{"type":"string","description":"Comments provided by agent."},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true}}},"AssessmentForm":{"type":"object","required":["passPercent","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"contextId":{"type":"string","description":"The unique Id for all versions of this assessment form","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"published":{"type":"boolean","position":2,"description":"If true, assessment form is published","readOnly":true},"passPercent":{"type":"integer","format":"int32","position":3,"description":"The pass percent for the assessment form"},"questionGroups":{"type":"array","position":4,"description":"A list of question groups","items":{"$ref":"#/definitions/AssessmentFormQuestionGroup"}}}},"AssessmentFormQuestion":{"type":"object","required":["text"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"]},"text":{"type":"string","description":"The question text"},"helpText":{"type":"string"},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by Free Text question types."},"isKill":{"type":"boolean","description":"Does an incorrect answer to this question mark the form as having a failed kill question. Only used by Multiple Choice type questions."},"isCritical":{"type":"boolean","description":"Does this question contribute to the critical score. Only used by Multiple Choice type questions."}}},"AssessmentFormQuestionGroup":{"type":"object","required":["name","questions","type"],"properties":{"id":{"type":"string","description":"The ID of the question group,"},"name":{"type":"string","description":"The question group name"},"type":{"type":"string","description":"The question group type"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","description":"The list of questions for this question group","items":{"$ref":"#/definitions/AssessmentFormQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssessmentScoringRequest":{"type":"object","required":["answers","assessmentForm"],"properties":{"assessmentForm":{"position":1,"description":"The assessment form to score against","$ref":"#/definitions/AssessmentForm"},"answers":{"position":2,"description":"The answers to score","$ref":"#/definitions/AssessmentScoringSet"}}},"LearningAssignmentAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseMetric"}}}},"LearningAssignmentAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseData"}}}},"LearningAssignmentAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/LearningAssignmentAggregateQueryResponseStats"}}},"LearningAssignmentAggregateQueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"},"min":{"type":"number","description":"The minimum value in this metric"},"max":{"type":"number","description":"The maximum value in this metric"},"sum":{"type":"number","description":"The total of the values for this metric"}}},"LearningAssignmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryResponseGroupedData"}}}},"LearningAssignmentAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities","nPassedActivities","nFailedActivities","oActivityScore","nNotCompletedActivities"]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter. ","$ref":"#/definitions/LearningAssignmentAggregateQueryRequestFilter"}}},"LearningAssignmentAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryRequestPredicate"}}}},"LearningAssignmentAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/LearningAssignmentAggregateQueryRequestClause"}}}},"LearningAssignmentAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId","isPassed"]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational, AssessedContent, Assessment, External"}}},"LearningAssessment":{"type":"object","properties":{"assessmentId":{"type":"string","description":"The Id of the assessment","readOnly":true},"contextId":{"type":"string","description":"The context Id of the related assessment form","readOnly":true},"assessmentFormId":{"type":"string","description":"The Id of the related assessment form","readOnly":true},"status":{"type":"string","description":"Status of the assessment","readOnly":true,"enum":["Pending","InProgress","Finished"]},"answers":{"description":"Answers for the assessment","$ref":"#/definitions/AssessmentScoringSet"},"dateCreated":{"type":"string","format":"date-time","description":"Date the assessment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date the assessment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"Date the assessment was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"LearningAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"assessment":{"description":"The assessment associated with this assignment","$ref":"#/definitions/LearningAssessment"},"createdBy":{"description":"The user who created the assignment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the assignment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified the assignment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date when the assignment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"isOverdue":{"type":"boolean","description":"True if the assignment is overdue","readOnly":true},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment","readOnly":true},"assessmentPercentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment's assessment","readOnly":true},"isRule":{"type":"boolean","description":"True if this assignment was created by a Rule","readOnly":true},"isManual":{"type":"boolean","description":"True if this assignment was created manually","readOnly":true},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true},"isLatest":{"type":"boolean","description":"True if the assignment is based on latest module","readOnly":true},"assessmentCompletionPercentage":{"type":"number","format":"float","description":"The assessment completion percentage of assignment","readOnly":true},"completionPercentage":{"type":"number","format":"float","description":"The overall completion percentage of assignment","readOnly":true},"steps":{"type":"array","description":"List of assignment steps","readOnly":true,"items":{"$ref":"#/definitions/LearningAssignmentStep"}},"nextStep":{"description":"The next assignment step","readOnly":true,"$ref":"#/definitions/LearningAssignmentStep"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"state":{"type":"string","position":2,"description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"dateRecommendedForCompletion":{"type":"string","format":"date-time","position":3,"description":"The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"version":{"type":"integer","format":"int32","position":4,"description":"The version of Learning module assigned"},"module":{"position":5,"description":"The Learning module object associated with this assignment","$ref":"#/definitions/LearningModule"},"user":{"position":6,"description":"The user to whom the assignment is assigned","$ref":"#/definitions/UserReference"},"assessmentForm":{"position":7,"description":"The assessment form associated with this assignment","$ref":"#/definitions/AssessmentForm"},"lengthInMinutes":{"type":"integer","format":"int32","position":8,"description":"The length in minutes of the assignment"}},"description":"Learning module assignment with user information"},"LearningAssignmentStep":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the learning assignment step","readOnly":true},"moduleStep":{"description":"The module step data for this step","readOnly":true,"$ref":"#/definitions/LearningModuleInformStep"},"structure":{"type":"array","description":"The structure for any SCO associated with this step","readOnly":true,"items":{"$ref":"#/definitions/LearningAssignmentStepScoStructure"}},"successStatus":{"type":"string","description":"The success status of this step","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the assignment step","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage for this step"},"percentageScore":{"type":"number","format":"float","description":"The percentage score for this step","readOnly":true},"shareableContentObject":{"description":"The SCO (Shareable Content Object) data","$ref":"#/definitions/LearningShareableContentObject"},"signedCookie":{"description":"The signed cookie information needed to access the content of this step (if required)","readOnly":true,"$ref":"#/definitions/LearningAssignmentStepSignedCookie"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning assignment step"},"LearningAssignmentStepScoStructure":{"type":"object","properties":{"id":{"type":"string","description":"The id of this SCO in the course manifest","readOnly":true},"name":{"type":"string","description":"The name of this SCO in the course manifest","readOnly":true},"successStatus":{"type":"string","description":"The success status of this SCO","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","readOnly":true,"items":{"$ref":"#/definitions/LearningAssignmentStepScoStructure"}}}},"LearningAssignmentStepSignedCookie":{"type":"object","properties":{"url":{"type":"string","description":"The base URL for the signed cookie","readOnly":true},"cookieValues":{"type":"object","description":"The cookie values required to access content from the base URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"LearningCoverArtThumbnail":{"type":"object","properties":{"resolution":{"type":"string","position":1,"description":"Resolution of thumbnail"},"url":{"type":"string","position":2,"description":"The URL for the thumbnail"}}},"LearningModule":{"type":"object","required":["completionTimeInDays","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of learning module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"createdBy":{"description":"The user who created learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time learning module was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time learning module was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module","readOnly":true},"externalId":{"type":"string","description":"The external ID of the learning module","readOnly":true},"source":{"type":"string","description":"The source of the learning module","readOnly":true,"enum":["UserCreated","GenesysBeyond"]},"rule":{"description":"The rule for learning module; read-only, and only populated when requested via expand param.","readOnly":true,"$ref":"#/definitions/LearningModuleRule"},"enforceContentOrder":{"type":"boolean","description":"If true, learning module content should be viewed one by one in order"},"reviewAssessmentResults":{"description":"Allows to view Assessment results in detail","$ref":"#/definitions/ReviewAssessmentResults"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"isArchived":{"type":"boolean","description":"If true, learning module is archived","readOnly":true},"isPublished":{"type":"boolean","description":"If true, learning module is published","readOnly":true},"description":{"type":"string","position":1,"description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","position":2,"description":"The completion time of learning module in days"},"type":{"type":"string","position":3,"description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"informSteps":{"type":"array","position":5,"description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStep"}},"assessmentForm":{"position":6,"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"summaryData":{"position":7,"description":"The learning module summary data","$ref":"#/definitions/LearningModuleSummary"},"reassignSummaryData":{"position":8,"description":"The learning module reassign summary data","$ref":"#/definitions/LearningModuleReassignSummary"},"coverArt":{"position":9,"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtResponse"},"lengthInMinutes":{"type":"integer","format":"int32","position":10,"description":"The recommended time in minutes to complete the module"},"archivalMode":{"type":"string","position":11,"description":"The mode of archival for learning module","enum":["Graceful","Immediate"]}},"description":"Learning module response"},"LearningModuleCoverArtResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"url":{"type":"string","position":1,"description":"The URL for the cover art"},"thumbnails":{"type":"array","position":2,"description":"Thumbnails for the cover art","items":{"$ref":"#/definitions/LearningCoverArtThumbnail"}}},"description":"Learning module cover art response"},"LearningModuleInformStep":{"type":"object","required":["order","type","value"],"properties":{"type":{"type":"string","position":1,"description":"The learning module inform step type","enum":["Url","Content","GenesysBuiltInCourse","RichText","Scorm"]},"name":{"type":"string","position":2,"description":"The name of the inform step or content"},"value":{"type":"string","position":3,"description":"The value for inform step"},"sharingUri":{"type":"string","position":4,"description":"The sharing uri for Content type inform step"},"contentType":{"type":"string","position":5,"description":"The document type for Content type Inform step"},"order":{"type":"integer","format":"int32","position":6,"description":"The order of inform step in a learning module"},"displayName":{"type":"string","position":7,"description":"The display name for the inform step"},"description":{"type":"string","position":8,"description":"The description for the inform step"}}},"LearningModuleReassignSummary":{"type":"object","properties":{"totalReassigned":{"type":"integer","format":"int32","description":"The total number of users for whom assignment is reassigned"},"completedCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in Completed state"},"inProgressCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in InProgress state"},"assignedCount":{"type":"integer","format":"int32","description":"The total number of users who have the assignment in Assigned state"},"notCompletedCount":{"type":"integer","format":"int32","description":"The total number of users who have their assignment overdue"}},"description":"Learning module reassign summary data"},"LearningModuleRule":{"type":"object","required":["isActive","parts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"If true, rule is active"},"parts":{"type":"array","description":"The parts of a learning module rule","items":{"$ref":"#/definitions/LearningModuleRuleParts"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningModuleRuleParts":{"type":"object","required":["operation","order","selector","value"],"properties":{"operation":{"type":"string","description":"The learning module rule operation","enum":["Include","Exclude"]},"selector":{"type":"string","description":"The learning module rule selector","enum":["AcdSkills","AgentName","Division","Group","Location","Queue","Role","Team"]},"value":{"type":"array","description":"The value of rules","items":{"type":"string"}},"order":{"type":"integer","format":"int32","description":"The order of rules in learning module rule"}}},"LearningModuleSummary":{"type":"object","properties":{"assignedCount":{"type":"integer","format":"int32","description":"The total number of assignments assigned for a learning module"},"completedCount":{"type":"integer","format":"int32","description":"The number of assignments completed for a learning module"},"passedCount":{"type":"integer","format":"int32","description":"The number of assignments passed for a learning module"},"completedSum":{"type":"number","format":"float","description":"The sum of assignment scores for a learning module"}},"description":"Learning module summary data"},"LearningShareableContentObject":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the SCO from the course manifest."},"lessonStatus":{"type":"string","description":"The status of the SCO. Maps to the SCORM 1.2 cmi.core.lesson_status property.","enum":["Passed","Completed","Failed","Incomplete","Browsed","NotAttempted"]},"exit":{"type":"string","description":"Indicates how or why the learner left the SCO. Maps to the SCORM 1.2 cmi.core.exit property.","enum":["Timeout","Suspend","Logout","Empty"]},"location":{"type":"string","description":"The learner’s current location in the SCO. Maps to the SCORM 1.2 cmi.core.lesson_location property."},"scoreRaw":{"type":"number","format":"float","description":"The score of the most recent attempt on the SCO. Maps to the SCORM 1.2 cmi.core.score.raw property."},"scoreMax":{"type":"number","format":"float","description":"The maximum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.max property."},"scoreMin":{"type":"number","format":"float","description":"The minimum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.min property."},"suspendData":{"type":"string","description":"The unique information generated by the SCO from previous uses. Maps to the SCORM 1.2 cmi.suspend_data property."},"credit":{"type":"string","description":"Whether completing this course counts towards the overall assignment. Maps to the SCORM 1.2 cmi.core.credit property.","readOnly":true,"enum":["Credit","NoCredit"]},"entry":{"type":"string","description":"Whether the learner has previously accessed this SCO. Maps to the SCORM 1.2 cmi.core.entry property.","readOnly":true,"enum":["AbInitio","Resume","Empty"]},"mode":{"type":"string","description":"Identifies the mode in which the SCO should be presented to the learner. Maps to the SCORM 1.2 cmi.core.lesson_mode property.","readOnly":true,"enum":["Browse","Normal","Review"]},"totalTime":{"type":"string","description":"The total amount of time the learner has spent in the SCO expressed as an ISO 8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.total_time property.","readOnly":true},"sessionTime":{"type":"string","description":"The amount of time spent in the SCO in this session expressed as an ISO-8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.session_time property."},"href":{"type":"string","description":"The href from the course manifest for this SCO.","readOnly":true},"parameters":{"type":"string","description":"The parameters from the course manifest for this SCO.","readOnly":true},"launchData":{"type":"string","description":"The launch data from the course manifest for this SCO.","readOnly":true}},"description":"Learning assignment SCO (Shareable Content Object)"},"ReviewAssessmentResults":{"type":"object","properties":{"byAssignees":{"type":"boolean","description":"If true, learning assignment results can be seen in detail by assignees"},"byViewers":{"type":"boolean","description":"If true, learning assignment results can be seen in detail by people who are eligible to view"}}},"LearningAssignmentCreate":{"type":"object","required":["moduleId","userId"],"properties":{"moduleId":{"type":"string","position":1,"description":"The Learning module Id associated with this assignment"},"userId":{"type":"string","position":2,"description":"The User for whom the assignment is assigned"},"recommendedCompletionDate":{"type":"string","format":"date-time","position":3,"description":"The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","position":4,"description":"The length in minutes of assignment"}}},"LearningAssignmentUpdate":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"assessment":{"description":"An updated Assessment","$ref":"#/definitions/LearningAssessment"}}},"LearningAssignmentReschedule":{"type":"object","required":["dateRecommendedForCompletion"],"properties":{"dateRecommendedForCompletion":{"type":"string","format":"date-time","description":"The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of the assignment"}}},"LearningAssignmentsDomainEntity":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningAssignment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningAssignmentReassign":{"type":"object","properties":{"recommendedCompletionDate":{"type":"string","format":"date-time","description":"The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of assignment"}}},"DisallowedEntityLearningAssignmentItem":{"type":"object","properties":{"errorCode":{"type":"string","description":"The error code associated with this disallowed entity"},"entity":{"description":"The entity that was disallowed","$ref":"#/definitions/LearningAssignmentItem"}}},"LearningAssignmentBulkAddResponse":{"type":"object","properties":{"entities":{"type":"array","description":"The learning assignments that were assigned correctly","items":{"$ref":"#/definitions/LearningAssignment"}},"disallowedEntities":{"type":"array","description":"The items that were not allowed to be assigned","items":{"$ref":"#/definitions/DisallowedEntityLearningAssignmentItem"}}}},"LearningAssignmentItem":{"type":"object","required":["moduleId","userId"],"properties":{"moduleId":{"type":"string","position":1,"description":"The Learning Module ID associated with this assignment"},"userId":{"type":"string","position":2,"description":"The User ID associated with this assignment"}}},"DisallowedEntityLearningAssignmentReference":{"type":"object","properties":{"errorCode":{"type":"string","description":"The error code associated with this disallowed entity"},"entity":{"description":"The entity that was disallowed","$ref":"#/definitions/LearningAssignmentReference"}}},"LearningAssignmentBulkRemoveResponse":{"type":"object","properties":{"entities":{"type":"array","description":"The learning assignments that were removed successfully","items":{"$ref":"#/definitions/LearningAssignmentEntity"}},"disallowedEntities":{"type":"array","description":"The learning assignments that were not removed due to missing permissions","items":{"$ref":"#/definitions/DisallowedEntityLearningAssignmentReference"}}}},"LearningAssignmentEntity":{"type":"object","properties":{"assignmentId":{"type":"string"}}},"LearningAssignmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssignmentUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LearningAssignmentUserListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningAssignmentUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64","description":"The number of users matching search term"},"unfilteredTotal":{"type":"integer","format":"int32","description":"The total number of users"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"List of users matching the learning module rule"},"LearningAssignmentUserQuery":{"type":"object","required":["rule"],"properties":{"rule":{"description":"Learning module rule object","$ref":"#/definitions/LearningModuleRule"},"searchTerm":{"type":"string","description":"The user name to be searched for"}},"description":"Learning module users query request model"},"LearningModulePreviewGetResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of learning module"},"description":{"type":"string","description":"The description of learning module"},"coverArt":{"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtResponse"},"enforceContentOrder":{"type":"boolean","description":"If true, learning module content should be viewed one by one in order"},"reviewAssessmentResults":{"description":"Allows to view Assessment results in detail","$ref":"#/definitions/ReviewAssessmentResults"},"assessmentForm":{"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"assignment":{"description":"the assignment preview","$ref":"#/definitions/LearningModulePreviewGetResponseAssignment"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning module preview get response"},"LearningModulePreviewGetResponseAssignment":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment","readOnly":true},"assessmentPercentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment's assessment","readOnly":true},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true},"assessmentCompletionPercentage":{"type":"number","format":"float","description":"The assessment completion percentage of assignment","readOnly":true},"completionPercentage":{"type":"number","format":"float","description":"The overall completion percentage of assignment","readOnly":true},"steps":{"type":"array","description":"List of assignment steps","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewGetResponseStep"}}},"description":"Learning module preview get response assignment"},"LearningModulePreviewGetResponseStep":{"type":"object","properties":{"id":{"type":"string","description":"The id of the step","readOnly":true},"moduleStep":{"description":"The module step data for this step","readOnly":true,"$ref":"#/definitions/LearningModuleInformStep"},"structure":{"type":"array","description":"The structure for any SCO associated with this step","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewGetScoStructure"}},"successStatus":{"type":"string","description":"The success status of this step","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the assignment step","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage for this step"},"percentageScore":{"type":"number","format":"float","description":"The percentage score for this step","readOnly":true},"signedCookie":{"description":"The signed cookie information needed to access the content of this step (if required)","readOnly":true,"$ref":"#/definitions/LearningAssignmentStepSignedCookie"}},"description":"Learning module preview get response assignment step"},"LearningModulePreviewGetScoStructure":{"type":"object","properties":{"id":{"type":"string","description":"The id of this SCO in the course manifest","readOnly":true},"name":{"type":"string","description":"The name of this SCO in the course manifest","readOnly":true},"successStatus":{"type":"string","description":"The success status of this SCO","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"percentageScore":{"type":"number","format":"float","description":"Percentage Score","readOnly":true},"shareableContentObject":{"description":"The SCO (Shareable Content Object) data","$ref":"#/definitions/LearningShareableContentObject"},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewGetScoStructure"}}},"description":"Learning module preview get SCO structure"},"LearningModuleJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of learning module job","enum":["Accepted","Running","Completed","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning module job response"},"LearningModuleCoverArtRequest":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The key identifier for the cover art"}}},"LearningModuleInformStepRequest":{"type":"object","required":["order","type","value"],"properties":{"type":{"type":"string","position":1,"description":"The learning module inform step type","enum":["Url","Content","GenesysBuiltInCourse","RichText","Scorm"]},"name":{"type":"string","position":2,"description":"The name of the inform step or content"},"value":{"type":"string","position":3,"description":"The value for inform step"},"sharingUri":{"type":"string","position":4,"description":"The sharing uri for Content type inform step"},"contentType":{"type":"string","position":5,"description":"The document type for Content type Inform step"},"order":{"type":"integer","format":"int32","position":6,"description":"The order of inform step in a learning module"},"displayName":{"type":"string","position":7,"description":"The display name for the inform step"},"description":{"type":"string","position":8,"description":"The description for the inform step"}},"description":"Learning module inform steps request"},"LearningModuleRequest":{"type":"object","required":["completionTimeInDays","name"],"properties":{"name":{"type":"string","description":"The name of learning module"},"description":{"type":"string","description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","description":"The completion time of learning module in days"},"informSteps":{"type":"array","description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStepRequest"}},"type":{"type":"string","description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"assessmentForm":{"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"coverArt":{"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtRequest"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The recommended time in minutes to complete the module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"externalId":{"type":"string","description":"The external ID of the learning module. Maximum length: 50 characters.","minLength":0,"maxLength":50},"enforceContentOrder":{"type":"boolean","description":"If true, learning module content should be viewed one by one in order"},"reviewAssessmentResults":{"description":"Allows to view Assessment results in detail","$ref":"#/definitions/ReviewAssessmentResults"}},"description":"Learning module request"},"LearningModulesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LearningModule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningModulePreviewUpdateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The Learning Module id"},"assignment":{"description":"The Assignment Preview","$ref":"#/definitions/LearningModulePreviewUpdateResponseAssignment"}},"description":"Learning module preview update response"},"LearningModulePreviewUpdateResponseAssignment":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"percentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment","readOnly":true},"completionPercentage":{"type":"number","format":"float","description":"The overall completion percentage of assignment","readOnly":true},"assessmentPercentageScore":{"type":"number","format":"float","description":"The user's percentage score for this assignment's assessment","readOnly":true},"assessmentCompletionPercentage":{"type":"number","format":"float","description":"The assessment completion percentage of assignment","readOnly":true},"isPassed":{"type":"boolean","description":"True if the assessment was passed","readOnly":true},"currentStep":{"description":"The next assignment step","readOnly":true,"$ref":"#/definitions/LearningModulePreviewUpdateResponseCurrentStep"},"steps":{"type":"array","description":"List of assignment steps","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewUpdateStep"}}},"description":"Learning module preview update response assignment"},"LearningModulePreviewUpdateResponseCurrentStep":{"type":"object","properties":{"shareableContentObject":{"description":"The SCO (Shareable Content Object) data","$ref":"#/definitions/LearningShareableContentObject"}},"description":"Learning module preview update response current step"},"LearningModulePreviewUpdateScoStructure":{"type":"object","properties":{"id":{"type":"string","description":"The id of this SCO in the course manifest","readOnly":true},"name":{"type":"string","description":"The name of this SCO in the course manifest","readOnly":true},"successStatus":{"type":"string","description":"The success status of this SCO","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"percentageScore":{"type":"number","format":"float","description":"Percentage Score","readOnly":true},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewUpdateScoStructure"}}},"description":"Learning module preview update SCO structure"},"LearningModulePreviewUpdateStep":{"type":"object","properties":{"id":{"type":"string","description":"The id of the step","readOnly":true},"successStatus":{"type":"string","description":"The success status of the step","readOnly":true,"enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the step","readOnly":true,"enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage of the step","readOnly":true},"percentageScore":{"type":"number","format":"float","description":"Percentage Score","readOnly":true},"structure":{"type":"array","description":"The structure for any SCO associated with this step","readOnly":true,"items":{"$ref":"#/definitions/LearningModulePreviewUpdateScoStructure"}}},"description":"Learning module preview update assignment step"},"LearningModulePreviewUpdateRequest":{"type":"object","properties":{"state":{"type":"string","description":"The assignment State","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"currentStep":{"description":"The assignment current step","$ref":"#/definitions/LearningModulePreviewUpdateRequestCurrentStep"},"steps":{"type":"array","description":"The assignment Steps","items":{"$ref":"#/definitions/LearningModulePreviewUpdateStep"}},"assessment":{"description":"The assessment for learning module","$ref":"#/definitions/LearningAssessment"},"assessmentForm":{"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"}},"description":"Learning module preview update request"},"LearningModulePreviewUpdateRequestCurrentStep":{"type":"object","properties":{"id":{"type":"string","description":"The id of this step"},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage for this step"},"shareableContentObject":{"description":"The SCO (Shareable Content Object) data","$ref":"#/definitions/LearningShareableContentObject"}},"description":"Learning module preview update request current step"},"LearningModulePublishResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning module publish response"},"LearningModulePublishRequest":{"type":"object","properties":{"termsAndConditionsAccepted":{"type":"boolean","description":"Whether the terms and conditions were accepted"}},"description":"Learning module publish request"},"LearningModuleJobRequest":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":"The type for the learning module job","enum":["Reassign","GracefulArchive","ImmediateArchive","Unarchive"]}},"description":"Learning module job request"},"AssignedLearningModule":{"type":"object","required":["completionTimeInDays","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of learning module"},"excludedFromCatalog":{"type":"boolean","description":"If true, learning module is excluded when retrieving modules for manual assignment"},"createdBy":{"description":"The user who created learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time learning module was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who modified learning module","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time learning module was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of published learning module","readOnly":true},"externalId":{"type":"string","description":"The external ID of the learning module","readOnly":true},"source":{"type":"string","description":"The source of the learning module","readOnly":true,"enum":["UserCreated","GenesysBeyond"]},"rule":{"description":"The rule for learning module; read-only, and only populated when requested via expand param.","readOnly":true,"$ref":"#/definitions/LearningModuleRule"},"enforceContentOrder":{"type":"boolean","description":"If true, learning module content should be viewed one by one in order"},"reviewAssessmentResults":{"description":"Allows to view Assessment results in detail","$ref":"#/definitions/ReviewAssessmentResults"},"currentAssignments":{"type":"array","description":"The current assignments for the requested users","items":{"$ref":"#/definitions/LearningAssignment"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"isArchived":{"type":"boolean","description":"If true, learning module is archived","readOnly":true},"isPublished":{"type":"boolean","description":"If true, learning module is published","readOnly":true},"description":{"type":"string","position":1,"description":"The description of learning module"},"completionTimeInDays":{"type":"integer","format":"int32","position":2,"description":"The completion time of learning module in days"},"type":{"type":"string","position":3,"description":"The type for the learning module","enum":["Informational","AssessedContent","Assessment","External"]},"informSteps":{"type":"array","position":5,"description":"The list of inform steps in a learning module","items":{"$ref":"#/definitions/LearningModuleInformStep"}},"assessmentForm":{"position":6,"description":"The assessment form for learning module","$ref":"#/definitions/AssessmentForm"},"summaryData":{"position":7,"description":"The learning module summary data","$ref":"#/definitions/LearningModuleSummary"},"reassignSummaryData":{"position":8,"description":"The learning module reassign summary data","$ref":"#/definitions/LearningModuleReassignSummary"},"coverArt":{"position":9,"description":"The cover art for the learning module","$ref":"#/definitions/LearningModuleCoverArtResponse"},"lengthInMinutes":{"type":"integer","format":"int32","position":10,"description":"The recommended time in minutes to complete the module"},"archivalMode":{"type":"string","position":11,"description":"The mode of archival for learning module","enum":["Graceful","Immediate"]}},"description":"Learning module response"},"AssignedLearningModuleDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AssignedLearningModule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LearningAssignmentExternalUpdate":{"type":"object","properties":{"state":{"type":"string","description":"The Learning Assignment state","enum":["Assigned","InProgress","Completed","Deleted","NotCompleted","InvalidSchedule"]},"percentageScore":{"type":"number","format":"float","description":"The score"},"isPassed":{"type":"boolean","description":"Was the assignment marked as passed"}}},"LearningScheduleSlotsQueryResponse":{"type":"object","properties":{"suggestedSlots":{"type":"array","description":"List of slots where Learning activity can be scheduled","items":{"$ref":"#/definitions/LearningSlot"}},"wfmScheduleActivities":{"type":"array","description":"Detailed data for WFM scheduled activities","items":{"$ref":"#/definitions/LearningSlotWfmScheduleActivity"}}}},"LearningSlot":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"Start date and time of scheduled Learning activity slot. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of Learning activity slot in minutes"},"staffingDifference":{"type":"number","format":"double","description":"Difference between scheduled and forecast headcount for this slot after scheduling the Learning activity"},"differenceRating":{"type":"string","description":"Rating based on the staffing difference for scheduled slot","enum":["Poor","Neutral","Good"]}}},"LearningSlotFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"LearningSlotScheduleActivity":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"LearningSlotWfmScheduleActivity":{"type":"object","properties":{"user":{"description":"User that the schedule is for","$ref":"#/definitions/UserReference"},"activities":{"type":"array","description":"List of user's scheduled activities","items":{"$ref":"#/definitions/LearningSlotScheduleActivity"}},"fullDayTimeOffMarkers":{"type":"array","description":"List of user's days off","items":{"$ref":"#/definitions/LearningSlotFullDayTimeOffMarker"}}}},"LearningScheduleSlotsQueryRequest":{"type":"object","required":["interval","lengthInMinutes","userIds"],"properties":{"interval":{"type":"string","description":"Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment to schedule in 15 minutes granularity"},"userIds":{"type":"array","description":"The user IDs for which to fetch schedules. Must be only 1.","items":{"type":"string"}},"interruptibleAssignmentId":{"type":"string","description":"Assignment ID to exclude from consideration when determining blocked slots"}}},"LearningScormResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the SCORM package","enum":["UploadPending","Unpacking","Error","Ready"]},"errorCode":{"type":"string","description":"The error code of the SCORM package (on failure)"},"errorMessage":{"type":"string","description":"The error message associated with the error code"},"percentageUnpacked":{"type":"number","format":"float","description":"The percentage of the SCORM package that has been unpacked"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning SCORM package"},"LearningScormUploadResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the SCORM package","enum":["UploadPending","Unpacking","Error","Ready"]},"uploadUrl":{"type":"string","description":"The pre-signed URL. Use it with headers below to upload file to S3"},"headers":{"type":"object","description":"The additional headers that need to be included in the upload request","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Learning SCORM upload response"},"LearningScormUploadRequest":{"type":"object","required":["contentMd5"],"properties":{"contentMd5":{"type":"string","description":"The MD5 content of the SCORM package"}},"description":"Learning SCORM upload request"},"WidgetClientConfig":{"type":"object","properties":{"v1":{"$ref":"#/definitions/WidgetClientConfigV1"},"v2":{"$ref":"#/definitions/WidgetClientConfigV2"},"v1-http":{"$ref":"#/definitions/WidgetClientConfigV1Http"},"third-party":{"$ref":"#/definitions/WidgetClientConfigThirdParty"}}},"WidgetClientConfigThirdParty":{"type":"object"},"WidgetClientConfigV1":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV1Http":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV2":{"type":"object"},"WidgetDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A human-readable description of this Deployment."},"authenticationRequired":{"type":"boolean","description":"When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation."},"disabled":{"type":"boolean","description":"When true, all create chat operations using this Deployment will be rejected."},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"clientType":{"type":"string","description":"The type of display widget for which this Deployment is configured, which controls the administrator settings shown.","enum":["v1","v2","v1-http","third-party"]},"clientConfig":{"description":"The client configuration options that should be made available to the clients of this Deployment.","$ref":"#/definitions/WidgetClientConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WidgetDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WidgetDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"ActivityCode":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","description":"The name of the activity code. Default activity codes will be created with an empty name"},"isActive":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"isDefault":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The activity code's category.","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ActivityCodeContainer":{"type":"object","required":["metadata"],"properties":{"activityCodes":{"type":"object","description":"Map of activity code id to activity code","additionalProperties":{"$ref":"#/definitions/ActivityCode"}},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WfmVersionedEntityMetadata":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","description":"The version of the associated entity. Used to prevent conflicts on concurrent edits"},"modifiedBy":{"description":"The user who last modified the associated entity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user who created the associated entity, if available","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"EstimateAvailableFullDayTimeOffResponse":{"type":"object","required":["date","durationMinutes","flexible","payableMinutes"],"properties":{"date":{"type":"string","format":"date","description":"Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"durationMinutes":{"type":"integer","format":"int32","description":"An estimation of time off request length in minutes"},"payableMinutes":{"type":"integer","format":"int32","description":"An estimation of payable part of time off request in minutes"},"flexible":{"type":"boolean","description":"Whether there is flexibility for a user to choose different hours than the system estimated"}}},"EstimateAvailablePartialDayTimeOffResponse":{"type":"object","required":["date","durationMinutes","flexible","payableMinutes"],"properties":{"date":{"type":"string","format":"date-time","description":"Start date-time in ISO-8601 format for partial day request"},"durationMinutes":{"type":"integer","format":"int32","description":"An estimation of time off request length in minutes"},"payableMinutes":{"type":"integer","format":"int32","description":"An estimation of payable part of time off request in minutes"},"flexible":{"type":"boolean","description":"Whether there is flexibility for a user to choose different hours than the system estimated"}}},"EstimateAvailableTimeOffResponse":{"type":"object","required":["activityCodeId","paid","user"],"properties":{"fullDayDates":{"type":"array","description":"Full day dates. partialDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailableFullDayTimeOffResponse"}},"partialDayDates":{"type":"array","description":"Partial day dates. fullDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailablePartialDayTimeOffResponse"}},"user":{"description":"The user to whom the time off request belongs","$ref":"#/definitions/UserReference"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this estimate is for a paid time off request"}}},"EstimateAvailableFullDayTimeOffRequest":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date","description":"Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"requestedDurationMinutes":{"type":"integer","format":"int32","description":"A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting"}}},"EstimateAvailablePartialDayTimeOffRequest":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date-time","description":"Start date-time in ISO-8601 format for partial day request"},"requestedDurationMinutes":{"type":"integer","format":"int32","description":"A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting"}}},"EstimateAvailableTimeOffRequest":{"type":"object","required":["activityCodeId","paid"],"properties":{"fullDayDates":{"type":"array","description":"Full day dates. partialDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailableFullDayTimeOffRequest"}},"partialDayDates":{"type":"array","description":"Partial day dates. fullDayDates must be empty if this field is populated","items":{"$ref":"#/definitions/EstimateAvailablePartialDayTimeOffRequest"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this estimate is for a paid time off request"}}},"BusinessUnitActivityCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"defaultCode":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The category of the activity code","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code","items":{"$ref":"#/definitions/SecondaryPresence"}},"metadata":{"description":"Version metadata of this activity code","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SecondaryPresence":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ListWrapperSecondaryPresence":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/SecondaryPresence"}}}},"UpdateActivityCodeRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category. Attempting to change the category of a default activity code will return an error","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"description":"The secondary presences of this activity code","$ref":"#/definitions/ListWrapperSecondaryPresence"},"metadata":{"description":"Version metadata for the associated business unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BusinessUnitActivityCodeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"CreateActivityCodeRequest":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"countsTowardShrinkage":{"type":"boolean","description":"Whether or not this activity code counts toward shrinkage calculations"},"plannedShrinkage":{"type":"boolean","description":"Whether this activity code is considered planned or unplanned shrinkage"},"interruptible":{"type":"boolean","description":"Whether this activity code is considered interruptible"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code","items":{"$ref":"#/definitions/SecondaryPresence"}}}},"ForecastAbandonRateResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The target percent abandon rate goal"}}},"ForecastAverageSpeedOfAnswerResponse":{"type":"object","properties":{"seconds":{"type":"integer","format":"int32","description":"the average speed of answer goal in seconds"}}},"ForecastPlanningGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the planning group"},"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Route path configuration for this planning group","items":{"$ref":"#/definitions/RoutePathResponse"}},"serviceGoalTemplate":{"description":"Service goals for this planning group","$ref":"#/definitions/ForecastServiceGoalTemplateResponse"}}},"ForecastServiceGoalTemplateImpactOverrideResponse":{"type":"object","properties":{"serviceLevel":{"description":"Allowed service level percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"},"averageSpeedOfAnswer":{"description":"Allowed average speed of answer percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"},"abandonRate":{"description":"Allowed abandon rate percent increase and decrease; undefined if the goal is not enabled","$ref":"#/definitions/WfmServiceGoalImpact"}}},"ForecastServiceGoalTemplateResponse":{"type":"object","properties":{"serviceLevel":{"description":"The service level goal for this forecast","$ref":"#/definitions/ForecastServiceLevelResponse"},"averageSpeedOfAnswer":{"description":"The average speed of answer goal for this forecast","$ref":"#/definitions/ForecastAverageSpeedOfAnswerResponse"},"abandonRate":{"description":"The abandon rate goal for this forecast","$ref":"#/definitions/ForecastAbandonRateResponse"},"impactOverride":{"description":"The service goal impact overrides for this forecast","$ref":"#/definitions/ForecastServiceGoalTemplateImpactOverrideResponse"}}},"ForecastServiceLevelResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The percent of calls to answer in the number of seconds defined"},"seconds":{"type":"integer","format":"int32","description":"The number of seconds to define for the percent of calls to be answered"}}},"LanguageReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathResponse":{"type":"object","properties":{"queue":{"description":"The ID of the queue associated with the route path","$ref":"#/definitions/QueueReference"},"mediaType":{"type":"string","description":"The media type of the given queue associated with the route path","enum":["Voice","Chat","Email","Callback","Message"]},"language":{"description":"The ID of the language associated with the route path","$ref":"#/definitions/LanguageReference"},"skills":{"type":"array","description":"The set of skills associated with the route path","uniqueItems":true,"items":{"$ref":"#/definitions/RoutingSkillReference"}}}},"RoutingSkillReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmIntradayPlanningGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"noDataReason":{"type":"string","description":"The reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"]}}},"WfmServiceGoalImpact":{"type":"object","required":["decreaseByPercent","increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"The maximum allowed percent increase from the configured goal"},"decreaseByPercent":{"type":"number","format":"double","description":"The maximum allowed percent decrease from the configured goal"}}},"AsyncIntradayResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuIntradayResponse"}}},"BuIntradayDataGroup":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type associated with this intraday group","enum":["Voice","Chat","Email","Callback","Message"]},"forecastDataSummary":{"description":"Forecast data summary for this date range","$ref":"#/definitions/BuIntradayForecastData"},"forecastDataPerInterval":{"type":"array","description":"Forecast data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayForecastData"}},"scheduleDataSummary":{"description":"Schedule data summary for this date range","$ref":"#/definitions/BuIntradayScheduleData"},"scheduleDataPerInterval":{"type":"array","description":"Schedule data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayScheduleData"}},"performancePredictionDataSummary":{"description":"Performance prediction data summary for this date range","$ref":"#/definitions/IntradayPerformancePredictionData"},"performancePredictionDataPerInterval":{"type":"array","description":"Performance prediction data per interval for this date range","items":{"$ref":"#/definitions/IntradayPerformancePredictionData"}}}},"BuIntradayForecastData":{"type":"object","properties":{"offered":{"type":"number","format":"double","description":"The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer"},"averageHandleTimeSeconds":{"type":"number","format":"double","description":"The average handle time in seconds an agent spent handling interactions"}}},"BuIntradayResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The aggregation period in minutes, which determines the interval duration of the returned data"},"noDataReason":{"type":"string","description":"If not null, the reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"]},"categories":{"type":"array","description":"The categories to which this data corresponds","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"]}},"shortTermForecast":{"description":"Short term forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"schedule":{"description":"Schedule reference","$ref":"#/definitions/BuScheduleReference"},"intradayDataGroupings":{"type":"array","description":"Intraday data grouped by a single media type and set of planning group IDs","items":{"$ref":"#/definitions/BuIntradayDataGroup"}}}},"BuIntradayScheduleData":{"type":"object","properties":{"onQueueTimeSeconds":{"type":"integer","format":"int64","description":"The total on-queue time in seconds for all agents in this group"}}},"BuScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"description":{"type":"string","description":"The description of the short term forecast","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntradayPerformancePredictionData":{"type":"object","properties":{"serviceLevelPercent":{"type":"number","format":"double","description":"Percentage of interactions that meets service level target as defined in the matching service goal templates"},"averageSpeedOfAnswerSeconds":{"type":"number","format":"double","description":"Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed"},"occupancyPercent":{"type":"number","format":"double","description":"Percentage of on-queue time for all agents in this group that are occupied handling interactions"}}},"IntradayPlanningGroupRequest":{"type":"object","required":["businessUnitDate","categories"],"properties":{"businessUnitDate":{"type":"string","format":"date","description":"Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"categories":{"type":"array","description":"The metric categories","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"]}},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups","items":{"type":"string"}},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data. Required, defaults to 15"}}},"BuImportShortTermForecastSchema":{"type":"object","required":["description","planningGroups","weekCount"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks covered by the forecast"},"planningGroups":{"type":"array","description":"The short term planning group data","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"longTermPlanningGroups":{"type":"array","description":"The long term planning group data","items":{"$ref":"#/definitions/LongTermForecastPlanningGroupData"}},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"}}},"ForecastPlanningGroupData":{"type":"object","required":["averageHandleTimeSecondsPerInterval","offeredPerInterval","planningGroupId"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerInterval":{"type":"array","description":"Forecast offered counts per 15 minute interval for this week of the forecast","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerInterval":{"type":"array","description":"Forecast average handle time per 15 minute interval in seconds","items":{"type":"number","format":"double"}}}},"ImportForecastUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/BuImportShortTermForecastSchema"}}},"LongTermForecastPlanningGroupData":{"type":"object","required":["averageHandleTimeSecondsPerDay","offeredPerDay","planningGroupId"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerDay":{"type":"array","description":"Forecast offered counts per day for this planning group","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerDay":{"type":"array","description":"Forecast average handle time per day in seconds","items":{"type":"number","format":"double"}}}},"UploadUrlRequestBody":{"type":"object","required":["contentLengthBytes"],"properties":{"contentLengthBytes":{"type":"integer","format":"int64","description":"The expected content length (in bytes) of the gzip-encoded data that will be PUT to the returned signed URL"}}},"BuForecastGenerationPlanningGroupResult":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group"},"metricResults":{"type":"array","description":"The generation results for the associated planning group","items":{"$ref":"#/definitions/BuForecastTimeSeriesResult"}}}},"BuForecastGenerationResult":{"type":"object","properties":{"planningGroupResults":{"type":"array","description":"Generation results, broken down by planning group","items":{"$ref":"#/definitions/BuForecastGenerationPlanningGroupResult"}}}},"BuForecastModificationResponse":{"type":"object","required":["displayGranularity","enabled","granularity","metric","planningGroupIds","type","values"],"properties":{"type":{"type":"string","description":"The type of the modification","enum":["MinimumPerInterval","MaximumPerInterval","SetValuePerInterval","ChangeValuePerInterval","ChangePercentPerInterval","SetValueOverRange","ChangeValueOverRange","SetValuesForIntervalSet","SetMultiGranularityValuesForIntervalSet"]},"startIntervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate representing the first interval to which this modification applies"},"endIntervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate representing the last interval to which this modification applies"},"metric":{"type":"string","description":"The metric to which this modification applies","enum":["Offered","AverageHandleTimeSeconds"]},"legacyMetric":{"type":"string","description":"The legacy metric to which this modification applies if applicable","enum":["AverageAfterCallWorkTimeSeconds","AverageHandleTimeSeconds","AverageTalkTimeSeconds","Offered"]},"value":{"type":"number","format":"double","description":"The value of the modification"},"values":{"type":"array","description":"The list of modification values. Only applicable for grid-type modifications","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"secondaryValues":{"type":"array","description":"The list of modification secondary values. Only applicable for multi granularity modifications","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"displayGranularity":{"type":"string","description":"The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"granularity":{"type":"string","description":"The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"secondaryGranularity":{"type":"string","description":"The granularity of the 'secondaryValues' modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"enabled":{"type":"boolean","description":"Whether the modification is enabled for the forecast"},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups to which this forecast modification applies","uniqueItems":true,"items":{"type":"string"}}}},"BuForecastTimeSeriesResult":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this result applies to","enum":["Offered","AverageHandleTimeSeconds"]},"forecastingMethod":{"type":"string","description":"The forecasting method that was used for this metric","enum":["AutoRegressiveIntegratedMovingAverage","MovingAverage","SingleExponentialSmoothing","RandomWalk","DecompositionUsingAdditiveSeasonality","DecompositionUsingMultiplicativeSeasonality","HoltWintersAdditiveSeasonality","HoltWintersAdditiveSeasonalityWithDampedTrend","HoltWintersMultiplicativeSeasonality","HoltWintersMultiplicativeSeasonalityWithDampedTrend","DampedLinearExponentialSmoothing","DoubleExponentialSmoothing","DoubleMovingAverage","LinearExponentialSmoothing","LinearWeightedMovingAverage","PointEstimateUsingDampedLinearExponentialSmoothing","PointEstimateUsingDoubleExponentialSmoothing","PointEstimateUsingLatestWeek","PointEstimateUsingLinearExponentialSmoothing","PointEstimateUsingWeightedAverage","CurveFit","MultiLinearRegression","DynamicHarmonicRegression","Theta","Ensemble","Other"]},"forecastType":{"type":"string","description":"The forecasting type in this forecast result","enum":["LongTerm","ShortTerm"]}}},"BuShortTermForecast":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sourceDays":{"type":"array","description":"The source day pointers for this forecast","items":{"$ref":"#/definitions/ForecastSourceDayPointer"}},"modifications":{"type":"array","description":"Any manual modifications applied to this forecast","items":{"$ref":"#/definitions/BuForecastModificationResponse"}},"generationResults":{"description":"Generation result metadata","$ref":"#/definitions/BuForecastGenerationResult"},"timeZone":{"type":"string","description":"The time zone for this forecast"},"planningGroupsVersion":{"type":"integer","format":"int32","description":"The version of the planning groups that was used for this forecast"},"planningGroups":{"description":"A snapshot of the planning groups used for this forecast as of the version number indicated","$ref":"#/definitions/ForecastPlanningGroupsResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ForecastPlanningGroupsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"businessUnitServiceGoalImpact":{"description":"A snapshot of a business unit’s service goal impact settings taken at forecast generation time.","$ref":"#/definitions/WfmServiceGoalImpactSettings"}}},"ForecastSourceDayPointer":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"The forecast day of week for this source data","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","EighthDay"]},"weight":{"type":"integer","format":"int32","description":"The relative weight to apply to this source data item for weighted averages"},"date":{"type":"string","description":"The date this source data represents, in yyyy-MM-dd format"},"fileName":{"type":"string","description":"The name of the source file this data came from if it originated from a data import"},"dataKey":{"type":"string","description":"The key to look up the forecast source data for this source day"}}},"ImportForecastResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Always null, result will come via notification","$ref":"#/definitions/BuShortTermForecast"}}},"WfmForecastModificationIntervalOffsetValue":{"type":"object","required":["intervalIndex","value"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"The number of intervals past referenceStartDate to which to apply this modification"},"value":{"type":"number","format":"double","description":"The value to set for the given interval"}}},"WfmServiceGoalImpactSettings":{"type":"object","required":["abandonRate","averageSpeedOfAnswer","serviceLevel"],"properties":{"serviceLevel":{"description":"Allowed service level percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"},"averageSpeedOfAnswer":{"description":"Allowed average speed of answer percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"},"abandonRate":{"description":"Allowed abandon rate percent increase and decrease","$ref":"#/definitions/WfmServiceGoalImpact"}}},"WfmProcessUploadRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"The uploadKey provided by the request to get an upload URL"}}},"BuShortTermForecastListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuShortTermForecastListItem"}}}},"AsyncForecastOperationResult":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuShortTermForecast"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"}}},"GenerateBuForecastRequest":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"canUseForScheduling":{"type":"boolean","description":"Whether this forecast can be used for scheduling"}}},"BuForecastResult":{"type":"object","properties":{"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"BuForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/BuForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"BuForecastStaffingRequirementsResult":{"type":"object","required":["downloadUrl","downloadUrlExpirationDate","weekNumber"],"properties":{"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"downloadUrl":{"type":"string","description":"The url to get the requirements results for this week"},"downloadUrlExpirationDate":{"type":"string","format":"date-time","description":"The expiration date of the download url, as an ISO-8601 string"},"planningGroupStaffingRequirements":{"type":"array","description":"Results will always come via downloadUrl, however the schema is included for documentation","items":{"$ref":"#/definitions/StaffingRequirementsPlanningGroupData"}}}},"BuForecastStaffingRequirementsResultResponse":{"type":"object","required":["businessUnitId","forecast","intervalLengthMinutes","referenceStartDate","state","weekCount"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which the forecast staffing requirements belongs"},"forecast":{"description":"The forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast as an ISO-8601 string"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data"},"state":{"type":"string","description":"The state of the staffing requirements generation","enum":["Processing","Complete","Error"]},"results":{"type":"array","description":"The forecast staffing requirement results, Will be populated when state == 'Complete'","items":{"$ref":"#/definitions/BuForecastStaffingRequirementsResult"}}}},"StaffingRequirementsPlanningGroupData":{"type":"object","required":["planningGroupId","staffingRequirementsPerInterval"],"properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies"},"staffingRequirementsPerInterval":{"type":"array","description":"Staffing requirements per interval for this week forecast","items":{"type":"number","format":"double"}}}},"LongTermForecastResult":{"type":"object","properties":{"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/LongTermForecastPlanningGroupData"}},"referenceStartDate":{"type":"string","format":"date","description":"The reference start date relative to the business unit time zone in this forecast. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"LongTermForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/LongTermForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"CopyBuForecastRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekDate":{"type":"string","format":"date","description":"The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuSchedulingSettingsResponse":{"type":"object","properties":{"messageSeverities":{"type":"array","description":"Schedule generation message severity configuration","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}},"syncTimeOffProperties":{"type":"array","description":"Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published.","uniqueItems":true,"items":{"type":"string","enum":["PayableMinutes"]}},"serviceGoalImpact":{"description":"Configures the max percent increase and decrease of service goals for this business unit","$ref":"#/definitions/WfmServiceGoalImpactSettings"},"allowWorkPlanPerMinuteGranularity":{"type":"boolean","description":"Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false."}}},"BuShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts"}}},"BusinessUnitResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"settings":{"description":"Settings for this business unit","$ref":"#/definitions/BusinessUnitSettingsResponse"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitSettingsResponse":{"type":"object","required":["metadata","startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsResponse"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"SchedulerMessageTypeSeverity":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory","UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory","UnableToScheduleMaxWeeklyPaidTimeFromTimeOff","UnableToScheduleMaxWorkDayPaidTimeFromTimeOff","UnableToScheduleMinIntershiftTimeFromAgentHistory","UnableToScheduleMinIntershiftTimeFromDst","UnableToScheduleMinShiftStartDistanceFromAgentHistory","UnableToScheduleMinShiftStartDistanceFromDst","UnableToScheduleMinWeeklyPaidTimeFromTimeOff","UnableToScheduleMinWeeklyWorkDaysFromTimeOff","UnableToScheduleMinWorkDayPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff","UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff","UnableToScheduleWorkDayFromTimeOff","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"]},"severity":{"type":"string","description":"The severity of the message","enum":["Ignore","Information","Warning","Error"]}}},"BuSchedulingSettingsRequest":{"type":"object","properties":{"messageSeverities":{"type":"array","description":"Schedule generation message severity configuration","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}},"syncTimeOffProperties":{"description":"Synchronize set of time off properties from scheduled activities to time off requests when the schedule is published.","$ref":"#/definitions/SetWrapperSyncTimeOffProperty"},"serviceGoalImpact":{"description":"Configures the max percent increase and decrease of service goals for this business unit","$ref":"#/definitions/WfmServiceGoalImpactSettings"},"allowWorkPlanPerMinuteGranularity":{"type":"boolean","description":"Indicates whether or not per minute granularity for scheduling will be enabled for this business unit. Defaults to false."}}},"SetWrapperSyncTimeOffProperty":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["PayableMinutes"]}}}},"UpdateBusinessUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be moved"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/UpdateBusinessUnitSettingsRequest"}}},"UpdateBusinessUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format","readOnly":true},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsRequest"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdherenceSettings":{"type":"object","properties":{"severeAlertThresholdMinutes":{"type":"integer","format":"int32","description":"The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence"},"adherenceTargetPercent":{"type":"integer","format":"int32","description":"Target adherence percentage"},"adherenceExceptionThresholdSeconds":{"type":"integer","format":"int32","description":"The threshold in seconds for which agents should not be penalized for being momentarily out of adherence"},"nonOnQueueActivitiesEquivalent":{"type":"boolean","description":"Whether to treat all non-on-queue activities as equivalent for adherence purposes"},"trackOnQueueActivity":{"type":"boolean","description":"Whether to track on-queue activities"},"ignoredActivityCategories":{"description":"Activity categories that should be ignored for adherence purposes","$ref":"#/definitions/IgnoredActivityCategories"}}},"BusinessUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IgnoredActivityCategories":{"type":"object","properties":{"values":{"type":"array","description":"Activity categories list","items":{"type":"string","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]}}}},"ManagementUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"businessUnit":{"description":"The business unit to which this management unit belongs","$ref":"#/definitions/BusinessUnitReference"},"startDayOfWeek":{"type":"string","description":"Start day of week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for the management unit in standard Olson format. Moving to Business Unit"},"settings":{"description":"The configuration settings for this management unit","$ref":"#/definitions/ManagementUnitSettingsResponse"},"metadata":{"description":"Version info metadata for this management unit. Deprecated, use settings.metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"modifiedBy":{"description":"The user who last modified this entity. Deprecated, use field from settings.metadata instead","readOnly":true,"$ref":"#/definitions/UserReference"},"version":{"type":"integer","format":"int32","description":"The version of the underlying entity. Deprecated, use field from settings.metadata instead","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ManagementUnit"}},"pageSize":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"pageNumber":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"total":{"type":"integer","format":"int64","description":"Deprecated, paging is not supported"},"previousUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"lastUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"firstUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"nextUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"pageCount":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"selfUri":{"type":"string","format":"uri"}}},"ManagementUnitSettingsResponse":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit. These settings are only available if you have the permission wfm:managementUnit:view","$ref":"#/definitions/SchedulingSettingsResponse"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningPeriodSettings":{"type":"object","required":["startDate","weekCount"],"properties":{"weekCount":{"type":"integer","format":"int32","description":"Planning period length in weeks"},"startDate":{"type":"string","format":"date","description":"Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"SchedulingSettingsResponse":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/PlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}},"ShiftTradeActivityRule":{"type":"object","required":["action","activityCategory"],"properties":{"activityCategory":{"type":"string","description":"The activity category to which to apply this rule","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"action":{"type":"string","description":"The action this rule invokes","enum":["Replace","DoNotAllowTrade","KeepWithSchedule"]},"activityCodeIdReplacement":{"type":"string","description":"The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID)"}}},"ShiftTradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether shift trading is enabled for this management unit"},"autoReview":{"type":"boolean","description":"Whether automatic shift trade review is enabled according to the rules defined in for this management unit"},"allowDirectTrades":{"type":"boolean","description":"Whether direct shift trades between agents are allowed"},"minHoursInFuture":{"type":"integer","format":"int32","description":"The minimum number of hours in the future shift trades are allowed"},"unequalPaid":{"type":"string","description":"How to handle shift trades which involve unequal paid times","enum":["Allow","Disallow","AdminReview"]},"oneSided":{"type":"string","description":"How to handle one-sided shift trades","enum":["Allow","Disallow","AdminReview"]},"weeklyMinPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly minimum paid time constraint","enum":["Allow","Disallow","AdminReview"]},"weeklyMaxPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly maximum paid time constraint","enum":["Allow","Disallow","AdminReview"]},"requiresMatchingQueues":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching queues"},"requiresMatchingLanguages":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching languages"},"requiresMatchingSkills":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching skills"},"requiresMatchingPlanningGroups":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching planning groups"},"activityCategoryRules":{"type":"array","description":"Rules that specify what to do with activity categories that are part of a shift defined in a trade","items":{"$ref":"#/definitions/ShiftTradeActivityRule"}}}},"ShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of weeks to consider by default when generating a volume forecast"}}},"ShrinkageOverride":{"type":"object","required":["intervalIndex"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week"},"shrinkagePercent":{"type":"number","format":"double","description":"Shrinkage override percent. Setting a null value will reset the interval to the default"}}},"ShrinkageOverrides":{"type":"object","properties":{"clear":{"type":"boolean","description":"Set true to clear the shrinkage interval overrides"},"values":{"type":"array","description":"List of interval shrinkage overrides","items":{"$ref":"#/definitions/ShrinkageOverride"}}}},"TimeOffRequestSettings":{"type":"object","properties":{"submissionRangeEnforced":{"type":"boolean","description":"Whether to enforce a submission range for agent time off requests"},"submissionEarliestDaysFromNow":{"type":"integer","format":"int32","description":"The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past"},"submissionLatestDaysFromNow":{"type":"integer","format":"int32","description":"The latest number of days from now for which an agent can submit a time off request"}}},"CreateBusinessUnitRequest":{"type":"object","required":["divisionId","name","settings"],"properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be added"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/CreateBusinessUnitSettingsRequest"}}},"CreateBusinessUnitSettingsRequest":{"type":"object","required":["startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"scheduling":{"description":"Scheduling settings","$ref":"#/definitions/BuSchedulingSettingsRequest"}}},"BusinessUnitListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"authorized":{"type":"boolean","description":"Whether the user has authorization to interact with this business unit","readOnly":true},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/DivisionReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitListItem"}}}},"ManagementUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"SchedulingSettingsRequest":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/ValueWrapperPlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}},"UpdateManagementUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the management unit"},"divisionId":{"type":"string","description":"The new division id for the management unit"},"settings":{"description":"Updated settings for the management unit","$ref":"#/definitions/ManagementUnitSettingsRequest"}}},"ValueWrapperPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/PlanningPeriodSettings"}}},"MoveManagementUnitResponse":{"type":"object","properties":{"businessUnit":{"description":"The new business unit","$ref":"#/definitions/BusinessUnitReference"},"status":{"type":"string","description":"The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete'","enum":["Processing","Complete","Canceled","Error"]}}},"MoveManagementUnitRequest":{"type":"object","required":["businessUnitId"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which to move the management unit"}}},"CreateManagementUnitApiRequest":{"type":"object","required":["businessUnitId","name"],"properties":{"name":{"type":"string","description":"The name of the management unit"},"timeZone":{"type":"string","description":"The default time zone to use for this management unit. Moving to Business Unit"},"startDayOfWeek":{"type":"string","description":"The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"settings":{"description":"The configuration for the management unit. If omitted, reasonable defaults will be assigned","$ref":"#/definitions/CreateManagementUnitSettingsRequest"},"divisionId":{"type":"string","description":"The id of the division to which this management unit belongs. Defaults to home division ID"},"businessUnitId":{"type":"string","description":"The id of the business unit to which this management unit belongs"}}},"CreateManagementUnitSettingsRequest":{"type":"object","properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"}}},"BuScheduleReferenceForMuRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"businessUnit":{"description":"The start week date for this schedule","$ref":"#/definitions/BusinessUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ShiftTradeResponse"}}}},"ShiftTradeResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this shift trade"},"weekDate":{"type":"string","format":"date","description":"The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"A reference to the associated schedule","$ref":"#/definitions/BuScheduleReferenceForMuRoute"},"state":{"type":"string","description":"The state of this shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"initiatingUser":{"description":"The user who initiated this trade","$ref":"#/definitions/UserReference"},"initiatingShiftId":{"type":"string","description":"The ID of the shift offered for trade by the initiating user"},"initiatingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiatingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent","$ref":"#/definitions/UserReference"},"receivingShiftId":{"type":"string","description":"The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift"},"receivingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oneSided":{"type":"boolean","description":"Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)"},"acceptableIntervals":{"type":"array","description":"Time frames when the initiating user is willing to accept trades. Empty means giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}},"reviewedBy":{"description":"The user who reviewed this shift trade","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Version data for this trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ManagementUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this data","$ref":"#/definitions/UserReference"},"workPlan":{"description":"The work plan associated with this agent, if applicable","$ref":"#/definitions/WorkPlanReference"},"workPlanRotation":{"description":"The work plan rotation associated with this agent, if applicable","$ref":"#/definitions/WorkPlanRotationReference"},"acceptDirectShiftTrades":{"type":"boolean","description":"Whether the agent accepts direct shift trade requests"},"workPlanOverrides":{"type":"array","description":"The work plan overrides associated with this agent. Populate with expand=workPlanOverrides","items":{"$ref":"#/definitions/WorkPlanOverride"}},"queues":{"type":"array","description":"List of queues to which this agent is capable of handling","items":{"$ref":"#/definitions/QueueReference"}},"languages":{"type":"array","description":"The list of languages this agent is capable of handling","items":{"$ref":"#/definitions/LanguageReference"}},"skills":{"type":"array","description":"The list of skills this agent is capable of handling","items":{"$ref":"#/definitions/RoutingSkillReference"}},"schedulable":{"type":"boolean","description":"Whether the agent can be included in schedule generation"},"metadata":{"description":"Metadata for this agent","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanOverride":{"type":"object","required":["startDate","weekCount","workPlan"],"properties":{"startDate":{"type":"string","format":"date","description":"The start date in yyyy-MM-dd format of the work plan override. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"Number of weeks for the work plan override"},"workPlan":{"description":"The work plan reference associated with this override","$ref":"#/definitions/WorkPlanReference"}}},"WorkPlanReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"managementUnit":{"description":"The management unit to which this work plan belongs. Nullable in some routes","$ref":"#/definitions/ManagementUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanRotationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateMuAgentRequest":{"type":"object","required":["userId"],"properties":{"schedulable":{"type":"boolean","description":"Whether the agent can be included in schedule generation"},"userId":{"type":"string","description":"User to be updated"}}},"UpdateMuAgentsRequest":{"type":"object","properties":{"entities":{"type":"array","description":"List of agents to update","items":{"$ref":"#/definitions/UpdateMuAgentRequest"}}}},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}}},"WfmUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}}}},"PlanningGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceGoalTemplate":{"description":"The ID of the service goal template associated with this planning group","$ref":"#/definitions/ServiceGoalTemplateReference"},"routePaths":{"type":"array","description":"Set of route paths associated with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathResponse"}},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceGoalTemplateReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathRequest":{"type":"object","required":["mediaType","queueId"],"properties":{"queueId":{"type":"string","example":"f27450c9-c1a0-451a-804c-2579b268b273","description":"The ID of the queue to associate with the route path"},"mediaType":{"type":"string","example":"Email","description":"The media type of the given queue to associate with the route path","enum":["Voice","Chat","Email","Callback","Message"]},"languageId":{"type":"string","example":"e3d65f6a-c0d2-41da-8152-82d3f075d77c","description":"The ID of the language to associate with the route path"},"skillIds":{"type":"array","example":"[\"33d29376-4267-4968-8042-dcabdf2c1d98\"]","description":"The set of skill IDs to associate with the route path","uniqueItems":true,"items":{"type":"string"}},"sourcePlanningGroup":{"description":"The planning group from which to take route paths. This property is only needed if a route path already exists in another planning group.Note that taking a route path from another planning group will modify the other planning group","$ref":"#/definitions/SourcePlanningGroupRequest"}}},"SetWrapperRoutePathRequest":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}}}},"SourcePlanningGroupRequest":{"type":"object","required":["id","metadata"],"properties":{"id":{"type":"string","description":"The ID of the planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdatePlanningGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"description":"Set of route paths to associate with the planning group","$ref":"#/definitions/SetWrapperRoutePathRequest"},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningGroupList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PlanningGroup"}},"metadata":{"description":"Version metadata for the planning groups","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAbandonRate":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include abandon rate in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Abandon rate percent goal. Required if include == true"}}},"BuAverageSpeedOfAnswer":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include average speed of answer (ASA) in the associated configuration"},"seconds":{"type":"integer","format":"int32","description":"The target average speed of answer (ASA) in seconds. Required if include == true"}}},"BuServiceLevel":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include service level targets in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Service level target percent answered. Required if include == true"},"seconds":{"type":"integer","format":"int32","description":"Service level target answer time. Required if include == true"}}},"ServiceGoalTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceGoalTemplateImpactOverride":{"type":"object","required":["enabled","impact"],"properties":{"enabled":{"type":"boolean","description":"Whether service goal overrides are enabled for this service goal template"},"impact":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/WfmServiceGoalImpactSettings"}}},"CreatePlanningGroupRequest":{"type":"object","required":["name","routePaths","serviceGoalTemplateId"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Set of route paths to associate with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"}}},"UpdateServiceGoalTemplate":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"}}},"ServiceGoalTemplateList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ServiceGoalTemplate"}},"metadata":{"description":"Version metadata for the service goal templates","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"CreateServiceGoalTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"impactOverride":{"description":"Settings controlling max percent increase and decrease of service goals for this service goal template","$ref":"#/definitions/ServiceGoalTemplateImpactOverride"}}},"ShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeMatchesSummaryResponse"}}}},"WeekShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"weekDate":{"type":"string","format":"date","description":"The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"count":{"type":"integer","format":"int32","description":"The number of trades in the Matched state for the given week"}}},"StaffingGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/StaffingGroupResponse"}}}},"StaffingGroupResponse":{"type":"object","required":["metadata","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the staffing group"},"users":{"type":"array","description":"The list of users that belong to the staffing group","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"managementUnit":{"description":"The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit","$ref":"#/definitions/ManagementUnitReference"},"metadata":{"description":"Version metadata for the staffing group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateStaffingGroupRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the staffing group"},"userIds":{"type":"array","description":"The set of user IDs to associate with the staffing group","uniqueItems":true,"items":{"type":"string"}},"managementUnitId":{"type":"string","description":"The ID of the management unit to which the staffing group users belong. If undefined the staffing group can include users from the entire business unit"}}},"SetWrapperString":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"UpdateStaffingGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the staffing group"},"userIds":{"description":"The set of user Ids to associate with the staffing group","$ref":"#/definitions/SetWrapperString"},"metadata":{"description":"Version metadata for the staffing group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffLimit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"granularity":{"type":"string","description":"Granularity choice for the time off limit","enum":["Daily"]},"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default time off limit value in minutes per granularity interval"},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffLimitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimit"}}}},"CreateTimeOffLimitRequest":{"type":"object","properties":{"granularity":{"type":"string","description":"Granularity choice for time off limit. If not specified, 'Daily' is assumed","enum":["Daily"]},"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default limit value in minutes per granularity. If not specified, then 0 is assumed, which means there are no time off minutes available"}}},"SetTimeOffLimitValuesRequest":{"type":"object","required":["metadata"],"properties":{"values":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimitRange"}},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffLimitRange":{"type":"object","required":["granularity","limitMinutesPerInterval","startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the range. The end date is determined by 'granularity' and the size of 'limitMinutesPerInterval'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"Granularity choice for the time off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"The list of time off limit values in minutes per granularity interval. If 'null' is specified, then interval specific value is cleared. Such interval will have 'defaultLimitMinutes' value","items":{"type":"integer","format":"int32"}}}},"QueryTimeOffLimitValuesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/TimeOffLimitValueRange"}}}},"TimeOffLimitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffLimitValueRange":{"type":"object","required":["granularity","startDate"],"properties":{"timeOffLimit":{"description":"The ID of the time off limit","$ref":"#/definitions/TimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists"},"granularity":{"type":"string","description":"Granularity choice for time off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"A list of time off limit values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"allocatedMinutesPerInterval":{"type":"array","description":"A list of allocated time off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedMinutesPerInterval":{"type":"array","description":"A list of waitlisted time off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"LocalDateRange":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endDate":{"type":"string","format":"date","description":"The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"QueryTimeOffLimitValuesRequest":{"type":"object","required":["dateRanges"],"properties":{"timeOffLimitId":{"type":"string","description":"The time off limit object id to retrieve values for. Required if activityCodeId is not specified"},"activityCodeId":{"type":"string","description":"The activity code id to filter the affected limit objects by. Required if timeOffLimitId is not specified"},"dateRanges":{"type":"array","description":"The list of the date ranges to return time off limit, allocated and waitlisted minutes. The valid number of date ranges is between 1 and 30. Maximum total number of days in all ranges in 366.","items":{"$ref":"#/definitions/LocalDateRange"}}}},"UpdateTimeOffLimitRequest":{"type":"object","required":["metadata"],"properties":{"defaultLimitMinutes":{"type":"integer","format":"int32","description":"The default time off limit value in minutes per granularity"},"metadata":{"description":"Version metadata for the time off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"HrisTimeOffType":{"type":"object","required":["hrisIntegrationId","id","name"],"properties":{"id":{"type":"string","description":"The ID of the time off type configured in integration."},"name":{"type":"string","description":"The name of the time off type configured in integration."},"hrisIntegrationId":{"type":"string","description":"The ID of the integration."},"secondaryId":{"type":"string","description":"Secondary ID of the time off type, if configured in integration."}}},"TimeOffPlan":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"type":"array","description":"The set of activity code IDs associated with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"timeOffLimits":{"type":"array","description":"The set of time off limit IDs associated with this time off plan.","uniqueItems":true,"items":{"$ref":"#/definitions/TimeOffLimitReference"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/HrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan is currently being used by agents."},"metadata":{"description":"Version metadata for the time off plan.","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateTimeOffPlanRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"description":"The set of activity code IDs to associate with this time off plan.","$ref":"#/definitions/SetWrapperString"},"timeOffLimitIds":{"description":"The set of time off limit IDs to associate with this time off plan.","$ref":"#/definitions/SetWrapperString"},"autoApprovalRule":{"type":"string","description":"Auto approval rule for the time off plan.","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/ValueWrapperHrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan should be used by agents."},"metadata":{"description":"Version metadata for the time off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperHrisTimeOffType":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/HrisTimeOffType"}}},"TimeOffPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffPlan"}}}},"CreateTimeOffPlanRequest":{"type":"object","required":["active","autoApprovalRule","name"],"properties":{"name":{"type":"string","description":"The name of this time off plan."},"activityCodeIds":{"type":"array","description":"The set of activity code IDs to associate with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"timeOffLimitIds":{"type":"array","description":"The set of time off limit IDs to associate with this time off plan.","uniqueItems":true,"items":{"type":"string"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for the time off plan.","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time off request start date for when the request will be expired from the waitlist."},"hrisTimeOffType":{"description":"Time off type, if this time off plan is associated with the integration.","$ref":"#/definitions/HrisTimeOffType"},"active":{"type":"boolean","description":"Whether this time off plan should be used by agents."}}},"TimeOffRequestReference":{"type":"object","properties":{"id":{"type":"string","description":"The id of the time off request"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserTimeOffIntegrationStatusResponse":{"type":"object","required":["integrationStatus","timeOffRequest","user"],"properties":{"timeOffRequest":{"description":"The time off request associated with this integration status","$ref":"#/definitions/TimeOffRequestReference"},"integrationStatus":{"type":"string","description":"The value of integration status for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]},"user":{"description":"The user to whom the time off request belongs","$ref":"#/definitions/UserReference"}}},"UserTimeOffIntegrationStatusResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserTimeOffIntegrationStatusResponse"}}}},"QueryTimeOffIntegrationStatusRequest":{"type":"object","required":["timeOffRequestLookups"],"properties":{"timeOffRequestLookups":{"type":"array","description":"A list of time off request lookups","items":{"$ref":"#/definitions/TimeOffRequestLookup"}}}},"TimeOffRequestLookup":{"type":"object","required":["timeOffRequestId","userId"],"properties":{"timeOffRequestId":{"type":"string","description":"The ID of the time off request"},"userId":{"type":"string","description":"The ID of the user to whom the time off request belongs"}}},"SetTimeOffIntegrationStatusRequest":{"type":"object","required":["integrationStatus"],"properties":{"integrationStatus":{"type":"string","description":"The integration status value for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]}}},"TimeOffRequestList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeOffRequests":{"type":"array","items":{"$ref":"#/definitions/TimeOffRequestResponse"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"substatus":{"type":"string","description":"The substatus of this time off request","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who last modified this TimeOffRequestResponse","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"syncVersion":{"type":"integer","format":"int32","description":"The sync version of this time off request for which the scheduled activity is associated"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateAdminTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes","status","users"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED"]},"users":{"type":"array","description":"A set of IDs for users to associate with this time off request","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"paid":{"type":"boolean","description":"Whether this is a paid time off request"}}},"AdminTimeOffRequestPatch":{"type":"object","required":["metadata"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED"]},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffRequest":{"type":"object","required":["id","user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The user that the time off request belongs to","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"paid":{"type":"boolean","description":"Whether this is a paid time off request"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"substatus":{"type":"string","description":"The substatus of this time off request","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"syncVersion":{"type":"integer","format":"int32","description":"The sync version of this time off request for which the scheduled activity is associated"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of time off requests","items":{"$ref":"#/definitions/TimeOffRequest"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"DateRange":{"type":"object","properties":{"startDate":{"type":"string","description":"The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."},"endDate":{"type":"string","description":"The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."}}},"TimeOffRequestQueryBody":{"type":"object","properties":{"ids":{"type":"array","description":"The set of ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"userIds":{"type":"array","description":"The set of user ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"statuses":{"type":"array","description":"The set of statuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["PENDING"]}},"substatuses":{"type":"array","description":"The set of substatuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["AdvanceTimeElapsed","AutoApproved","InsufficientBalance","InvalidDailyDuration","OutsideShift","RemovedFromWaitlist","Waitlisted"]}},"dateRange":{"description":"The inclusive range of dates to filter time off requests","$ref":"#/definitions/DateRange"}}},"WaitlistPosition":{"type":"object","properties":{"timeOffRequest":{"description":"The time off request for this wait list position","$ref":"#/definitions/TimeOffRequestReference"},"timeOffLimit":{"description":"The time off limit for which time off request is waitlisted","$ref":"#/definitions/TimeOffLimitReference"},"date":{"type":"string","format":"date","description":"The date to which this wait list position applies, as defined by the time zone of the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"waitlistPosition":{"type":"integer","format":"int32","description":"The time off request's position in the waitlist on the date. 1 means time off is the first in the waitlist"}}},"WaitlistPositionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WaitlistPosition"}}}},"QueryWaitlistPositionsRequest":{"type":"object","required":["timeOffRequests"],"properties":{"timeOffRequests":{"type":"array","description":"The list of the time off request ids for which to fetch the daily waitlist positions","items":{"$ref":"#/definitions/UserTimeOffRequestReference"}}}},"UserTimeOffRequestReference":{"type":"object","required":["user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The ID of the user to whom the time off request applies","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StaffingGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserStaffingGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserStaffingGroupResponse"}}}},"UserStaffingGroupResponse":{"type":"object","properties":{"user":{"description":"The user associated with the staffing group","$ref":"#/definitions/UserReference"},"staffingGroup":{"description":"The staffing group","$ref":"#/definitions/StaffingGroupReference"}}},"QueryUserStaffingGroupListRequest":{"type":"object","required":["userIds"],"properties":{"userIds":{"type":"array","description":"The set of user IDs to fetch associated staffing groups","uniqueItems":true,"items":{"type":"string"}}}},"SearchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"A trade which matches search criteria","$ref":"#/definitions/ShiftTradeResponse"},"matchingReceivingShiftIds":{"type":"array","description":"IDs of shifts which match the search criteria","items":{"type":"string"}},"preview":{"description":"A preview of what the shift trade would look like if matched","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"SearchShiftTradesResponse":{"type":"object","properties":{"trades":{"type":"array","description":"The shift trades that match the search criteria","items":{"$ref":"#/definitions/SearchShiftTradeResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"ShiftTradeActivityPreviewResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity counts as paid time"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for this activity"}}},"ShiftTradePreviewResponse":{"type":"object","properties":{"activities":{"type":"array","description":"List of activities that will make up the new shift if this shift trade is approved","items":{"$ref":"#/definitions/ShiftTradeActivityPreviewResponse"}}}},"SearchShiftTradesRequest":{"type":"object","required":["receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule for which to search for available shift trades"},"receivingShiftIds":{"type":"array","description":"The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)","uniqueItems":true,"items":{"type":"string"}}}},"ShiftTradeMatchReviewResponse":{"type":"object","properties":{"initiatingUser":{"description":"Details for the initiatingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"receivingUser":{"description":"Details for the receivingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"violations":{"type":"array","description":"Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations associated with this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchReviewUserResponse":{"type":"object","properties":{"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"The minimum weekly paid minutes for this user per the work plan tied to the agent schedule"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"The maximum weekly paid minutes for this user per the work plan tied to the agent schedule"},"preTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user prior to the shift trade"},"postTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user if the shift trade is approved"},"postTradeNewShift":{"description":"Preview of what the shift will look like for the opposite side of this trade after the match is approved","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"ShiftTradeMatchViolation":{"type":"object","properties":{"type":{"type":"string","description":"The type of constraint violation","enum":["AgentCapabilityMismatch","CannotTradeWithYourself","DirectTradeForOtherUser","InitiatingAgentScheduleDoesNotExist","InitiatingShiftDisallowedActivityCategory","InitiatingShiftDoesNotExist","InitiatingShiftHasExternalActivities","InitiatingShiftOverlapsExisting","InitiatingShiftStartTooClose","InitiatingShiftTimesChanged","InitiatingWeeklyMaxPaidTime","InitiatingWeeklyMinPaidTime","InvalidState","OneSidedTradeCreation","ReceivingAgentScheduleDoesNotExist","ReceivingShiftDisallowedActivityCategory","ReceivingShiftDoesNotExist","ReceivingShiftForOneSidedTrade","ReceivingShiftHasExternalActivities","ReceivingShiftMissingForTwoSidedTrade","ReceivingShiftOutsideAcceptableIntervals","ReceivingShiftOverlapsExisting","ReceivingShiftStartTooClose","ReceivingShiftTimesChanged","ReceivingWeeklyMaxPaidTime","ReceivingWeeklyMinPaidTime","ShiftTradingNotEnabled","UnequalPaidTime","WeekScheduleDifferent","WeekScheduleDoesNotExist","WeekScheduleUnpublished"]},"params":{"type":"object","description":"Clarifying user params for constructing helpful error messages","additionalProperties":{"type":"string"}}}},"WeekShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"WeekShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The shift trade details","$ref":"#/definitions/ShiftTradeResponse"},"matchReview":{"description":"A preview of what the schedule would look like if the shift trade is approved plus any violations","$ref":"#/definitions/ShiftTradeMatchReviewResponse"}}},"AddShiftTradeRequest":{"type":"object","required":["initiatingShiftId","scheduleId"],"properties":{"scheduleId":{"type":"string","description":"The ID of the schedule to which the initiating and receiving shifts belong"},"initiatingShiftId":{"type":"string","description":"The ID of the shift that the initiating user wants to give up"},"receivingUserId":{"type":"string","description":"The ID of the user to whom to send the request (for use in direct trade requests)"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"acceptableIntervals":{"type":"array","description":"The acceptable intervals the initiating user is willing to accept in trade. Empty indicates the user is giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"BulkUpdateShiftTradeStateResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BulkUpdateShiftTradeStateResult"}}},"BulkUpdateShiftTradeStateResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResultItem"}}}},"BulkUpdateShiftTradeStateResultItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the shift trade after the update request is processed","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"reviewedBy":{"description":"The user who reviewed the request, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["InitiatingAgentScheduleNotFound","InitiatingAgentShiftHasExternalActivities","InitiatingAgentShiftNotFound","ReceivingAgentNotFound","ReceivingAgentScheduleNotFound","ReceivingAgentShiftHasExternalActivities","ReceivingAgentShiftNotFound","ScheduleNotPublished","TransitionNotAllowed"]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BulkShiftTradeStateUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The shift trades to update","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateRequestItem"}}}},"BulkUpdateShiftTradeStateRequestItem":{"type":"object","required":["metadata","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"state":{"type":"string","description":"The new state to set on the shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ListWrapperInterval":{"type":"object","properties":{"values":{"type":"array","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"PatchShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"receivingUserId":{"description":"Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user.","$ref":"#/definitions/ValueWrapperString"},"expiration":{"description":"Update the expiration time for this shift trade.","$ref":"#/definitions/ValueWrapperDate"},"acceptableIntervals":{"description":"Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request","$ref":"#/definitions/ListWrapperInterval"},"metadata":{"description":"Version metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperDate":{"type":"object","properties":{"value":{"type":"string","format":"date-time","description":"The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MatchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The associated shift trade","$ref":"#/definitions/ShiftTradeResponse"},"violations":{"type":"array","description":"Constraint violations which disallow this shift trade","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations for this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"MatchShiftTradeRequest":{"type":"object","required":["metadata","receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule with which the shift trade is associated"},"receivingShiftId":{"type":"string","description":"The ID of the shift the receiving user is giving up in trade, if applicable"},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"MoveAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with the move","$ref":"#/definitions/UserReference"},"result":{"type":"string","description":"The result of the move","enum":["AlreadyMoved","DestinationBusinessUnitAgentLimitExceeded","DestinationManagementUnitAgentLimitExceeded","DestinationManagementUnitDoesNotExist","MoveSuccessful","MovingToDifferentManagementUnit","NothingToDo","SourceManagementUnitNotAuthorized"]}}},"MoveAgentsResponse":{"type":"object","properties":{"requestingUser":{"description":"The user that made the request","$ref":"#/definitions/UserReference"},"destinationManagementUnit":{"description":"The management unit specified on the request","$ref":"#/definitions/ManagementUnitReference"},"results":{"type":"array","description":"The list containing the agent and result of the move operation","items":{"$ref":"#/definitions/MoveAgentResponse"}}}},"MoveAgentsRequest":{"type":"object","required":["userIds"],"properties":{"userIds":{"type":"array","description":"The list of user ids to move","uniqueItems":true,"items":{"type":"string"}},"destinationManagementUnitId":{"type":"string","description":"The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null."}}},"AgentManagementUnitReference":{"type":"object","properties":{"user":{"description":"The user (agent) for whom the management unit was requested","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management to which the user (agent) belongs","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the user (agent) belongs. Populate with expand=businessUnit","$ref":"#/definitions/BusinessUnitReference"}}},"ConstraintConflictMessage":{"type":"object","properties":{"message":{"description":"Message for how to resolve a set of conflicted work plan constraints","$ref":"#/definitions/WorkPlanConstraintConflictMessage"},"conflictedConstraintMessages":{"type":"array","description":"Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set","items":{"$ref":"#/definitions/WorkPlanConstraintMessage"}}}},"ValidateWorkPlanMessages":{"type":"object","properties":{"violationMessages":{"type":"array","description":"Messages for work plan violating some rules such as no shifts in a work plan","items":{"$ref":"#/definitions/WorkPlanConfigurationViolationMessage"}},"constraintConflictMessage":{"description":"This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated","$ref":"#/definitions/ConstraintConflictMessage"}}},"ValidateWorkPlanResponse":{"type":"object","properties":{"workPlan":{"description":"The work plan reference associated with this response","$ref":"#/definitions/WorkPlanReference"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not"},"messages":{"description":"Validation messages for this work plan","$ref":"#/definitions/ValidateWorkPlanMessages"}}},"WorkPlanConfigurationViolationMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of configuration violation message for this work plan","enum":["ActivitiesOverlap","ActivityEndGreaterThanShiftStop","ActivityPaidTimeGreaterThanShiftPaidTime","ActivityStartBeforeShiftStart","ActivityStartGreaterThanEqualToShiftStop","ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes","DailyExactPaidMinutes","DailyMaxTotalLessThanWeeklyMin","DailyMaxTotalLessThanWeeklyMinWithOptional","DailyMaxTotalLessThanWeeklyMinWithoutOptional","DailyMinTotalGreaterThanWeeklyMax","DailyMinTotalGreaterThanWeeklyMaxWithOptional","DailyMinTotalGreaterThanWeeklyMaxWithoutOptional","DailyRequiredDaysGreaterThanWeeklyMaxDays","DailyShiftHasNoDaysSelected","DailyShiftMaxPossibilitiesViolated","EarliestShiftStopIsTooLate","ExactPaidTimeNotDivisibleByGranularity","MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek","MaxDaysOffPerPlanningPeriodNotCorrect","MaxPaidTimeIsMoreThanShiftLength","MaxPaidTimeNotDivisibleByGranularity","MaxPaidTimePerPlanningPeriod","MaxShifts","MinPaidTimeNotDivisibleByGranularity","MinPaidTimePerPlanningPeriod","NoShifts","PaidTimeGreaterThanMaxWorkTime","PaidTimeLessThanMinWorkTime","PaidTimeNotMetByShiftStartStop","ShiftDaysSelectMoreThanMinWorkingDays","ShiftStopEarlierThanStart","ShiftVarianceCannotBeMet","WeeklyExactPaidMinutes"]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}},"severity":{"type":"string","description":"Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid.","enum":["Information","Warning","Error"]}}},"WorkPlanConstraintConflictMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of constraint conflict that can be resolved by clients in order to generate agent schedules","enum":["UnknownFix","WithPotentialFixes"]},"arguments":{"type":"array","description":"The arguments to the type of the message that can help clients resolve validation issues","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanConstraintMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of the work plan constraint in this message","enum":["ActivityEarliestStartTimeMinutesFromMidnight","ActivityEarliestStartTimeMinutesFromShiftStart","ActivityLatestStartTimeMinutesFromMidnight","ActivityLatestStartTimeMinutesFromShiftStart","ActivityMinimumLengthFromShiftEndMinutes","ActivityMinimumLengthFromShiftStartMinutes","ActivityStartTimeIncrementInMinutes","PlanningPeriodMaximumDaysOff","PlanningPeriodMaximumPaidTimeMinutes","PlanningPeriodMinimumDaysOff","PlanningPeriodMinimumPaidTimeMinutes","ShiftDayOffRule","ShiftEarliestStartTimeMinutesFromMidnight","ShiftEarliestStopTimeMinutesFromMidnight","ShiftLatestStartTimeMinutesFromMidnight","ShiftLatestStopTimeMinutesFromMidnight","ShiftMaximumContiguousTimeMinutes","ShiftMaximumPaidTimeMinutes","ShiftMinimumContiguousTimeMinutes","ShiftMinimumPaidTimeMinutes","ShiftStartTimeIncrementInMinutes","ShiftStartVarianceMaximumVarianceMinutes","ShiftStartVariancePaidDuration","WorkPlanMaximumConsecutiveWorkingDays","WorkPlanMaximumConsecutiveWorkingWeekends","WorkPlanMaximumWeeklyPaidTimeMinutes","WorkPlanMaximumWorkingDaysPerWeek","WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes","WorkPlanMinimumInterShiftTimeMinutes","WorkPlanMinimumShiftStartDistanceMinutes","WorkPlanMinimumWeeklyPaidTimeMinutes","WorkPlanMinimumWorkingDaysPerWeek","WorkPlanOptionalDays","WorkPlanPaidTimeGranularityMinutes"]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanValidationMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of the argument associated with violation messages","enum":["ActivityId","ActivityId2","ActivityPaidTimeMinutes","ActivityStartTimeMinutes","ActivityValidationId","ActivityValidationId2","ApplicableDays","Count","DailyPaidTimeMinutes","MaximumDays","MaxShiftCount","Minutes","PaidTimeGranularityMinutes","RequiredDays","ShiftId","ShiftPaidTimeMinutes","ShiftStartTimeMinutes","ShiftStopTimeMinutes","ShiftValidationId","WeeklyPaidTimeMinutes","Weeks","WorkTimeMinutes"]},"value":{"type":"string","description":"The value of the argument"}}},"DeletableUserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"delete":{"type":"boolean","description":"If marked true, the user will be removed an associated entity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ListWrapperShiftStartVariance":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/ShiftStartVariance"}}}},"SetWrapperDayOfWeek":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"ShiftStartVariance":{"type":"object","required":["applicableDays","maxShiftStartVarianceMinutes"],"properties":{"applicableDays":{"type":"array","description":"Days for which shift start variance is configured","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"maxShiftStartVarianceMinutes":{"type":"integer","format":"int32","description":"Maximum variance in minutes across shift starts"}}},"WorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"},"id":{"type":"string","description":"ID of the activity. This is required only for the case of updating an existing activity"},"delete":{"type":"boolean","description":"If marked true for updating an existing activity, the activity will be permanently deleted"},"validationId":{"type":"string","description":"ID of the activity in the context of work plan validation"}}},"WorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"constrainDayOff":{"type":"boolean","description":"Whether day off rule is enabled"},"dayOffRule":{"type":"string","description":"The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true","enum":["NextDayOff","PreviousDayOff"]},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/WorkPlanActivity"}},"id":{"type":"string","description":"ID of the shift. This is required only for the case of updating an existing shift"},"delete":{"type":"boolean","description":"If marked true for updating an existing shift, the shift will be permanently deleted"},"validationId":{"type":"string","description":"ID of shift in the context of work plan validation"}}},"WorkPlanValidationRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanListItemResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan. Populate with expand=details","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan. Populate with expand=details","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan. Populate with expand=agentCount"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanListItemResponse"}}}},"WorkPlan":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not","readOnly":true},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of this work plan"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity should be constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/CreateWorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/UserReference"}}}},"CreateWorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"}}},"CreateWorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"constrainDayOff":{"type":"boolean","description":"Whether day off rule is enabled"},"dayOffRule":{"type":"string","description":"The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true","enum":["NextDayOff","PreviousDayOff"]},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/CreateWorkPlanActivity"}}}},"CopyWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the copied work plan"}}},"DateRangeWithOptionalEnd":{"type":"object","required":["startBusinessUnitDate"],"properties":{"startBusinessUnitDate":{"type":"string","format":"date","description":"The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endBusinessUnitDate":{"type":"string","format":"date","description":"The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"WorkPlanPatternResponse":{"type":"object","properties":{"workPlans":{"type":"array","description":"List of work plans in order of rotation on a weekly basis","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"WorkPlanRotationAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with this work plan rotation","$ref":"#/definitions/UserReference"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"WorkPlanRotationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"pattern":{"description":"Pattern with ordered list of work plans that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternResponse"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan rotation"},"agents":{"type":"array","description":"Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanRotationAgentResponse"}},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddWorkPlanRotationAgentRequest":{"type":"object","required":["dateRange","position","userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"AddWorkPlanRotationRequest":{"type":"object","required":["dateRange","name","pattern"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/AddWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"}}},"WorkPlanPatternRequest":{"type":"object","required":["workPlanIds"],"properties":{"workPlanIds":{"type":"array","description":"List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty","items":{"type":"string"}}}},"CopyWorkPlanRotationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name to apply to the new copy of the work plan rotation"}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"UpdateWorkPlanRotationAgentRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"},"delete":{"type":"boolean","description":"If marked true for this agent when updating, then this agent will be removed from this work plan rotation"}}},"UpdateWorkPlanRotationRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/UpdateWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ActivityCodeReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"secondaryPresences":{"type":"array","description":"The secondary presences of this activity code.","items":{"$ref":"#/definitions/SecondaryPresence"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the adherence explanation job","enum":["AddExplanation","UpdateExplanation","QueryAgentExplanations","QueryBuExplanations"]},"status":{"type":"string","description":"The status of the adherence explanation job","enum":["Processing","Complete","Error"]},"adherenceExplanation":{"description":"The adherence explanation added or modified by the job once complete; may be null if status == 'Error'. Used if type is in [ 'AddExplanation', 'UpdateExplanation' ]","$ref":"#/definitions/AdherenceExplanationResponse"},"downloadUrl":{"type":"string","description":"A URL to fetch results of the job. Only set if status == 'Complete' and type is in [ 'QueryAgentExplanations', 'QueryBuExplanations' ]"},"error":{"description":"Error details if status == 'Error'","$ref":"#/definitions/ErrorBody"},"agentQueryResponseTemplate":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryAgentExplanations'","$ref":"#/definitions/AdherenceExplanationListingAgentQueryResponse"},"buQueryResponseTemplate":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'QueryBuExplanations'","$ref":"#/definitions/AdherenceExplanationListingBuQueryResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationListingAgentQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"AdherenceExplanationListingBuQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"AdherenceExplanationResponse":{"type":"object","required":["agent","businessUnit","lengthMinutes","managementUnit","startDate","status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"agent":{"description":"The agent to whom this adherence explanation applies","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/BusinessUnitReference"},"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"},"reviewedBy":{"description":"The user who reviewed the adherence explanation, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp for when the adherence explanation was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceExplanationAsyncResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/AdherenceExplanationJobReference"}}},"AdherenceExplanationJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the adherence explanation job","enum":["AddExplanation","UpdateExplanation","QueryAgentExplanations","QueryBuExplanations"]},"status":{"type":"string","description":"The status of the adherence explanation job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AddAdherenceExplanationAdminRequest":{"type":"object","required":["lengthMinutes","startDate","type"],"properties":{"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]}}},"UpdateAdherenceExplanationStatusRequest":{"type":"object","properties":{"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]}}},"AgentQueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListingAgentQueryResponse"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"AgentQueryAdherenceExplanationsRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuQueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListingBuQueryResponse"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"BuQueryAdherenceExplanationsRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnitIds":{"type":"array","description":"A filter for which management units to query. Leave empty or omit entirely for all management units in the business unit","items":{"type":"string"}},"agentIds":{"type":"array","description":"A filter for which agents within the business unit to query. Leave empty or omit entirely for all agents in the business unit (or management units if specified)","items":{"type":"string"}}}},"AddAdherenceExplanationAgentRequest":{"type":"object","required":["lengthMinutes","startDate","type"],"properties":{"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"notes":{"type":"string","description":"Notes about the adherence explanation"}}},"AdherenceExplanationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdherenceExplanationResponse"}}}},"QueryAdherenceExplanationsResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/AdherenceExplanationJobReference"},"result":{"description":"The result of the query. May come via notification","$ref":"#/definitions/AdherenceExplanationListing"},"downloadUrl":{"type":"string","description":"The URL from which to download the result. May come via notification"}}},"HistoricalAdherenceActuals":{"type":"object","properties":{"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"actualSecondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID"},"startOffsetSeconds":{"type":"integer","format":"int32","description":"Actual start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Actual end offset in seconds relative to query start time"}}},"HistoricalAdherenceExceptionInfo":{"type":"object","properties":{"startOffsetSeconds":{"type":"integer","format":"int32","description":"Exception start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Exception end offset in seconds relative to query start time"},"scheduledActivityCodeId":{"type":"string","description":"The ID of the scheduled activity code for this user"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"scheduledSecondaryPresenceLookupIds":{"type":"array","description":"The lookup IDs used to retrieve the scheduled secondary statuses from map of lookup ID to corresponding secondary presence ID","uniqueItems":true,"items":{"type":"string"}},"actualActivityCodeId":{"type":"string","description":"The ID of the actual activity code for this user"},"actualActivityCategory":{"type":"string","description":"Activity for which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"secondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve the actual secondary status from map of lookup ID to corresponding secondary presence ID"}}},"WfmHistoricalAdherenceBulkJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the historical adherence bulk job to listen for via notification or query using the jobs route"},"status":{"type":"string","description":"The status of the historical adherence bulk job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmHistoricalAdherenceBulkResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/WfmHistoricalAdherenceBulkJobReference"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. This field is populated only if query state is Complete","items":{"type":"string"}},"downloadResult":{"description":"Results will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceBulkResult"}}},"WfmHistoricalAdherenceBulkResult":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range for this result in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range for this result in ISO-8601 format"},"managementUnitId":{"type":"string","description":"The ID of the management unit for this result"},"userResults":{"type":"array","description":"The individual results for each user","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkUserResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceBulkUserDayMetrics":{"type":"object","properties":{"dayStartOffsetSeconds":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSeconds":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSeconds":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSeconds":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"WfmHistoricalAdherenceBulkUserResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"actuals":{"type":"array","description":"List of adherence actuals for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkUserDayMetrics"}}}},"WfmHistoricalAdherenceBulkItem":{"type":"object","required":["endDate","managementUnitId","startDate"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format"},"userIds":{"type":"array","description":"The IDs of the users to query. If not included, will query every user in the management unit","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results. Defaults to false if not specified."},"includeActuals":{"type":"boolean","description":"Whether user actual activities should be returned as part of the results. Defaults to false if not specified."}}},"WfmHistoricalAdherenceBulkQuery":{"type":"object","required":["items","timeZone"],"properties":{"items":{"type":"array","description":"The historical adherence items to query","items":{"$ref":"#/definitions/WfmHistoricalAdherenceBulkItem"}},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."}}},"HistoricalAdherenceDayMetrics":{"type":"object","properties":{"dayStartOffsetSecs":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSecs":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSecs":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSecs":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSecs":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"HistoricalAdherenceQueryResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"managementUnitId":{"type":"string","description":"The ID of the management unit of the user for whom the adherence is queried"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/HistoricalAdherenceDayMetrics"}},"actualsEndDate":{"type":"string","format":"date-time","description":"The end date of the actual activities in ISO-8601 format."},"actuals":{"type":"array","description":"List of actual activity with offset for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}}}},"WfmHistoricalAdherenceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The query ID to listen for"},"downloadUrl":{"type":"string","description":"Deprecated. Use downloadUrls instead."},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceResultWrapper"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. For notification purposes only","items":{"type":"string"}},"queryState":{"type":"string","description":"The state of the adherence query","enum":["Processing","Complete","Error"]}}},"WfmHistoricalAdherenceResultWrapper":{"type":"object","properties":{"entityId":{"type":"string","description":"The operation ID of the historical adherence query"},"data":{"type":"array","description":"The list of historical adherence query results","items":{"$ref":"#/definitions/HistoricalAdherenceQueryResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForUsers":{"type":"object","required":["startDate","timeZone","userIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"WfmHistoricalAdherenceQuery":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForTeams":{"type":"object","required":["startDate","timeZone"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input."},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"RealTimeAdherenceExplanation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"startDate":{"type":"string","format":"date-time","description":"The start timestamp of the adherence explanation in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TeamReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserScheduleAdherence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user for whom this status applies","readOnly":true,"$ref":"#/definitions/UserReference"},"businessUnit":{"description":"The business unit to which this user belongs","readOnly":true,"$ref":"#/definitions/BusinessUnitReference"},"managementUnit":{"description":"The management unit to which this user belongs","readOnly":true,"$ref":"#/definitions/ManagementUnitReference"},"team":{"description":"The team to which this user belongs","readOnly":true,"$ref":"#/definitions/TeamReference"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"scheduledActivityCode":{"description":"Activity code for which the user is currently scheduled","readOnly":true,"$ref":"#/definitions/ActivityCodeReference"},"systemPresence":{"type":"string","description":"Actual underlying system presence value","readOnly":true,"enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"organizationSecondaryPresenceId":{"type":"string","description":"Organization Secondary Presence Id.","readOnly":true},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","readOnly":true,"enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]},"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"isOutOfOffice":{"type":"boolean","description":"Whether the user is marked OutOfOffice","readOnly":true},"adherenceState":{"type":"string","description":"The user's current adherence state","readOnly":true,"enum":["InAdherence","OutOfAdherence","Unscheduled","Unknown","Ignored","Explained"]},"impact":{"type":"string","description":"The impact of the user's current adherenceState","readOnly":true,"enum":["Positive","Negative","Neutral","Unknown"]},"adherenceExplanation":{"description":"Currently applicable explanation for the adherence state","readOnly":true,"$ref":"#/definitions/RealTimeAdherenceExplanation"},"timeOfAdherenceChange":{"type":"string","format":"date-time","description":"Time when the user entered the current adherenceState in ISO-8601 format","readOnly":true},"presenceUpdateTime":{"type":"string","format":"date-time","description":"Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"activeQueues":{"type":"array","description":"The list of queues to which this user is joined","readOnly":true,"items":{"$ref":"#/definitions/QueueReference"}},"activeQueuesModifiedTime":{"type":"string","format":"date-time","description":"Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"removedFromManagementUnit":{"type":"boolean","description":"For notification purposes. Used to indicate that a user was removed from the management unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserScheduleAdherenceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}},"downloadUrl":{"type":"string","description":"The downloadUrl if the response is too large to send directly via http response","readOnly":true}}},"AgentPossibleWorkShiftsResponse":{"type":"object","properties":{"weekStartDate":{"type":"string","format":"date","description":"Start date of requested effective work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"pattern":{"type":"array","description":"Each element is the ID of an effective work plan for a specific week","items":{"type":"integer","format":"int32"}},"weeklyPossibleWorkShifts":{"type":"array","description":"Each element is a weekly effective work plan that can be used for multiple weeks","items":{"$ref":"#/definitions/PossibleWorkShiftsForWeek"}},"schedulerIntervalLengthMinutes":{"type":"integer","format":"int32","description":"Number of minutes in each interval in the intervalScheduleProbabilities"},"timeZone":{"type":"string","description":"The time zone of the business unit"}}},"DailyPossibleShift":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"Day of the shift","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"earliestShiftStartMinutesFromMidnight":{"type":"integer","format":"int32","description":"Minutes of the earliest shift start from midnight. Note that midnight is 12:00 am in the time zone specified in the timeZone field (in the top level of the response)"},"required":{"type":"boolean","description":"Whether this is a required shift"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes of this daily shift"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes of this daily shift"},"intervalScheduleProbabilities":{"type":"array","description":"The percentage of being scheduled in each interval between the earliest shift start and latest shift end. Range of the values: [0, 100].","items":{"type":"integer","format":"int32"}}}},"PossibleWorkShiftsForWeek":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of this possible weekly shift"},"dailyPossibleShifts":{"type":"array","description":"Daily shifts in this possible weekly shift","items":{"$ref":"#/definitions/DailyPossibleShift"}}}},"AgentPossibleWorkShiftsRequest":{"type":"object","required":["weekCount","weekStartDate"],"properties":{"weekStartDate":{"type":"string","format":"date","description":"Start date of requested effective work plan, day of week will be in line with business unit start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"Number of weeks for which to return possible work shifts"}}},"BuAgentScheduleActivity":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for this activity"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"timeOffRequestSyncVersion":{"type":"integer","format":"int32","description":"The sync version of the partial day time off request for which the scheduled activity is associated, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["ActivityPlan","Coaching","Learning"]}}},"CalendarUrlResponse":{"type":"object","properties":{"calendarUrl":{"type":"string","description":"The calendar url for the user to subscribe with supported clients"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTimeOffRange":{"type":"object","properties":{"timeOffLimit":{"description":"The time off limit","$ref":"#/definitions/TimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"Granularity choice for time off limit","enum":["Daily"]},"availableMinutesPerInterval":{"type":"array","description":"The list of available time off values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"waitlistEnabled":{"type":"boolean","description":"Whether the time off request can be waitlisted"}}},"AvailableTimeOffResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/AvailableTimeOffRange"}}}},"AvailableTimeOffRequest":{"type":"object","required":["activityCodeId"],"properties":{"activityCodeId":{"type":"string","description":"The ID for activity code to query available time off minutes"},"dateRanges":{"type":"array","description":"A list of date ranges of available time off minutes. A maximum number of date ranges is 30. The maximum total number of days in all ranges is 366. If no ranges are specified, then only the presence of the associated time off limit object will be checked. In such case, if the association exists, then the response will contain a list with of a single element filled with timeOffLimitId only.","items":{"$ref":"#/definitions/LocalDateRange"}}}},"CreateAgentTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes"],"properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"durationMinutes":{"type":"array","description":"Daily durations for each day of this time off request in minutes","items":{"type":"integer","format":"int32"}},"payableMinutes":{"type":"array","description":"Payable minutes for each day of this time off request","items":{"type":"integer","format":"int32"}}}},"AgentTimeOffRequestPatch":{"type":"object","properties":{"markedAsRead":{"type":"boolean","description":"Whether this request has been read by the agent"},"status":{"type":"string","description":"The status of this time off request. Can only be canceled if the requested date has not already passed","enum":["CANCELED"]},"notes":{"type":"string","description":"Notes about the time off request. Can only be edited while the request is still pending"}}},"BuAgentSchedulePublishedScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks encompassed by the schedule"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuAgentScheduleSearchResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"BuAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shift"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"}}},"BuAgentScheduleUpdate":{"type":"object","properties":{"type":{"type":"string","description":"The type of update","enum":["Added","Edited","Deleted"]},"shiftStartDates":{"type":"array","description":"The start date for the affected shifts","items":{"type":"string","format":"date-time"}}}},"BuCurrentAgentScheduleSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}},"startDate":{"type":"string","format":"date-time","description":"The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"updates":{"type":"array","description":"The list of updates for the schedule. Only used in notifications","items":{"$ref":"#/definitions/BuAgentScheduleUpdate"}}}},"BuFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"payableMinutes":{"type":"integer","format":"int32","description":"Payable minutes for the time off marker"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"},"timeOffRequestSyncVersion":{"type":"integer","format":"int32","description":"The sync version of the full day time off request for which the scheduled activity is associated"}}},"BuGetCurrentAgentScheduleRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"UserSchedule":{"type":"object","required":["metadata"],"properties":{"shifts":{"type":"array","description":"The shifts that belong to this schedule","items":{"$ref":"#/definitions/UserScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Markers to indicate a full day time off request, relative to the management unit time zone","items":{"$ref":"#/definitions/UserScheduleFullDayTimeOffMarker"}},"delete":{"type":"boolean","description":"If marked true for updating an existing user schedule, it will be deleted"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"workPlanId":{"type":"string","description":"ID of the work plan associated with the user during schedule creation","readOnly":true}}},"UserScheduleActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this activity, in ISO-8601 format"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length in minutes for this activity"},"description":{"type":"string","description":"Description for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity is paid"},"isDstFallback":{"type":"boolean","description":"Whether this activity spans a DST fallback"},"timeOffRequestId":{"type":"string","description":"Time off request id of this activity"}}},"UserScheduleContainer":{"type":"object","properties":{"managementUnitTimeZone":{"type":"string","description":"The reference time zone used for the management unit"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/WeekScheduleReference"}},"userSchedules":{"type":"object","description":"Map of user id to user schedule","additionalProperties":{"$ref":"#/definitions/UserSchedule"}}}},"UserScheduleFullDayTimeOffMarker":{"type":"object","properties":{"managementUnitDate":{"type":"string","description":"The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format."},"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"isPaid":{"type":"boolean","description":"Whether this is paid time off"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this time off marker"},"description":{"type":"string","description":"The description associated with the time off request that this marker corresponds to"},"delete":{"type":"boolean","description":"If marked true for updating an existing full day time off marker, it will be deleted"}}},"UserScheduleShift":{"type":"object","properties":{"weekSchedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/WeekScheduleReference"},"id":{"type":"string","description":"ID of the schedule shift. This is only for the case of updating and deleting an existing shift"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"List of activities in this shift","items":{"$ref":"#/definitions/UserScheduleActivity"}},"delete":{"type":"boolean","description":"If marked true for updating this schedule shift, it will be deleted"},"manuallyEdited":{"type":"boolean","description":"Whether the shift was set as manually edited"}}},"WeekScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"}}},"CurrentUserScheduleRequestBody":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false"}}},"TimeOffIntegrationStatusResponse":{"type":"object","required":["integrationStatus","timeOffRequest"],"properties":{"timeOffRequest":{"description":"The time off request associated with this integration status","$ref":"#/definitions/TimeOffRequestReference"},"integrationStatus":{"type":"string","description":"The value of integration status for the time off request","enum":["Processing","Error","AutomaticallyComplete","ManuallyComplete"]}}},"TimeOffIntegrationStatusResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffIntegrationStatusResponse"}}}},"CurrentUserTimeOffIntegrationStatusRequest":{"type":"object","required":["timeOffRequestIds"],"properties":{"timeOffRequestIds":{"type":"array","description":"A list of time off request IDs","items":{"type":"string"}}}},"AdherenceExplanationNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"agent":{"description":"The agent for whom the adherence explanation applies","$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/ManagementUnitReference"},"businessUnit":{"description":"The business unit to which the agent belonged at the time the adherence explanation was submitted","$ref":"#/definitions/BusinessUnitReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the adherence explanation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the adherence explanation in minutes"},"status":{"type":"string","description":"The status of the adherence explanation","enum":["Pending","Approved","Denied"]},"type":{"type":"string","description":"The type of the adherence explanation","enum":["Late"]},"notes":{"type":"string","description":"Notes about the adherence explanation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftNotification":{"type":"object","required":["granularity","initiatingShiftDate","initiatingUser","weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start date of the schedule with which this trade is associated. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"granularity":{"type":"string","description":"The granularity of alternative shifts to be traded","enum":["Daily"]},"newState":{"type":"string","description":"The new state of the alternative shift trade, null if there was no change","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"initiatingUser":{"description":"The user who initiated the alternative shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving this alternative shift trade","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving alternative shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"ShiftTradeNotification":{"type":"object","properties":{"weekDate":{"type":"string","description":"The start date of the schedule with which this trade is associated"},"tradeId":{"type":"string","description":"The ID of the shift trade"},"oneSided":{"type":"boolean","description":"Whether this is a one sided shift trade"},"newState":{"type":"string","description":"The new state of the shift trade, null if there was no change","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"]},"initiatingUser":{"description":"The user who initiated the shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving side of this shift trade (null if not matched)","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TimeOffRequestNotification":{"type":"object","properties":{"timeOffRequestId":{"type":"string","description":"The ID of this time off request"},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}}}},"WfmUserNotification":{"type":"object","required":["id","markedAsRead","mutableGroupId"],"properties":{"id":{"type":"string","description":"The immutable globally unique identifier for the object."},"mutableGroupId":{"type":"string","description":"The group ID of the notification (mutable, may change on update)"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"type":"string","description":"The type of this notification","readOnly":true,"enum":["AdherenceExplanation","ShiftTrade","TimeOffRequest","AlternativeShift"]},"shiftTrade":{"description":"A shift trade notification. Only set if type == ShiftTrade","readOnly":true,"$ref":"#/definitions/ShiftTradeNotification"},"timeOffRequest":{"description":"A time off request notification. Only set if type == TimeOffRequest","readOnly":true,"$ref":"#/definitions/TimeOffRequestNotification"},"adherenceExplanation":{"description":"An adherence explanation notification. Only set if type == AdherenceExplanation","readOnly":true,"$ref":"#/definitions/AdherenceExplanationNotification"},"alternativeShift":{"description":"An alternative shift trade notification. Only set if type == AlternativeShift","readOnly":true,"$ref":"#/definitions/AlternativeShiftNotification"},"markedAsRead":{"type":"boolean","description":"Whether this notification has been marked \"read\""},"agentNotification":{"type":"boolean","description":"Whether this notification is for an agent","readOnly":true},"otherNotificationIdsInGroup":{"type":"array","description":"Other notification IDs in group. This field is only populated in real-time notifications","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"UpdateNotificationResponse":{"type":"object","properties":{"mutableGroupId":{"type":"string","description":"The mutableGroupId of the notification"},"id":{"type":"string","description":"The id of the notification for mapping the potentially new mutableGroupId"}}},"UpdateNotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateNotificationResponse"}}}},"UpdateNotificationsRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The notifications to update","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"HistoricalImportDeleteJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"status":{"type":"string","description":"Property denoting the status of the delete.","readOnly":true,"enum":["InProgress","Success","Failed"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HistoricalImportStatus":{"type":"object","properties":{"requestId":{"type":"string","description":"Request id of the historical import in the organization","readOnly":true},"dateImportEnded":{"type":"string","format":"date-time","description":"The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateImportStarted":{"type":"string","format":"date-time","description":"The first day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Status of the historical import in the organization.","readOnly":true,"enum":["Initiated","InProgress","Pending","Success","Failed","Cancelled","Purged","PurgePending"]},"error":{"type":"string","description":"Error occured if the status of the import is failed","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Date in which the historical import is initiated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date in which the historical import is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"active":{"type":"boolean","description":"Whether this historical import is active or not","readOnly":true},"type":{"type":"string","description":"Whether this historical import is of type csv or json","readOnly":true,"enum":["Csv","Json"]}}},"HistoricalImportStatusListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HistoricalImportStatus"}}}},"ValidationServiceRequest":{"type":"object","required":["dateImportEnded","uploadKey"],"properties":{"dateImportEnded":{"type":"string","format":"date-time","description":"The last day of the data you are importing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadKey":{"type":"string","description":"S3 key for the uploaded file"}}},"AgentIntegrationAssociationResponse":{"type":"object","required":["agentExternalId","integration","locked"],"properties":{"agentExternalId":{"type":"string","description":"ID of the agent in external system"},"integration":{"description":"The integration associated with the agent","$ref":"#/definitions/WfmIntegrationReference"},"locked":{"type":"boolean","description":"Whether agentExternalId should be protected from update by automatic processes"}}},"AgentIntegrationsResponse":{"type":"object","required":["agent","associatedIntegrations"],"properties":{"agent":{"description":"The user associated with the integrations","$ref":"#/definitions/UserReference"},"selectedIntegration":{"description":"The integration selected for the agent. If not set, no integration will be used for the agent","$ref":"#/definitions/WfmIntegrationReference"},"userSelected":{"type":"boolean","description":"Whether the integration association has been manually selected"},"associatedIntegrations":{"type":"array","description":"The list of integrations associated with the agent","items":{"$ref":"#/definitions/AgentIntegrationAssociationResponse"}}}},"AgentsIntegrationsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentIntegrationsResponse"}}}},"WfmIntegrationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryAgentsIntegrationsRequest":{"type":"object","required":["agentIds"],"properties":{"agentIds":{"type":"array","description":"The IDs of the agents to query associated integrations","uniqueItems":true,"items":{"type":"string"}}},"description":"Query integrations for agents request"},"AgentIntegrationAssociationRequest":{"type":"object","required":["agentExternalId","integrationId","locked"],"properties":{"agentExternalId":{"type":"string","description":"The ID of the agent in external system"},"integrationId":{"type":"string","description":"The ID of the integration associated with the agent"},"locked":{"type":"boolean","description":"Whether agentExternalId should be protected from update by automatic processes"}}},"AgentIntegrationsRequest":{"type":"object","required":["associatedIntegrations"],"properties":{"selectedIntegrationId":{"type":"string","description":"The ID of the integration selected for the agent. If not set, no integration will be used for the agent"},"associatedIntegrations":{"type":"array","description":"The list of integrations associated with the agent","items":{"$ref":"#/definitions/AgentIntegrationAssociationRequest"}}}},"HrisTimeOffTypeResponse":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"ID of the time off type configured in integration"},"name":{"type":"string","description":"Name of the time off type configured in integration"},"secondaryId":{"type":"string","description":"Secondary ID of the time off type, if configured in integration"}}},"HrisTimeOffTypesJobResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HrisTimeOffTypeResponse"}},"status":{"type":"string","description":"The status of the time off types job","enum":["Processing","Complete","Error"]}}},"WfmIntegrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmIntegrationResponse"}}}},"WfmIntegrationResponse":{"type":"object","required":["active"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether integration state is active"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HrisTimeOffTypesJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HrisTimeOffTypesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/HrisTimeOffTypesJobReference"},"entities":{"type":"array","description":"List of time off types. It is available only via notification","items":{"$ref":"#/definitions/HrisTimeOffTypeResponse"}}}},"ModelingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.'","readOnly":true,"enum":["ModelInputMissing","ModelInputInvalid","ModelFailed"]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"ModelingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the modeling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the modeling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/ModelingProcessingError"}},"modelingResultUri":{"type":"string","description":"The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'.","readOnly":true}}},"PerformancePredictionOutputs":{"type":"object","required":["calculationIntervalLengthMinutes","calculationStartDate","planningGroupResults"],"properties":{"calculationStartDate":{"type":"string","format":"date-time","description":"Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results"},"calculationIntervalLengthMinutes":{"type":"integer","format":"int32","description":"Interval length of the response metrics"},"planningGroupResults":{"type":"array","description":"List of planning group level performance prediction results","items":{"$ref":"#/definitions/PlanningGroupOutputs"}}}},"PerformancePredictionResponse":{"type":"object","required":["scheduleId","state","weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"scheduleId":{"type":"string","description":"The ID of the schedule this performance prediction is associated with"},"downloadUrl":{"type":"string","description":"The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete'"},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/PerformancePredictionOutputs"},"state":{"type":"string","description":"The state of the performance prediction","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PlanningGroupOutputs":{"type":"object","required":["abandonRatePerInterval","averageSpeedOfAnswerSecondsPerInterval","occupancyPerInterval","planningGroupId","serviceLevelPerInterval"],"properties":{"planningGroupId":{"type":"string","description":"The ID for for the associated planning group result"},"serviceLevelPerInterval":{"type":"array","description":"List of Service Level percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}},"occupancyPerInterval":{"type":"array","description":"List of Occupancy percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}},"averageSpeedOfAnswerSecondsPerInterval":{"type":"array","description":"List of Average Speed of Answer (in seconds) results per interval","items":{"type":"number","format":"double"}},"abandonRatePerInterval":{"type":"array","description":"List of Abandon rate percentage (0.0-100.0) results per interval","items":{"type":"number","format":"double"}}}},"AgentQueueTimeRequest":{"type":"object","required":["agentId","onQueueLengthMinutesPerInterval","startOffsetMinutes"],"properties":{"agentId":{"type":"string","description":"ID of the agent"},"startOffsetMinutes":{"type":"array","description":"List of offsets in minutes from calculationStartDate","items":{"type":"integer","format":"int32"}},"onQueueLengthMinutesPerInterval":{"type":"array","description":"List of on queue time lengths in minutes per interval of elements in startOffsetMinutes","items":{"type":"integer","format":"int32"}}}},"MuAgentQueueTimeRequest":{"type":"object","required":["agentOnQueueTimes","managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"ID of the management unit"},"agentOnQueueTimes":{"type":"array","description":"List of Agent queue times within the management unit","items":{"$ref":"#/definitions/AgentQueueTimeRequest"}}}},"PerformancePredictionRecalculationUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/PerformancePredictionUploadSchema"}}},"PerformancePredictionUploadSchema":{"type":"object","required":["calculationStartDate","onQueueTimes"],"properties":{"calculationStartDate":{"type":"string","format":"date-time","description":"Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results"},"onQueueTimes":{"type":"array","description":"List of agent on queue times by management unit","items":{"$ref":"#/definitions/MuAgentQueueTimeRequest"}}}},"PerformancePredictionRecalculationResponse":{"type":"object","required":["operationId","state"],"properties":{"operationId":{"type":"string","description":"The operationId for which to listen"},"downloadUrl":{"type":"string","description":"The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete'"},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/PerformancePredictionOutputs"},"state":{"type":"string","description":"The state of the performance prediction","enum":["Processing","Complete","Error"]}}},"BuScheduleRun":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"schedulerRunId":{"type":"string","description":"The scheduler run ID. Reference this value for support"},"intradayRescheduling":{"type":"boolean","description":"Whether this is an intraday rescheduling run"},"state":{"type":"string","description":"The state of the generation run","enum":["None","Queued","Scheduling","Canceled","Failed","Complete"]},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by the schedule"},"percentComplete":{"type":"number","format":"double","description":"Percent completion of the schedule run"},"targetWeek":{"type":"string","format":"date","description":"The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"The generated schedule. Null unless the schedule run is complete","$ref":"#/definitions/BuScheduleReference"},"scheduleDescription":{"type":"string","description":"The description of the generated schedule"},"schedulingStartTime":{"type":"string","format":"date-time","description":"When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schedulingStartedBy":{"description":"The user who started the scheduling run","$ref":"#/definitions/UserReference"},"schedulingCanceledBy":{"description":"The user who canceled the scheduling run, if applicable","$ref":"#/definitions/UserReference"},"schedulingCompletedTime":{"type":"string","format":"date-time","description":"When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messageSeverityCounts":{"type":"array","description":"The list of schedule generation message counts by severity for this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageSeverityCount"}},"reschedulingOptions":{"description":"Rescheduling options for this run. Null unless intradayRescheduling is true","$ref":"#/definitions/ReschedulingOptionsRunResponse"},"reschedulingResultExpiration":{"type":"string","format":"date-time","description":"When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleRunListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleRun"}}}},"ReschedulingManagementUnitResponse":{"type":"object","properties":{"managementUnit":{"description":"The management unit","$ref":"#/definitions/ManagementUnitReference"},"applied":{"type":"boolean","description":"Whether the rescheduling run is applied for the given management unit"}}},"ReschedulingOptionsRunResponse":{"type":"object","properties":{"existingSchedule":{"description":"The existing schedule to which this reschedule run applies","$ref":"#/definitions/BuScheduleReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnits":{"type":"array","description":"Per-management unit rescheduling options","items":{"$ref":"#/definitions/ReschedulingManagementUnitResponse"}},"agentCount":{"type":"integer","format":"int32","description":"The number of agents to be considered in the reschedule"},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes being considered for reschedule","uniqueItems":true,"items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Whether weekly paid time is allowed to be changed"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Whether daily paid time is allowed to be changed"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Whether shift start times are allowed to be changed"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Whether manually edited shifts are allowed to be changed"}}},"SchedulerMessageSeverityCount":{"type":"object","properties":{"severity":{"type":"string","description":"The schedule message severity","enum":["Ignore","Information","Warning","Error"]},"count":{"type":"integer","format":"int32","description":"The number of schedule messages with the given severity"}}},"BuAgentScheduleRescheduleResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"BuHeadcountForecast":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuPlanningGroupHeadcountForecast"}},"referenceStartDate":{"type":"string","format":"date-time","description":"Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuPlanningGroupHeadcountForecast":{"type":"object","properties":{"planningGroup":{"description":"The planning group to which this portion of the headcount forecast applies","$ref":"#/definitions/PlanningGroupReference"},"requiredPerInterval":{"type":"array","description":"Required headcount per interval, referenced against the reference start date","items":{"type":"number","format":"double"}},"requiredWithoutShrinkagePerInterval":{"type":"array","description":"Required headcount per interval without accounting for shrinkage, referenced against the reference start date","items":{"type":"number","format":"double"}}}},"BuRescheduleAgentScheduleResult":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this part of the result applies","$ref":"#/definitions/ManagementUnitReference"},"downloadResult":{"description":"The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/MuRescheduleResultWrapper"},"downloadUrl":{"type":"string","description":"The download URL from which to fetch the result"}}},"BuRescheduleResult":{"type":"object","properties":{"generationResults":{"description":"The generation results. Note the result will always be delivered via the generationResultsDownloadUrl; however the schema is included for documentation","$ref":"#/definitions/ScheduleGenerationResult"},"generationResultsDownloadUrl":{"type":"string","description":"The download URL from which to fetch the generation results for the rescheduling run"},"headcountForecast":{"description":"The headcount forecast. Note the result will always be delivered via the headcountForecastDownloadUrl; however the schema is included for documentation","$ref":"#/definitions/BuHeadcountForecast"},"headcountForecastDownloadUrl":{"type":"string","description":"The download URL from which to fetch the headcount forecast for the rescheduling run"},"agentSchedules":{"type":"array","description":"List of download links for agent schedules produced by the rescheduling run","items":{"$ref":"#/definitions/BuRescheduleAgentScheduleResult"}}}},"MuRescheduleResultWrapper":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The list of agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleRescheduleResponse"}}}},"PlanningGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleGenerationMessage":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDaysFromAgentHistory","UnableToScheduleMaxConsecutiveWorkingWeekendsFromAgentHistory","UnableToScheduleMaxWeeklyPaidTimeFromTimeOff","UnableToScheduleMaxWorkDayPaidTimeFromTimeOff","UnableToScheduleMinIntershiftTimeFromAgentHistory","UnableToScheduleMinIntershiftTimeFromDst","UnableToScheduleMinShiftStartDistanceFromAgentHistory","UnableToScheduleMinShiftStartDistanceFromDst","UnableToScheduleMinWeeklyPaidTimeFromTimeOff","UnableToScheduleMinWeeklyWorkDaysFromTimeOff","UnableToScheduleMinWorkDayPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMaxDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMaxDaysOffFromTimeOff","UnableToSchedulePlanningPeriodMaxPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMaxPaidTimeFromTimeOff","UnableToSchedulePlanningPeriodMinDaysOffFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromAgentHistory","UnableToSchedulePlanningPeriodMinPaidTimeFromTimeOff","UnableToScheduleWorkDayFromTimeOff","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"]},"arguments":{"type":"array","description":"The arguments describing the message","items":{"$ref":"#/definitions/SchedulerMessageArgument"}}}},"ScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The ID of the schedule generation run. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messages":{"type":"array","description":"User facing messages related to the schedule generation run","items":{"$ref":"#/definitions/ScheduleGenerationMessage"}},"messageSeverities":{"type":"array","description":"The list of messages by severity in this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageTypeSeverity"}}}},"SchedulerMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of this message parameter","enum":["AgentId","Date"]},"value":{"type":"string","description":"The value of this message parameter"}}},"PatchBuReschedulingOptionsManagementUnitRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The management unit portion of the rescheduling run to update"},"applied":{"type":"boolean","description":"Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied"}}},"PatchBuReschedulingOptionsRequest":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Per-management unit rescheduling options to update","items":{"$ref":"#/definitions/PatchBuReschedulingOptionsManagementUnitRequest"}}}},"PatchBuScheduleRunRequest":{"type":"object","properties":{"reschedulingOptions":{"description":"The rescheduling options to update","$ref":"#/definitions/PatchBuReschedulingOptionsRequest"}}},"BuAgentSchedulesSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}}}},"BuAsyncAgentSchedulesSearchResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesSearchResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuSearchAgentSchedulesRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userIds":{"type":"array","description":"IDs of the users for whose schedules to search","items":{"type":"string"}}}},"BuAsyncScheduleResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuManagementUnitScheduleSummary":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this summary applies","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents from this management unit that are in the schedule"},"startDate":{"type":"string","format":"date-time","description":"The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agents":{"type":"array","description":"The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}}}},"BuScheduleMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"managementUnits":{"type":"array","description":"High level per-management unit schedule metadata","items":{"$ref":"#/definitions/BuManagementUnitScheduleSummary"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleGenerationResultSummary":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The ID of the schedule generation run. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messageSeverityCounts":{"type":"array","description":"The list of schedule generation message counts by severity for this schedule generation run","items":{"$ref":"#/definitions/SchedulerMessageSeverityCount"}}}},"BuAsyncScheduleRunResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleRun"}}},"BuRescheduleRequest":{"type":"object","required":["doNotChangeDailyPaidTime","doNotChangeManuallyEditedShifts","doNotChangeShiftStartTimes","doNotChangeWeeklyPaidTime","managementUnitIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentIds":{"type":"array","description":"The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored","items":{"type":"string"}},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes","items":{"type":"string"}},"managementUnitIds":{"type":"array","description":"The IDs of the management units to reschedule","items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change weekly paid time"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change daily paid time"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change shift start times"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change manually edited shifts"}}},"SchedulingTestingOptionsRequest":{"type":"object","properties":{"fastScheduling":{"type":"boolean","description":"Whether to enable fast scheduling"},"delayScheduling":{"type":"boolean","description":"Whether to force delayed scheduling"},"failScheduling":{"type":"boolean","description":"Whether to force scheduling to fail"},"populateWarnings":{"type":"boolean","description":"Whether to populate warnings in the generated schedule"},"populateDeprecatedWarnings":{"type":"boolean","description":"Whether to populate deprecated warnings in the generated schedule"}}},"BuScheduleListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleListItem"}}}},"BuCreateBlankScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"BuImportAgentScheduleUploadSchema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of the user to whom this agent schedule applies"},"workPlanId":{"description":"The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek","$ref":"#/definitions/ValueWrapperString"},"workPlanIdsPerWeek":{"description":"The IDs of the work plans per week for this user. Mutually exclusive with workPlanId","$ref":"#/definitions/ListWrapperString"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Any full day time off markers that apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"ImportScheduleUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/ImportScheduleUploadSchema"}}},"ImportScheduleUploadSchema":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the imported schedule"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks the imported schedule will cover"},"published":{"type":"boolean","description":"Whether the imported schedule should be immediately published"},"shortTermForecast":{"description":"The short term forecast to associate with the imported schedule","$ref":"#/definitions/BuShortTermForecastReference"},"headcountForecast":{"description":"The headcount forecast to associate with the imported schedule","$ref":"#/definitions/BuHeadcountForecast"},"agentSchedules":{"type":"array","description":"Individual agent schedules","items":{"$ref":"#/definitions/BuImportAgentScheduleUploadSchema"}}}},"ListWrapperString":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"ScheduleUploadProcessingResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuGenerateScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"},"options":{"description":"Additional scheduling options","$ref":"#/definitions/SchedulingOptionsRequest"}}},"SchedulingNoForecastOptionsRequest":{"type":"object","properties":{"shiftLength":{"type":"string","description":"The shift length option to apply if no forecast is supplied","enum":["Shortest","Median","Longest","Random"]},"shiftStart":{"type":"string","description":"The shift start option to apply if no forecast is supplied","enum":["Earliest","Median","Latest","Random"]}}},"SchedulingOptionsRequest":{"type":"object","properties":{"noForecastOptions":{"description":"Schedule generation options to apply if no forecast is supplied","$ref":"#/definitions/SchedulingNoForecastOptionsRequest"}}},"BuCopyScheduleRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the new schedule"},"weekDate":{"type":"string","format":"date","description":"The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuHeadcountForecastResponse":{"type":"object","properties":{"result":{"description":"The headcount forecast, null when downloadUrl is provided","$ref":"#/definitions/BuHeadcountForecast"},"downloadUrl":{"type":"string","description":"Download URL. Null unless the response is too large to pass directly through the api"}}},"BuAgentScheduleQueryResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}},"metadata":{"description":"Versioned entity metadata for this agent schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAgentSchedulesQueryResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleQueryResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which these schedules apply"}}},"BuAsyncAgentSchedulesQueryResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesQueryResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuQueryAgentSchedulesRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"userIds":{"type":"array","description":"The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}},"teamIds":{"type":"array","description":"The teamIds to request. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit","uniqueItems":true,"items":{"type":"string"}}}},"BuAgentScheduleHistoryChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shifts":{"type":"array","description":"The list of changed shifts","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"The list of changed full day time off markers","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryChangeMetadata":{"type":"object","properties":{"dateModified":{"type":"string","format":"date-time","description":"The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user that made the schedule change","$ref":"#/definitions/UserReference"}}},"BuAgentScheduleHistoryDeletedChange":{"type":"object","properties":{"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"agentSchedule":{"type":"boolean","description":"Whether the entire agent schedule was deleted"}}},"BuAgentScheduleHistoryDroppedChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryResponse":{"type":"object","properties":{"priorPublishedSchedules":{"type":"array","description":"The list of previously published schedules","items":{"$ref":"#/definitions/BuScheduleReference"}},"basePublishedSchedule":{"description":"The originally published agent schedules","$ref":"#/definitions/BuAgentScheduleHistoryChange"},"droppedChanges":{"type":"array","description":"The changes dropped from the schedule history. This will happen if the schedule history is too large","items":{"$ref":"#/definitions/BuAgentScheduleHistoryDroppedChange"}},"changes":{"type":"array","description":"The list of changes for the schedule history","items":{"$ref":"#/definitions/BuAgentScheduleHistoryChange"}}}},"BuUpdateAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the shift"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"},"delete":{"type":"boolean","description":"Set to true to delete the shift from the agent's schedule"}}},"BuUpdateAgentScheduleUploadSchema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of the user to whom this agent schedule applies"},"workPlanId":{"description":"The ID of the work plan for this user. Mutually exclusive with workPlanIdsPerWeek","$ref":"#/definitions/ValueWrapperString"},"workPlanIdsPerWeek":{"description":"The IDs of the work plans per week for this user. Mutually exclusive with workPlanId","$ref":"#/definitions/ListWrapperString"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuUpdateAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Any full day time off markers that apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"metadata":{"description":"Version metadata for this agent schedule. Required if updating or deleting an existing agent schedule, otherwise should be omitted","$ref":"#/definitions/WfmVersionedEntityMetadata"},"delete":{"type":"boolean","description":"Whether to delete this agent's schedule. Defaults to false if not set"}}},"UpdateScheduleUploadResponse":{"type":"object","properties":{"uploadKey":{"type":"string","description":"The key to pass to the secondary request to start processing of the upload"},"url":{"type":"string","description":"The url to which to PUT the upload body"},"headers":{"type":"object","description":"Required headers for the PUT request to the url","additionalProperties":{"type":"string"}},"uploadBodySchema":{"description":"Always null. Defines the schema of the json body to be PUT to the url. The json body should be gzip encoded before uploading","$ref":"#/definitions/UpdateScheduleUploadSchema"}}},"UpdateScheduleUploadSchema":{"type":"object","required":["metadata"],"properties":{"description":{"type":"string","description":"The description to set for the schedule"},"published":{"type":"boolean","description":"Whether to publish the schedule. Note: a schedule cannot be un-published unless another schedule is published over it"},"shortTermForecast":{"description":"The short term forecast to associate with the schedule","$ref":"#/definitions/BuShortTermForecastReference"},"headcountForecast":{"description":"The headcount forecast to associate with the schedule","$ref":"#/definitions/BuHeadcountForecast"},"agentSchedules":{"type":"array","description":"Individual agent schedules","items":{"$ref":"#/definitions/BuUpdateAgentScheduleUploadSchema"}},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ProcessScheduleUpdateUploadRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"The uploadKey provided by the request to get an upload URL"},"teamIds":{"type":"array","description":"The list of teams to which the users being modified belong. Only required if the requesting user has conditional permission to wfm:schedule:edit","uniqueItems":true,"items":{"type":"string"}},"managementUnitIdsForAddedTeamUsers":{"type":"array","description":"The set of muIds to which agents belong if agents are being newly added to the schedule, if the requesting user has conditional permission to wfm:schedule:edit","uniqueItems":true,"items":{"type":"string"}}}},"UserListScheduleRequestBody":{"type":"object","required":["endDate","startDate","userIds"],"properties":{"userIds":{"type":"array","description":"The user ids for which to fetch schedules","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false"}}},"ScheduleGenerationWarning":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user in the warning"},"userNotLicensed":{"type":"boolean","description":"Whether the user does not have the appropriate license to be scheduled"},"unableToMeetMaxDays":{"type":"boolean","description":"Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan"},"unableToScheduleRequiredDays":{"type":"array","description":"Days indicated as required to work in agent work plan where no viable shift was found to schedule","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"unableToMeetMinPaidForTheWeek":{"type":"boolean","description":"Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan"},"unableToMeetMaxPaidForTheWeek":{"type":"boolean","description":"Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan"},"noNeedDays":{"type":"array","description":"Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"shiftsTooCloseTogether":{"type":"boolean","description":"Whether the schedule did not meet the minimum time between shifts defined in the agent work plan"}}},"ShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"The weekDate of the short term forecast in yyyy-MM-dd format"},"description":{"type":"string","description":"The description of the short term forecast"}}},"WeekScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation failed"},"runId":{"type":"string","description":"ID of the schedule run"},"agentWarnings":{"type":"array","description":"Warning messages from the schedule run. This will be available only when requesting information for a single week schedule","items":{"$ref":"#/definitions/ScheduleGenerationWarning"}},"agentWarningCount":{"type":"integer","format":"int32","description":"Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules"}}},"WeekScheduleListItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WeekScheduleListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekScheduleListItemResponse"}}}},"HeadcountForecast":{"type":"object","required":["required","requiredWithoutShrinkage"],"properties":{"required":{"type":"array","description":"Headcount information with shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}},"requiredWithoutShrinkage":{"type":"array","description":"Headcount information without shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}}}},"HeadcountInterval":{"type":"object","required":["interval","value"],"properties":{"interval":{"type":"string","format":"date-time","description":"The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule"},"value":{"type":"number","format":"double","description":"Headcount value for this interval"}}},"WeekSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"userSchedules":{"type":"object","description":"User schedules in the week","additionalProperties":{"$ref":"#/definitions/UserSchedule"}},"headcountForecast":{"description":"Headcount information for the week schedule","$ref":"#/definitions/HeadcountForecast"},"agentSchedulesVersion":{"type":"integer","format":"int32","description":"Version of agent schedules in the week schedule"}}},"WeekScheduleResponse":{"type":"object","properties":{"result":{"description":"The result of the request. The value will be null if response is large","$ref":"#/definitions/WeekSchedule"},"downloadUrl":{"type":"string","description":"The url to fetch the result for large responses. The value is null if result contains the data"}}},"SchedulingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.'","readOnly":true,"enum":["BadJson","NotFound","Fail"]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"SchedulingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the scheduling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the scheduling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/SchedulingProcessingError"}},"schedulingResultUri":{"type":"string","description":"The uri of the scheduling result. It has a value if the status is 'Success'.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"The percentage of the job that is complete.","readOnly":true}}},"HistoricalShrinkageActivityCategoryResponse":{"type":"object","properties":{"activityCategory":{"type":"string","description":"Activity category for which shrinkage data is provided","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"shrinkageForActivityCategory":{"description":"Aggregated shrinkage data for the activity category","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"},"shrinkageForActivityCodes":{"type":"array","description":"Shrinkage for the activity codes under this activity category","items":{"$ref":"#/definitions/HistoricalShrinkageActivityCodeResponse"}}}},"HistoricalShrinkageActivityCodeResponse":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code for which shrinkage data is provided"},"shrinkageForActivityCode":{"description":"Aggregated shrinkage data for the activity code","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"}}},"HistoricalShrinkageAggregateResponse":{"type":"object","properties":{"scheduledShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for scheduled activities"},"scheduledShrinkagePercent":{"type":"number","format":"double","description":"Aggregated shrinkage value in percent from 0.0 to 100.0 for scheduled activities"},"actualShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated actual value in seconds for scheduled activities"},"actualShrinkagePercent":{"type":"number","format":"double","description":"Aggregated actual value in percent from 0.0 to 100.0 for scheduled activities"},"paidShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for paid activities"},"unpaidShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for unpaid activities"},"plannedShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for planned activities"},"unplannedShrinkageSeconds":{"type":"integer","format":"int32","description":"Aggregated shrinkage value in seconds for unplanned activities"}}},"HistoricalShrinkageResult":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"totalScheduledDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for which agents in the management unit are scheduled"},"totalLoggedInDurationSeconds":{"type":"integer","format":"int32","description":"Total duration in seconds for which agents in the management unit are actually logged-in"},"aggregatedShrinkage":{"description":"Aggregated shrinkage data for all the activity categories","$ref":"#/definitions/HistoricalShrinkageAggregateResponse"},"shrinkageForActivityCategories":{"type":"array","description":"Shrinkage for activity categories","items":{"$ref":"#/definitions/HistoricalShrinkageActivityCategoryResponse"}},"businessUnitIds":{"type":"array","description":"List of all business units of all the agents in response","items":{"type":"string"}}}},"HistoricalShrinkageResultListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/HistoricalShrinkageResult"}}}},"WfmHistoricalShrinkageResponse":{"type":"object","properties":{"operationId":{"type":"string","description":"The operationId for which to listen"},"downloadUrls":{"type":"array","description":"The url list to GET the results of the Historical Shrinkage query. This field is populated only if query state is Complete","items":{"type":"string"}},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/HistoricalShrinkageResultListing"},"state":{"type":"string","description":"The state of the shrinkage query","enum":["Processing","Complete","Error"]}}},"WfmHistoricalShrinkageRequest":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. If it is not set, the business unit time zone will be used. The results will be returned as UTC timestamps regardless of the time zone input."},"granularity":{"type":"string","description":"Shrinkage aggregation interval granularity.","enum":["Daily","Weekly"]}}},"WfmHistoricalShrinkageTeamsRequest":{"type":"object","required":["startDate","timeZone"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone, in olson format, to use in defining days when computing shrinkage for requested granularity. The results will be returned as UTC timestamps regardless of the time zone input."},"granularity":{"type":"string","description":"Shrinkage aggregation interval granularity","enum":["Daily","Weekly"]}}},"TimeOffBalanceJobReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffBalanceResponse":{"type":"object","required":["activityCodeId","hrisTimeOffTypeId"],"properties":{"activityCodeId":{"type":"string","description":"The ID for activity code associated with time off balance"},"hrisTimeOffTypeId":{"type":"string","description":"The ID of the time off type configured in HRIS integration"},"hrisTimeOffTypeSecondaryId":{"type":"string","description":"The secondary ID of the time off type configured in HRIS integration"},"startDate":{"type":"string","format":"date","description":"The Start date of the requested date range. The end date is determined by the size of interval list. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"balanceMinutesPerDay":{"type":"array","description":"The list of available time off balance values in minutes for each day","items":{"type":"integer","format":"int32"}}}},"TimeOffBalancesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the query","$ref":"#/definitions/TimeOffBalanceJobReference"},"entities":{"type":"array","description":"The list of time off balances. May come via notification","items":{"$ref":"#/definitions/TimeOffBalanceResponse"}}}},"TimeOffBalanceRequest":{"type":"object","required":["activityCodeIds"],"properties":{"activityCodeIds":{"type":"array","description":"The set of activity code IDs for which to query available time off balances","uniqueItems":true,"items":{"type":"string"}},"dateRanges":{"type":"array","description":"The list of date ranges for which to query time off balance","items":{"$ref":"#/definitions/LocalDateRange"}}}},"TimeOffBalanceJobResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TimeOffBalanceResponse"}},"status":{"type":"string","description":"The status of the time off balance job","enum":["Processing","Complete","Error"]}}},"BuTimeOffLimitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitResponse"}}}},"BuTimeOffLimitResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"staffingGroup":{"description":"The staffing group to which this time-off limit is associated. If managementUnit is set, then the staffing group belongs to that management unit.Otherwise, if managementUnit is not set, it is a business unit level staffing group.At least one of managementUnit and staffingGroup must be set","$ref":"#/definitions/StaffingGroupReference"},"managementUnit":{"description":"The management unit to which this time-off limit is associated. If staffingGroup is set, then the limit is associated with that staffing group, which belongs to this management unit.At least one of managementUnit and staffingGroup must be set","$ref":"#/definitions/ManagementUnitReference"},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuCreateTimeOffLimitRequest":{"type":"object","properties":{"staffingGroupId":{"type":"string","description":"The ID of the staffing group to which this time-off limit is associated. It can be either management unit or business unit level staffing group. One of managementUnitId or staffingGroupId must be set. This must not be set if managementUnitId has value"},"managementUnitId":{"type":"string","description":"The ID of the management unit to which this time-off limit is associated. One of managementUnitId or staffingGroupId must be set. This must not be set if staffingGroupId has value"}}},"BuSetTimeOffLimitValuesRequest":{"type":"object","required":["metadata"],"properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitRange"}},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuTimeOffLimitRange":{"type":"object","required":["limitMinutesPerDay","startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the range. The end date is determined by the size of 'limitMinutesPerDay'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"limitMinutesPerDay":{"type":"array","description":"The list of time-off limit values in minutes per day. If 'null' is specified, then the day-specific value is cleared. Such a day will have a value of 0","items":{"type":"integer","format":"int32"}}}},"BuTimeOffLimitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuTimeOffLimitValueRange":{"type":"object","required":["allocatedMinutesPerInterval","granularity","limitMinutesPerInterval","metadata","startDate","timeOffLimit","waitlistedMinutesPerInterval","waitlistedRequestsPerInterval"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"timeOffLimit":{"description":"The ID of the time-off limit","$ref":"#/definitions/BuTimeOffLimitReference"},"startDate":{"type":"string","format":"date","description":"Start date of the requested date range, in ISO-8601 format. The end date is determined by the size of interval lists"},"granularity":{"type":"string","description":"Granularity choice for time-off limit","enum":["Daily"]},"limitMinutesPerInterval":{"type":"array","description":"A list of time-off limit values in minutes per granularity interval","items":{"type":"integer","format":"int32"}},"allocatedMinutesPerInterval":{"type":"array","description":"A list of allocated time-off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedMinutesPerInterval":{"type":"array","description":"A list of waitlisted time-off minutes per granularity interval","items":{"type":"integer","format":"int32"}},"waitlistedRequestsPerInterval":{"type":"array","description":"The current number of waitlisted time-off requests for every interval per granularity","items":{"type":"integer","format":"int32"}},"metadata":{"description":"Version metadata for the time-off limit","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuTimeOffLimitValuesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffLimitValueRange"}}}},"BuTimeOffPlanResponse":{"type":"object","required":["activityCodeIds","autoApprovalRule","countAgainstTimeOffLimits","daysBeforeStartToExpireFromWaitlist","enabled","metadata","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"type":"array","description":"The IDs of activity codes associated with this time-off plan","uniqueItems":true,"items":{"type":"string"}},"timeOffLimits":{"type":"array","description":"The IDs of time-off limits associated with this time-off plan","uniqueItems":true,"items":{"$ref":"#/definitions/BuTimeOffLimitReference"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/HrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan is currently being used by agents"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan counts against time-off limits"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/TimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management Unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/TimeOffPlanManagementUnitAssociation"},"metadata":{"description":"Version metadata for the time-off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Management units to which this time-off plan applies. This must not be set if staffingGroups is populated","uniqueItems":true,"items":{"$ref":"#/definitions/ManagementUnitReference"}},"staffingGroups":{"type":"array","description":"Staffing groups to which this time-off plan applies. This must not be set if managementUnits is populated","uniqueItems":true,"items":{"$ref":"#/definitions/StaffingGroupReference"}}}},"TimeOffPlanManagementUnitAssociation":{"type":"object","required":["managementUnit"],"properties":{"managementUnit":{"description":"Management unit to which this time-off plan belongs","$ref":"#/definitions/ManagementUnitReference"},"staffingGroups":{"type":"array","description":"Staffing groups to which this time-off plan applies. If not defined, the plan applies to the management unit","uniqueItems":true,"items":{"$ref":"#/definitions/StaffingGroupReference"}}}},"BuUpdateTimeOffPlanRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"description":"The IDs of activity codes to associate with this time-off plan","$ref":"#/definitions/SetWrapperString"},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/ValueWrapperHrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan should be used by agents"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan should count against time-off limits"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/UpdateTimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/UpdateTimeOffPlanManagementUnitAssociation"},"metadata":{"description":"Version metadata for this time-off plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdateTimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnitIds":{"description":"The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated","$ref":"#/definitions/SetWrapperString"},"staffingGroupIds":{"description":"The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated","$ref":"#/definitions/SetWrapperString"}}},"UpdateTimeOffPlanManagementUnitAssociation":{"type":"object","properties":{"staffingGroupIds":{"description":"The IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit","$ref":"#/definitions/SetWrapperString"}}},"BuTimeOffPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuTimeOffPlanResponse"}},"downloadUrl":{"type":"string","description":"URL from which to fetch results for requests with a large result set. If populated, the downloaded data will conform to the same schema as would normally be returned, excepting downloaded data will never itself contain a downloadUrl"}}},"BuCreateTimeOffPlanRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of this time-off plan"},"activityCodeIds":{"type":"array","description":"The IDs of activity codes to associate with this time-off plan","uniqueItems":true,"items":{"type":"string"}},"autoApprovalRule":{"type":"string","description":"Auto approval rule for this time-off plan. Default is Never","enum":["Never","Always","CheckLimits"]},"daysBeforeStartToExpireFromWaitlist":{"type":"integer","format":"int32","description":"The number of days before the time-off request start date for when the request will be expired from the waitlist. Default is 0"},"hrisTimeOffType":{"description":"Time-off type, if this time-off plan is associated with the integration","$ref":"#/definitions/HrisTimeOffType"},"enabled":{"type":"boolean","description":"Whether this time-off plan should be used by agents. Default is true"},"countAgainstTimeOffLimits":{"type":"boolean","description":"Whether this time-off plan should count against time-off limits. Default is false"},"businessUnitAssociation":{"description":"Business unit association, if the time-off plan belongs to a business unit. managementUnitAssociation must not be set if this is populated","$ref":"#/definitions/CreateTimeOffPlanBusinessUnitAssociation"},"managementUnitAssociation":{"description":"Management unit association, if the time-off plan belongs to a management unit. businessUnitAssociation must not be set if this is populated","$ref":"#/definitions/CreateTimeOffPlanManagementUnitAssociation"}}},"CreateTimeOffPlanBusinessUnitAssociation":{"type":"object","properties":{"managementUnitIds":{"type":"array","description":"The IDs of management units to which this time-off plan applies. This must not be set if staffingGroupIds is populated","uniqueItems":true,"items":{"type":"string"}},"staffingGroupIds":{"type":"array","description":"The IDs of staffing groups to which this time-off plan applies. This must not be set if managementUnitIds is populated","uniqueItems":true,"items":{"type":"string"}}}},"CreateTimeOffPlanManagementUnitAssociation":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to which this time-off plan belongs"},"staffingGroupIds":{"type":"array","description":"A IDs of staffing groups to which this time-off plan applies. If not defined, the plan is applied to the management unit","uniqueItems":true,"items":{"type":"string"}}}},"Workbin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Workbin name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"Workbin description"},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The id of the User who modified the Workbin.","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkbinQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workbin"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32","description":"Count of items returned by the query. Refer to the \"select\" request parameter for more information."}}},"WorkbinQueryRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorkbinQuerySort"}}},"WorkbinQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateModified","name"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"Attribute name."},"type":{"type":"string","description":"Attribute type.","enum":["String","Int"]},"operator":{"type":"string","description":"Filter operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH"]},"values":{"type":"array","description":"List of values to be used in the filter.","items":{"type":"string"}}}},"WorkbinUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Workbin name. Valid length between 3 and 256 characters."},"description":{"type":"string","description":"Workbin description. Maximum length of 4096 characters."}}},"WorkbinCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Workbin name. Valid length between 3 and 256 characters."},"description":{"type":"string","description":"Workbin description. Maximum length of 4096 characters."},"divisionId":{"type":"string","description":"The ID of the division the Workbin belongs to. Defaults to home division ID."}}},"AutoStatusTransitionDetail":{"type":"object","properties":{"nextStatus":{"description":"Next status of auto status transition.","$ref":"#/definitions/WorkitemStatusReference"},"dateOfTransition":{"type":"string","format":"date-time","description":"Date at which auto status transition occurs. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"errorDetails":{"description":"This property will be set if auto status transition is failed.","$ref":"#/definitions/TaskManagementErrorDetails"}}},"ExternalContactReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TaskManagementErrorDetails":{"type":"object","properties":{"code":{"type":"string","description":"System defined error code for the error."},"message":{"type":"string","description":"Error message."}}},"WorkbinReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Workitem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Workitem."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"type":{"description":"The Worktype of the Workitem.","$ref":"#/definitions/WorktypeReference"},"description":{"type":"string","description":"The description of the Workitem."},"language":{"description":"The language of the Workitem.","$ref":"#/definitions/LanguageReference"},"utilizationLabel":{"description":"The utilization label of the Workitem.","$ref":"#/definitions/WorkitemUtilizationLabelReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the workitem."},"ttl":{"type":"integer","format":"int32","description":"The time to live of the Workitem in seconds."},"status":{"description":"The current Status of the Workitem.","$ref":"#/definitions/WorkitemStatusReference"},"statusCategory":{"type":"string","description":"The Category of the current Status of the Workitem.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"dateStatusChanged":{"type":"string","format":"date-time","description":"The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateClosed":{"type":"string","format":"date-time","description":"The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workbin":{"description":"The Workbin that contains the Workitem.","$ref":"#/definitions/WorkbinReference"},"reporter":{"description":"The reporter of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"assignee":{"description":"The assignee of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"externalContact":{"description":"The external contact of the Workitem.","$ref":"#/definitions/ExternalContactReference"},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"modifiedBy":{"description":"The User who modified the Workitem.","$ref":"#/definitions/UserReference"},"queue":{"description":"The Workitems queue.","$ref":"#/definitions/WorkitemQueueReference"},"assignmentState":{"type":"string","description":"The assignment state of the workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"dateAssignmentStateChanged":{"type":"string","format":"date-time","description":"The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The duration in seconds before an alert will timeout."},"skills":{"type":"array","description":"The skills of the Workitem.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"preferredAgents":{"type":"array","description":"The preferred agents of the Workitem.","items":{"$ref":"#/definitions/UserReference"}},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"schema":{"description":"The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time.","$ref":"#/definitions/WorkitemSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the Workitem.","additionalProperties":{"type":"object"}},"autoStatusTransitionDetail":{"description":"Auto status transition details of Workitem.","$ref":"#/definitions/AutoStatusTransitionDetail"},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem.","items":{"$ref":"#/definitions/WorkitemScoredAgent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemQueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemSchema":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The version of the Workitem custom attribute schema."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/UserReference"},"score":{"type":"integer","format":"int32","description":"Agent's score for the workitem, from 0 - 100, higher being better"}}},"WorkitemStatusReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemUtilizationLabelReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorktypeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemCreate":{"type":"object","required":["name","typeId"],"properties":{"name":{"type":"string","description":"The name of the Workitem. Valid length between 3 and 256 characters."},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the Workitem. Maximum of 365 days."},"ttl":{"type":"integer","format":"int32","description":"The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."},"statusId":{"type":"string","description":"The ID of the Status of the Workitem."},"workbinId":{"type":"string","description":"The ID of Workbin that contains the Workitem."},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"description":{"type":"string","description":"The description of the Workitem. Maximum length of 4096 characters."},"typeId":{"type":"string","description":"The ID of the Worktype of the Workitem."},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the worktype of the workitem.","additionalProperties":{"type":"object"}},"queueId":{"type":"string","description":"The ID of the Workitems queue. Must be a valid UUID."},"assigneeId":{"type":"string","description":"The ID of the assignee of the Workitem. Must be a valid UUID."},"wrapupCode":{"type":"string","description":"The ID of the wrapup. Must be a valid UUID."},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents.","items":{"$ref":"#/definitions/WorkitemScoredAgentRequest"}},"languageId":{"type":"string","description":"The ID of language of the Workitem. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of utilization label of the Workitem. Must be a valid UUID."},"externalContactId":{"type":"string","description":"The ID of the external contact of the Workitem. Must be a valid UUID."},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"skillIds":{"type":"array","description":"The skill IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"The preferred agent IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}}}},"WorkitemScoredAgentRequest":{"type":"object","properties":{"id":{"type":"string","description":"An agents ID. Must be a valid UUID."},"score":{"type":"integer","format":"int32","description":"Agent's score for the workitem, from 0 - 100, higher being better"}}},"WorkitemQueryJobError":{"type":"object","properties":{"code":{"type":"string","description":"System defined error code for the error."},"message":{"type":"string","description":"Error message for the failed job."}}},"WorkitemQueryJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the query job","enum":["Queued","Running","Succeeded","Failed"]},"dateStarted":{"type":"string","format":"date-time","description":"The date the job was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateFinished":{"type":"string","format":"date-time","description":"The date the job finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"error":{"description":"The error associated with the query job, if the state is Failed","$ref":"#/definitions/WorkitemQueryJobError"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemQueryJobCreate":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"The total page size requested. Default 25","minimum":1,"maximum":200},"pageNumber":{"type":"integer","format":"int32","description":"The page number requested","minimum":1},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemQueryJobFilter"}},"expands":{"type":"array","description":"List of entity attributes to be expanded in the result.","items":{"type":"string","enum":["type","workbin","status","assignee","reporter","queue"]}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"sort":{"description":"Sort","$ref":"#/definitions/WorkitemQueryJobSort"}}},"WorkitemQueryJobFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Attribute name."},"operator":{"type":"string","description":"Filter operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH"]},"values":{"type":"array","description":"List of values to be used in the filter.","items":{"type":"string"}}}},"WorkitemQueryJobSort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting.","enum":["dateDue","priority"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemPagedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workitem"}},"pageSize":{"type":"integer","format":"int32","description":"The total page size requested"},"pageNumber":{"type":"integer","format":"int32","description":"The page number requested"}}},"WorkitemTerminate":{"type":"object","properties":{"statusId":{"type":"string","description":"The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status."}}},"WorkitemUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Workitem. Valid length between 3 and 256 characters."},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the Workitem. Maximum of 365 days."},"ttl":{"type":"integer","format":"int32","description":"The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."},"statusId":{"type":"string","description":"The ID of the Status of the Workitem."},"workbinId":{"type":"string","description":"The ID of Workbin that contains the Workitem."},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"description":{"type":"string","description":"The description of the Workitem. Maximum length of 4096 characters."},"dateClosed":{"type":"string","format":"date-time","description":"The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignmentState":{"type":"string","description":"The assignment state of the Workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"assignmentOperation":{"type":"string","description":"Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent.","enum":["AgentAssignmentAlerting","QueueAssignmentAlerting"]},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed.","additionalProperties":{"type":"object"}},"queueId":{"type":"string","description":"The ID of the Workitems queue. Must be a valid UUID."},"assigneeId":{"type":"string","description":"The ID of the assignee of the Workitem. If supplied it must be a valid UUID."},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents.","items":{"$ref":"#/definitions/WorkitemScoredAgentRequest"}},"externalContactId":{"type":"string","description":"The ID of the external contact of the Workitem. Must be a valid UUID."},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"skillIds":{"type":"array","description":"The skill IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of language of the Workitem. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of the utilization label of the Workitem. Must be a valid UUID."},"preferredAgentIds":{"type":"array","description":"The preferred agent IDs of the Workitem. Must be valid UUIDs.","items":{"type":"string"}}}},"WorkitemManualAssign":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"WorkitemReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemWrapup":{"type":"object","properties":{"workitem":{"description":"Workitem that the wrapup code has been added to.","$ref":"#/definitions/WorkitemReference"},"wrapupCode":{"description":"The wrapup code used in the workitem.","$ref":"#/definitions/WrapupIdReference"},"modifiedBy":{"description":"The user who added the wrapup code to the workitem.","$ref":"#/definitions/UserReference"},"user":{"description":"The user for whom wrapup code was added. This may be the same as modifiedBy.","$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem when the wrapup code was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"WrapupIdReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemWrapupUpdate":{"type":"object","required":["action","wrapupCode"],"properties":{"action":{"type":"string","description":"Action to be performed for the wrapup code.","enum":["Add","Remove"]},"wrapupCode":{"type":"string","description":"The wrapup code which will be added/removed."}}},"WorkitemWrapupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemWrapup"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"WorkitemStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"category":{"type":"string","description":"The Category of the Status.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"destinationStatuses":{"type":"array","description":"The Statuses the Status can transition to.","items":{"$ref":"#/definitions/WorkitemStatusReference"}},"description":{"type":"string","description":"The description of the Status."},"defaultDestinationStatus":{"description":"Default destination status to which this Status will transition to if auto status transition enabled.","$ref":"#/definitions/WorkitemStatusReference"},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition"},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"},"worktype":{"description":"The Worktype containing the Status.","$ref":"#/definitions/WorktypeReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemStatusUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Status. Valid length between 3 and 256 characters."},"destinationStatusIds":{"type":"array","description":"A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations.","items":{"type":"string"}},"description":{"type":"string","description":"The description of the Status. Maximum length of 4096 characters."},"defaultDestinationStatusId":{"type":"string","description":"Default destination status to which this Status will transition to if auto status transition enabled."},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"}}},"Worktype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Worktype."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The description of the Worktype."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultWorkbin":{"description":"The default Workbin for Workitems created from the Worktype.","$ref":"#/definitions/WorkbinReference"},"defaultStatus":{"description":"The default status for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemStatusReference"},"statuses":{"type":"array","description":"The list of possible statuses for Workitems created from the Worktype.","items":{"$ref":"#/definitions/WorkitemStatus"}},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultLanguage":{"description":"The default language for Workitems created from the Worktype.","$ref":"#/definitions/LanguageReference"},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype."},"modifiedBy":{"description":"The id of the User who modified the Worktype.","$ref":"#/definitions/UserReference"},"defaultQueue":{"description":"The default queue for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemQueueReference"},"defaultSkills":{"type":"array","description":"The default skills for Workitems created from the Worktype.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schema":{"description":"The schema defining the custom attributes for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemSchema"},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemStatusCreate":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the Status. Valid length between 3 and 256 characters."},"category":{"type":"string","description":"The Category of the Status.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"destinationStatusIds":{"type":"array","description":"A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations.","items":{"type":"string"}},"description":{"type":"string","description":"The description of the Status. Maximum length of 4096 characters."},"defaultDestinationStatusId":{"type":"string","description":"Default destination status to which this Status will transition to if auto status transition enabled."},"statusTransitionDelaySeconds":{"type":"integer","format":"int32","description":"Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."},"statusTransitionTime":{"type":"string","format":"local-time","description":"Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"}}},"WorkitemStatusListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemStatus"}},"selfUri":{"type":"string","format":"uri"}}},"WorktypeQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Worktype"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32","description":"Count of items returned by the query. Refer to the \"select\" request parameter for more information."}}},"WorktypeQueryRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorktypeQuerySort"}}},"WorktypeQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateModified","name"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorktypeUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Worktype. Valid length between 3 and 256 characters."},"defaultWorkbinId":{"type":"string","description":"The ID of the default Workbin for Workitems created from the Worktype."},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schemaId":{"type":"string","description":"The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100.","minimum":1,"maximum":100},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 4096 characters."},"defaultStatusId":{"type":"string","description":"The ID of the default status for Workitems created from the Worktype."},"schemaVersion":{"type":"integer","format":"int32","description":"The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."},"defaultLanguageId":{"type":"string","description":"The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."},"defaultSkillIds":{"type":"array","description":"The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs","items":{"type":"string"}},"defaultQueueId":{"type":"string","description":"The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."}}},"WorktypeCreate":{"type":"object","required":["defaultWorkbinId","name"],"properties":{"name":{"type":"string","description":"The name of the Worktype. Length between 3 and 256 characters."},"defaultWorkbinId":{"type":"string","description":"The ID of the default Workbin for Workitems created from the Worktype."},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schemaId":{"type":"string","description":"The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100.","minimum":1,"maximum":100},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 4096 characters."},"divisionId":{"type":"string","description":"The ID of the division the Worktype belongs to. Defaults to the default Workbin division ID. The Worktype must be in the same division as its default Workbin."},"disableDefaultStatusCreation":{"type":"boolean","description":"Set to true to disable default status creation. Default statuses are created with the Worktype by default"},"schemaVersion":{"type":"integer","format":"int32","description":"The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."},"defaultQueueId":{"type":"string","description":"The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."},"defaultLanguageId":{"type":"string","description":"The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."},"defaultSkillIds":{"type":"array","description":"The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs","items":{"type":"string"}}}},"ActionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["actionCategory","actionId","actionName","correlationId","errorType","integrationId","integrationName","responseStatus"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ActionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tTotalExecution"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ActionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ActionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ActionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"AgentCopilotAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"AgentCopilotAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AgentCopilotAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"AgentCopilotAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AgentCopilotAggregateDataContainer"}}}},"AgentCopilotAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/AgentCopilotAggregateQueryPredicate"}}}},"AgentCopilotAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/AgentCopilotAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/AgentCopilotAggregateQueryPredicate"}}}},"AgentCopilotAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["agentAssistantId","cannedResponseId","cannedResponseLibraryId","conversationId","engagementType","externalContactId","feedbackRating","knowledgeBaseDocumentId","knowledgeBaseDocumentVersionId","mediaType","messageId","queueId","scriptId","scriptPageId","searchId","state","suggestionId","suggestionType","triggerType","userId","utteranceId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"AgentCopilotAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","cannedResponseId","cannedResponseLibraryId","conversationId","engagementType","externalContactId","feedbackRating","knowledgeBaseDocumentId","knowledgeBaseDocumentVersionId","mediaType","messageId","queueId","scriptId","scriptPageId","searchId","state","suggestionId","suggestionType","triggerType","userId","utteranceId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AgentCopilotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nCannedResponseSuggestions","nDistinctSuggestions","nKnowledgeArticleSuggestions","nKnowledgeSearchSuggestions","nScriptSuggestions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/AgentCopilotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."}}},"AgentCopilotAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nCannedResponseSuggestions","nDistinctSuggestions","nKnowledgeArticleSuggestions","nKnowledgeSearchSuggestions","nScriptSuggestions"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AgentCopilotAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","cannedResponseId","cannedResponseLibraryId","conversationId","engagementType","externalContactId","feedbackRating","knowledgeBaseDocumentId","knowledgeBaseDocumentVersionId","mediaType","messageId","queueId","scriptId","scriptPageId","searchId","state","suggestionId","suggestionType","triggerType","userId","utteranceId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/AgentCopilotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nCannedResponseSuggestions","nDistinctSuggestions","nKnowledgeArticleSuggestions","nKnowledgeSearchSuggestions","nScriptSuggestions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/AgentCopilotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"BotAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["askActionId","askActionResult","askActionType","botFinalIntent","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","selfServed"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/BotAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBotSessionTurns","nBotSessions","oBotIntent","oBotSessionCollection","oBotSessionCollectionSelfServed","oBotSessionQuery","oBotSessionQuerySelfServed","oBotSessionTurn","oBotSlot","tBotDisconnect","tBotExit","tBotRecognitionFailure","tBotSession"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/BotAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"BotAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/BotAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"ConversationAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","errorCode","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nBotInteractions","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oMessageTurn","oServiceLevel","oServiceTarget","tAbandon","tAcd","tActiveCallback","tActiveCallbackComplete","tAcw","tAgentResponseTime","tAlert","tAnswered","tBarging","tCoaching","tCoachingComplete","tConnected","tContacting","tDialing","tFirstConnect","tFirstDial","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tMonitoringComplete","tNotResponding","tPark","tParkComplete","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ConversationAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"EvaluationAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"EvaluationAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeApplicable","assigneeId","calibrationId","contextId","conversationId","divisionId","evaluationContextId","evaluationId","evaluatorId","formId","queueId","released","rescored","teamId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["conversationStart","evaluationCreatedDate","evaluationReleaseDate","eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"FlowExecutionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["divisionId","flowId","flowObjectId","flowVersion"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowExecutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlowExecutions"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowExecutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"FlowExecutionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowExecutionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"FlowAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["activeRouting","activeSkillId","addressFrom","addressTo","agentAssistantId","agentBullseyeRing","agentOwned","agentRank","agentScore","ani","assignerId","authenticated","conversationId","conversationInitiator","convertedFrom","convertedTo","customerParticipation","deliveryStatus","destinationAddress","direction","disconnectType","divisionId","dnis","edgeId","eligibleAgentCount","endingLanguage","entryReason","entryType","errorCode","exitReason","extendedDeliveryStatus","externalContactId","externalMediaCount","externalOrganizationId","externalTag","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","knowledgeBaseId","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","recognitionFailureReason","remote","removedSkillId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","routingRing","routingRule","routingRuleType","scoredAgentId","selectedAgentId","selectedAgentRank","selfServed","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","videoPresent","waitingInteractionCount","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"FlowAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"JourneyAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["containsAllCondition","containsAnyCondition","endsWithCondition","equalCondition","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTargetId","journeyActionTemplateId","journeyBlockingActionMapId","journeyBlockingEmergencyScheduleGroupId","journeyBlockingReason","journeyBlockingScheduleGroupId","journeyDeviceCategory","journeyDeviceType","journeyFrequencyCapReason","journeyIpGeolocationCountry","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionId","journeySessionSegmentId","journeySessionType","notContainsAllCondition","notContainsAnyCondition","notEqualCondition","startsWithCondition","touchpointActionMapId","touchpointAgentId","touchpointAttributionScope","touchpointChannelMessageType","touchpointChannelPlatform","touchpointChannelType","touchpointConversationId","touchpointInteractionType","touchpointQueueId","touchpointRequestedRouting","touchpointUsedRouting","touchpointWrapupCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctJourneyActions","nDistinctJourneySessions","nJourneyActionsBlocked","nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsFrequencyCapReached","nWebActionsIgnored","nWebActionsOffered","nWebActionsOfferedOutsideSchedule","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","oJourneyOutcomeTouchpointValue","oJourneyOutcomeValue"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"JourneyAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"KnowledgeAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/KnowledgeAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"KnowledgeAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["agentAssistantId","appDeploymentId","appType","conversationChannelType","conversationId","documentEngagementType","externalContactId","feedbackCategory","feedbackId","feedbackRating","feedbackRatingType","feedbackRatingValue","feedbackReason","feedbackType","hasComment","hasSearch","knowledgeBaseDocumentId","knowledgeBaseDocumentVariationId","knowledgeBaseDocumentVersionId","knowledgeBaseId","languageCode","mediaType","presentedDocumentsCount","queryType","queueId","searchId","searchQuery","selfServed","sessionId","surfacingMethod","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/KnowledgeAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nDistinctKnowledgeSessions","nKnowledgeDocumentCopied","nKnowledgeDocumentFeedback","nKnowledgeDocumentPresented","nKnowledgeDocumentSurfaced","nKnowledgeDocumentViewed","nKnowledgeSearch","nKnowledgeSearchAnswered","nKnowledgeSearchFeedback","nKnowledgeSearchUnanswered","nKnowledgeSessions","oKnowledgeDocumentQuery","oKnowledgeDocumentQuerySelfServed","oKnowledgeSearch"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/KnowledgeAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"queryType":{"type":"string","description":"Query type to use. Use groupBy for all matching results, and topN for just top N results for the requested metric (group by exactly 1 dimension)","enum":["groupBy","topN"]},"limit":{"type":"integer","format":"int32","description":"How many results you want in the topN list. Only applicable for topN query type."},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"ResolutionAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ResolutionAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ResolutionAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"ResolutionAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionAggregateQueryPredicate"}}}},"ResolutionAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionAggregateQueryPredicate"}}}},"ResolutionAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["queueId","userId"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ResolutionAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nNextContactAvoided"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"ResolutionAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["queueId","userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ResolutionAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nNextContactAvoided"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ResolutionAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"SurveyAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPartialResponse","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","surveyType","teamId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyFullResponses","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyPartialResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","nVoiceSurveys","nWebSurveys","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"SurveyAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"TaskManagementAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TaskManagementAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TaskManagementAggregateDataContainer"}}}},"TaskManagementAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TaskManagementAggregateQueryPredicate"}}}},"TaskManagementAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TaskManagementAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TaskManagementAggregateQueryPredicate"}}}},"TaskManagementAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"],"x-genesys-entity-type":{"value":"DIMENSION_TYPE"}},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"]},"value":{"type":"string","description":"Right hand side for dimension predicates","x-genesys-entity-type":{"value":"DIMENSION_SELECTOR"}},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TaskManagementAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TaskManagementAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TaskManagementAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]}}},"TaskManagementAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"TaskManagementAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["assigneeId","divisionId","externalTag","queueId","reporterId","requestedLanguageId","requestedRouting","requestedRoutingSkillId","statusCategory","statusId","typeId","usedRouting","userId","workbinId","workitemId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TaskManagementAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nWorkitemsAcdCancelled","nWorkitemsAcdExpired","nWorkitemsAcdStarted","nWorkitemsAgentTransferred","nWorkitemsCreated","nWorkitemsDeclined","nWorkitemsDeleted","nWorkitemsDisconnected","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAlert","tWorkitemsAnswered","tWorkitemsDirectAnswered","tWorkitemsFocus","tWorkitemsFocusComplete","tWorkitemsHandled","tWorkitemsHeld","tWorkitemsHeldComplete","tWorkitemsNotResponding","tWorkitemsParked","tWorkitemsQueueAnswered","tWorkitemsStatus"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TaskManagementAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"TaskManagementAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TaskManagementAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"TranscriptAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId","wrapUpCode"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","oCustomerSentiment","oOverTalkSpeechInstances","oSentimentScore","tAgentSpeech","tCustomerSpeech","tOtherAudio","tOverTalkSpeech","tSilence","tTotalSpeechAndSilence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"TranscriptAsyncAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"UserAsyncAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}},"cursor":{"type":"string","description":"Cursor token to retrieve next page"}}},"UserAsyncAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"]},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"}}},"OneOnOne":{"type":"object","properties":{"pinnedMessages":{"type":"array","description":"Room's pinned messages","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"ConversationUtilizationLabelUpdate":{"type":"object","properties":{"utilizationLabelId":{"type":"string","description":"The utilization label associated with the conversation."}}},"MeetingIdRecord":{"type":"object","required":["ephemeral"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"ephemeral":{"type":"boolean","description":"Boolean flag for ephemeral status of the created record"},"conferenceId":{"type":"string","description":"The conferenceId used to generate a meetingId"},"dateExpired":{"type":"string","format":"date-time","description":"Instant at which the meetingId record will no longer be considered active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GenerateMeetingIdRequest":{"type":"object","required":["ephemeral"],"properties":{"conferenceId":{"type":"string","description":"The conferenceId for which to generate a meetingId"},"ephemeral":{"type":"boolean","description":"Boolean flag for ephemeral status of the created record"},"expireTimeDays":{"type":"integer","format":"int32","description":"Number of days the meetingId record will remain active"}}},"ParticipantInfo":{"type":"object","properties":{"activeParticipantCount":{"type":"integer","format":"int32","description":"The number of active participants in the video conference."},"version":{"type":"integer","format":"int32","description":"The version of the participant count."}}},"VideoConferenceDetails":{"type":"object","properties":{"conferenceId":{"type":"string","description":"The conferenceId."},"conversationId":{"type":"string","description":"The conversationId of the video conference."},"participantInfo":{"description":"Information about the participants of the video conference.","$ref":"#/definitions/ParticipantInfo"}}},"ExecutionDataFlowSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"whether or not the setting is enabled."},"modifiedBy":{"description":"User that last changed the setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this setting was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExecutionDataSettingsRequest":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"whether or not the setting is enabled."}}},"FlowCharacteristics":{"type":"object","properties":{"executionItems":{"type":"boolean","description":"Whether to report execution data about individual actions, menus, states, tasks, etc. etc. that ran during execution of the flow."},"executionInputOutputs":{"type":"boolean","description":"Whether to report input setting input setting values and output data values for individual execution items above. For example, if you have FlowExecutionInputOutputs and a Call Data Action ran in a flow, if FlowExecutionItems was enabled you'd see the fact a Call Data Action ran and the output path it took but nothing about which Data Action it ran, the input data sent to it at flow runtime and the data returned from it. If you enable this characteristic, execution data will contain this additional detail."},"communications":{"type":"boolean","description":"Communications are either audio or digital communications sent to or received from a participant. An example here would be the initial greeting in an inbound call flow where it plays a greeting message to the participant."},"eventError":{"type":"boolean","description":"Whether to report flow error events."},"eventWarning":{"type":"boolean","description":"Whether to report flow warning events."},"eventOther":{"type":"boolean","description":"Whether to report events other than errors or warnings such as a language change, loop event."},"variables":{"type":"boolean","description":"Whether to report assignment of values to variables in flow execution data. It's important to remember there is a difference between variable value assignments and output data from an action. If you have a Call Digital Bot flow action in an Inbound Message flow and there is no variable bound to the Exit Reason output but FlowExecutionInputOutputs is enabled, you will still be able to see the exit reason from the digital bot flow in execution data even though it is not bound to a variable."},"names":{"type":"boolean","description":"This characteristic specifies whether or not name information should be emitted in execution data such as action, task, state or even the flow name itself. Names are very handy from a readability standpoint but they do take up additional space in flow execution data instances."}},"description":"This is a set of enabled characteristics for the loglevel"},"FlowLogLevel":{"type":"object","properties":{"level":{"type":"string","description":"The logLevel for this characteristics set","enum":["Unknown","Disabled","Base","Notes","VerboseNotes","All"]},"characteristics":{"description":"Shows what characteristics are enabled for this log level","$ref":"#/definitions/FlowCharacteristics"}},"description":"This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)"},"FlowSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The Flow Type","enum":["bot","commonmodule","digitalbot","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","inqueueshortmessage","inqueueemail","outboundcall","securecall","surveyinvite","voice","voicemail","voicesurvey","workflow","workitem"]},"modifiedBy":{"description":"User that last changed the log level setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the log level setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this log level was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logLevelCharacteristics":{"description":"The log level set for this flow","$ref":"#/definitions/FlowLogLevel"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)"},"FlowLogLevelRequest":{"type":"object","required":["logLevelCharacteristics"],"properties":{"logLevelCharacteristics":{"description":"The log level characteristics currently set for this flow","$ref":"#/definitions/FlowLogLevel"}},"description":"Used to set the log level of a particular flow"},"FlowLogLevelCharacteristicsDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"minimumLevel":{"type":"string","description":"The minimum level required for this characteristic to be enabled.","readOnly":true,"enum":["Unknown","Disabled","Base","Notes","VerboseNotes","All"]},"dependsOn":{"description":"If set, this is the id of the characteristic that this one depends on and it must be enabled for this to be enabled.","readOnly":true,"$ref":"#/definitions/FlowCharacteristics"}},"description":"Defines a characteristic that can be captured by data providers"},"FlowLogLevelCharacteristicsDefinitions":{"type":"object","properties":{"logLevels":{"type":"array","description":"A list of flow log levels available to the organization.","readOnly":true,"items":{"$ref":"#/definitions/FlowLogLevel"}},"characteristics":{"type":"array","description":"A list of characteristics that the loglevels will have that are available to the organization..","readOnly":true,"items":{"$ref":"#/definitions/FlowLogLevelCharacteristicsDefinition"}}},"description":"A set of available characteristic definitions"},"FlowSettingsResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowSettingsResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Function":{"type":"object","required":["description","handler","runtime"],"properties":{"id":{"type":"string","description":"Function identifier.","readOnly":true},"name":{"type":"string","description":"Function name. This is automatically created based on the Action Id.","readOnly":true},"description":{"type":"string","description":"Description of the function. Limit 255 characters."},"dateCreated":{"type":"string","format":"date-time","description":"Date and time function was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"zipId":{"type":"string","description":"Zip file identifier.","readOnly":true},"handler":{"type":"string","description":"Handler entry point into zip file to execute function. Should be path within upload function package to the invocation module without language extension, followed by a period and then exported invocation method name. e.g. 'src/index.handler'"},"runtime":{"type":"string","description":"Runtime required for execution. Valid runtimes change over time as versions are deprecated. Use /api/v2/integrations/actions/functions/runtimes for current list."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Execution timeout to apply to function. Value is in seconds. Range allowed 1 to 60. Default value 15 seconds."}},"description":"Action function settings."},"FunctionConfig":{"type":"object","properties":{"id":{"type":"string","description":"Action identifier.","readOnly":true},"function":{"description":"Function configuration.","readOnly":true,"$ref":"#/definitions/Function"},"zip":{"description":"Zip file configuration and state.","readOnly":true,"$ref":"#/definitions/FunctionZipConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Current action function configuration and zip upload configuration."},"FunctionZipConfig":{"type":"object","properties":{"status":{"type":"string","description":"Status of zip upload.","enum":["Pending","Transferring","Available","Unknown"]},"id":{"type":"string","description":"Zip file Identifier"},"name":{"type":"string","description":"Zip file name"},"dateCreated":{"type":"string","format":"date-time","description":"Date and time zip record was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"Action function current zip file upload settings and state."},"FunctionUploadResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"Upload time to live in seconds."}},"description":"Action function create upload URL response."},"FunctionUploadRequest":{"type":"object","required":["fileName"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload.File name can only contain letters, numbers, and the following special characters: + - _ . ' ( )","pattern":"^[a-zA-Z0-9\\.\\+\\-\\_\\(\\)\\s]+$"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 900 seconds","minimum":1,"maximum":604800}},"description":"Action function URL upload input."},"FunctionRuntime":{"type":"object","properties":{"name":{"type":"string","description":"Name of the function runtime.","readOnly":true},"description":{"type":"string","description":"Description of function runtime.","readOnly":true},"status":{"type":"string","description":"Availability status of runtime","readOnly":true,"enum":["Available","Deprecated","Unavailable"]},"dateEndOfLife":{"type":"string","format":"date","description":"Optional end of life date. Present if the status is Deprecated. Date represents when support for runtime can no longer be guaranteed. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","readOnly":true}},"description":"Action function runtime."},"ChatUserSettings":{"type":"object","required":["mobile"],"properties":{"mobile":{"description":"Settings for mobile devices","$ref":"#/definitions/MobileSettings"}},"description":"Settings for a chat user"},"MobileNotificationSettings":{"type":"object","required":["when"],"properties":{"when":{"type":"string","description":"When the user should receive notifications","enum":["Always","OnlyWhenInactive"]}},"description":"Settings for a user's mobile notifications"},"MobileSettings":{"type":"object","required":["notifications"],"properties":{"notifications":{"description":"Settings for a user's mobile notifications","$ref":"#/definitions/MobileNotificationSettings"}},"description":"Settings for mobile devices"},"ActionEventActionMap":{"type":"object","required":["displayName","id","version"],"properties":{"id":{"type":"string","description":"The ID of the action map."},"selfUri":{"type":"string","format":"uri"},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"displayName":{"type":"string","description":"Display name of the action map."}}},"AppEvent":{"type":"object","required":["app","attributes","device","eventName","screenName","traits"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. screen_viewed, order_completed, user_registered)."},"screenName":{"type":"string","description":"The name of the screen in the app that the event took place."},"app":{"description":"Application that the customer is interacting with.","$ref":"#/definitions/JourneyApp"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"ipAddress":{"type":"string","description":"Customer's IP address. May be null if the business configures the tracker to not collect IP addresses."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"sdkLibrary":{"description":"SDK library used to generate the event.","$ref":"#/definitions/SdkLibrary"},"networkConnectivity":{"description":"Information relating to the device's network connectivity.","$ref":"#/definitions/NetworkConnectivity"},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"Traits are attributes intrinsic to the customer that may be sent in selected events. Examples are email, name, phone.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}}}},"Event":{"type":"object","required":["correlationId","createdDate","eventType","id","session"],"properties":{"id":{"type":"string","description":"System-generated UUID for the event."},"correlationId":{"type":"string","description":"UUID corresponding to triggering action that caused this event (e.g. HTTP POST, SIP invite, another event)."},"customerId":{"type":"string","description":"Primary identifier of the customer in the source of the events."},"customerIdType":{"type":"string","description":"Type of primary identifier (e.g. cookie, email, phone)."},"session":{"description":"The session that the event belongs to.","$ref":"#/definitions/EventSession"},"eventType":{"type":"string","description":"The name representing the type of event."},"outcomeAchievedEvent":{"description":"Event where a customer has achieved a specific outcome or goal.","$ref":"#/definitions/OutcomeAchievedEvent"},"segmentAssignmentEvent":{"description":"Event that represents a segment being assigned.","$ref":"#/definitions/SegmentAssignmentEvent"},"webActionEvent":{"description":"Event triggered by web actions.","$ref":"#/definitions/WebActionEvent"},"webEvent":{"description":"Event that tracks user interactions with content in a browser such as pageviews, downloads, mobile ad clicks, etc.","$ref":"#/definitions/WebEvent"},"appEvent":{"description":"Event that tracks user interactions with content in an application such as screen views, searches, etc.","$ref":"#/definitions/AppEvent"},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the event actually took place. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EventAction":{"type":"object","required":["createdDate","id","mediaType","prompt","state"],"properties":{"id":{"type":"string","description":"ID of the action."},"state":{"type":"string","description":"Current state of the action (e.g. qualified, succeeded, errored).","enum":["accepted","rejected","timedout","errored","ignored","qualified","offered","started","engaged","qualifiedOutsideSchedule","offeredOutsideSchedule","abandoned","completed","frequencyCapReached"]},"mediaType":{"type":"string","description":"The media type used to deliver the action (e.g. email, webhook).","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow","openAction"]},"prompt":{"type":"string","description":"Prompt of the action to be displayed/sent to the visitor."},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"EventListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Event"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"EventSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The ID of the session."},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","description":"Session types indicate the type or category of sessions (e.g. web, app)."}}},"OutcomeAchievedEvent":{"type":"object","required":["outcome"],"properties":{"outcome":{"description":"The outcome achieved.","$ref":"#/definitions/OutcomeAchievedEventOutcome"},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Visitor's IP address."},"ipOrganization":{"type":"string","description":"Visitor's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"visitReferrer":{"description":"Visit's referrer.","$ref":"#/definitions/Referrer"},"visitCreatedDate":{"type":"string","format":"date-time","description":"When visit was created (e.g. timestamp of the first event in visit). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAchievedEventOutcome":{"type":"object","required":["displayName","id","version"],"properties":{"id":{"type":"string","description":"ID of the outcome."},"selfUri":{"type":"string","format":"uri"},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."}}},"SegmentAssignmentEvent":{"type":"object","required":["segment"],"properties":{"segment":{"description":"The segment which was assigned.","$ref":"#/definitions/AddressableEntityRef"}}},"WebActionEvent":{"type":"object","required":["action","actionMap","actionTarget","browser","device","userAgentString"],"properties":{"action":{"description":"The action that triggered the event.","$ref":"#/definitions/EventAction"},"actionMap":{"description":"The action map that triggered the action.","$ref":"#/definitions/ActionEventActionMap"},"actionTarget":{"description":"The target for engagement actions.","$ref":"#/definitions/AddressableEntityRef"},"timeToDisposition":{"type":"integer","format":"int64","description":"Milliseconds elapsed until the action is disposed."},"errorCode":{"type":"string","description":"Code of the error returned when the action fails."},"errorMessage":{"type":"string","description":"Message of the error returned when the action fails."},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Visitor's IP address."},"ipOrganization":{"type":"string","description":"Visitor's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"visitReferrer":{"description":"Visit's referrer.","$ref":"#/definitions/Referrer"}}},"WebEvent":{"type":"object","required":["attributes","authenticated","browser","device","eventName","page","totalEventCount","totalPageviewCount","traits","userAgentString"],"properties":{"eventName":{"type":"string","description":"Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered)."},"totalEventCount":{"type":"integer","format":"int32","description":"The total count of events performed by the customer across all sessions."},"totalPageviewCount":{"type":"integer","format":"int32","description":"The total count of pageviews performed by the customer across all sessions."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/JourneyPage"},"userAgentString":{"type":"string","description":"HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/Browser"},"device":{"description":"Customer's device.","$ref":"#/definitions/Device"},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"ipAddress":{"type":"string","description":"Customer's IP address. May be null if the business configures the tracker to not collect IP addresses."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"mktCampaign":{"description":"Marketing / traffic source information.","$ref":"#/definitions/JourneyCampaign"},"referrer":{"description":"Identifies the page URL that originally generated the request for the current page being viewed.","$ref":"#/definitions/Referrer"},"attributes":{"type":"object","description":"User-defined attributes associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"traits":{"type":"object","description":"User-defined traits associated with a particular event.","additionalProperties":{"$ref":"#/definitions/CustomEventAttribute"}},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"authenticated":{"type":"boolean","description":"Indicates whether the event was produced during an authenticated session."}}},"OutcomeAttributionAsyncResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutcomeAttributionListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomeAttributionRequest"}},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."}}},"OutcomeAttributionRequest":{"type":"object","required":["associatedValue","createdDate","outcomeId","touchpoints"],"properties":{"outcomeId":{"type":"string","description":"ID of Outcome."},"externalContactId":{"type":"string","description":"The external contact ID of the customer who achieved the outcome."},"associatedValue":{"type":"number","description":"The total value associated with the customer's outcome."},"touchpoints":{"type":"array","description":"List of interactions that led to this outcome being achieved.","items":{"$ref":"#/definitions/Touchpoint"}},"createdDate":{"type":"string","format":"date-time","description":"Date outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Touchpoint":{"type":"object","required":["agentId","associatedValue"],"properties":{"conversationId":{"type":"string","description":"ID of conversation."},"agentId":{"type":"string","description":"ID of agent."},"associatedValue":{"type":"number","description":"The value attributed to this touchpoint."},"mediaType":{"type":"string","description":"Media Type of the touchpoint; allowed values are Email, Message and Voice.","enum":["Email","Message","Voice"]},"createdDate":{"type":"string","format":"date-time","description":"Date conversation happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAttributionJobStateResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"State of job.","enum":["Running","Completed","CompletedWithErrors","Failed"]},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved. Populated when job has reached a terminal state, i.e. no longer Running."},"percentFailedThreshold":{"type":"integer","format":"int32","description":"Optional percent failed threshold for validation errors; if reached will halt the job. Default is 5 percent, allowed values 0 to 100."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutcomeAttributionResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutcomeAttributionResultsResponse"}}}},"OutcomeAttributionResultsResponse":{"type":"object","required":["message","state"],"properties":{"outcomeId":{"type":"string","description":"ID of Outcome."},"index":{"type":"integer","format":"int32","description":"The index/position of the OutcomeAttribution in the original POST request."},"externalContactId":{"type":"string","description":"The external contact ID of the customer who achieved the outcome."},"associatedValue":{"type":"number","description":"The total value associated with the customer's outcome."},"state":{"type":"string","description":"State of the Outcome Attribution entity.","enum":["Completed","Valid","Invalid","Failed"]},"message":{"type":"string","description":"Additional information on the state of the Outcome Attribution entity."},"touchpoints":{"type":"array","description":"List of interactions that led to this outcome being achieved.","items":{"$ref":"#/definitions/TouchpointResponse"}},"createdDate":{"type":"string","format":"date-time","description":"Date outcome was achieved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TouchpointResponse":{"type":"object","required":["agentId","associatedValue","state"],"properties":{"conversationId":{"type":"string","description":"ID of conversation."},"agentId":{"type":"string","description":"ID of agent."},"associatedValue":{"type":"number","description":"The value attributed to this touchpoint."},"mediaType":{"type":"string","description":"Media Type of the touchpoint; allowed values are Email, Message and Voice.","enum":["Email","Message","Voice"]},"state":{"type":"string","description":"Outcome Attribution Touchpoint status.","enum":["Completed","Valid","Invalid","Failed"]},"message":{"type":"string","description":"Additional information on the state of the touchpoint entity, populated when the touchpoint has an error."},"createdDate":{"type":"string","format":"date-time","description":"Date conversation happened. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"JourneyView":{"type":"object","required":["elements"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the journey view"},"version":{"type":"integer","format":"int32","description":"The version of the journey view","readOnly":true},"createdBy":{"description":"User that has created the view.","readOnly":true,"$ref":"#/definitions/JourneyViewUser"},"modifiedBy":{"description":"User that has modified the view.","readOnly":true,"$ref":"#/definitions/JourneyViewUser"},"interval":{"type":"string","description":"An absolute timeframe for the journey view, expressed as an ISO 8601 interval. Only one of interval or duration must be specified. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"duration":{"type":"string","description":"A relative timeframe for the journey view, expressed as an ISO 8601 duration. Only one of interval or duration must be specified. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"elements":{"type":"array","description":"The elements within the journey view","items":{"$ref":"#/definitions/JourneyViewElement"}},"dateCreated":{"type":"string","format":"date-time","description":"The date when the journey view was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when this version of the journey view was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A journey view"},"JourneyViewChart":{"type":"object","required":["metrics"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The version of the journey view chart","readOnly":true},"groupByTime":{"type":"string","description":"A time unit to group the metrics by. There is a limit on the number of groupBy properties which can be specified.","enum":["Day","Week","Month","Year"]},"groupByAttributes":{"type":"array","description":"A list of attributes to group the metrics by. There is a limit on the number of groupBy properties which can be specified.","items":{"$ref":"#/definitions/JourneyViewChartGroupByAttribute"}},"metrics":{"type":"array","description":"A list of metrics to calculate within the chart by (aka the y axis)","items":{"$ref":"#/definitions/JourneyViewChartMetric"}},"displayAttributes":{"description":"Optional display attributes for rendering the chart","$ref":"#/definitions/JourneyViewChartDisplayAttributes"},"groupByMax":{"type":"integer","format":"int32","description":"A maximum on the number of values being grouped by"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A chart within the context of the elements of the the journey view"},"JourneyViewChartDisplayAttributes":{"type":"object","properties":{"type":{"type":"string","description":"The type of chart to display","enum":["Column","Bar","Line"]},"groupByTitle":{"type":"string","description":"A title for the grouped by attributes (aka the x axis)"},"metricsTitle":{"type":"string","description":"A title for the metrics (aka the y axis)"},"showLegend":{"type":"boolean","description":"Whether to show a legend"}},"description":"Display attributes for the chart, such as type, labels and legends"},"JourneyViewChartGroupByAttribute":{"type":"object","required":["attribute","elementId"],"properties":{"elementId":{"type":"string","description":"The element in the list of elements which is being grouped by"},"attribute":{"type":"string","description":"The attribute of the element being grouped by"}},"description":"A journey element attribute to group by within the chart"},"JourneyViewChartMetric":{"type":"object","required":["elementId","id"],"properties":{"id":{"type":"string","description":"The unique identifier of the metric within the chart"},"elementId":{"type":"string","description":"The element in the list of elements which the metric is measuring"},"aggregate":{"type":"string","description":"How to aggregate the given element, defaults to EventCount","enum":["EventCount","CustomerCount"]},"displayLabel":{"type":"string","description":"A display label for the metric"}},"description":"A metric to measure within the chart"},"JourneyViewElement":{"type":"object","required":["attributes","id","name"],"properties":{"id":{"type":"string","description":"The unique identifier of the element within the elements list"},"name":{"type":"string","description":"The unique name of the element within the view"},"attributes":{"description":"Required attributes of the element","$ref":"#/definitions/JourneyViewElementAttributes"},"filter":{"description":"Any filters applied to this element","$ref":"#/definitions/JourneyViewElementFilter"},"followedBy":{"type":"array","description":"A list of JourneyViewLink objects, listing the elements downstream of this element","items":{"$ref":"#/definitions/JourneyViewLink"}}},"description":"An element within a journey view"},"JourneyViewElementAttributes":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the element (e.g. Event)","enum":["Event"]},"id":{"type":"string","description":"The identifier for the element based on its type"},"source":{"type":"string","description":"The source for the element (e.g. IVR, Voice, Chat). Used for informational purposes only"}},"description":"Attributes on an element in a journey view"},"JourneyViewElementFilter":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses. Valid values: And","enum":["And"]},"predicates":{"type":"array","description":"predicates","items":{"$ref":"#/definitions/JourneyViewElementFilterPredicate"}}},"description":"A set of filters on an element within a journey view"},"JourneyViewElementFilterPredicate":{"type":"object","required":["dimension","values"],"properties":{"dimension":{"type":"string","description":"the element's attribute being filtered on"},"values":{"type":"array","description":"the values of the attribute to filter on","items":{"type":"string"}},"operator":{"type":"string","description":"Optional operator, default is Matches. Valid values: Matches","enum":["Matches","NotMatches"]},"noValue":{"type":"boolean","description":"set this to true if no specific value to be considered"}},"description":"A filter on an element within a journey view"},"JourneyViewLink":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the element downstream"},"constraintWithin":{"description":"A time constraint on this link, which requires a customer to complete the downstream element within this amount of time to be counted.","$ref":"#/definitions/JourneyViewLinkTimeConstraint"},"constraintAfter":{"description":"A time constraint on this link, which requires a customer must complete the downstream element after this amount of time to be counted.","$ref":"#/definitions/JourneyViewLinkTimeConstraint"},"eventCountType":{"type":"string","description":"The type of events that will be counted. Note: Concurrent will override any JourneyViewLinkTimeConstraint. Default is Sequential.","enum":["All","Concurrent","Sequential"]},"joinAttributes":{"type":"array","description":"Other (secondary) attributes on which this link should join the customers being counted","items":{"type":"string"}}},"description":"A link between elements in a journey view"},"JourneyViewLinkTimeConstraint":{"type":"object","properties":{"unit":{"type":"string","description":"The unit for the link's time constraint","enum":["Seconds","Minutes","Hours","Days","Weeks","Months"]},"value":{"type":"integer","format":"int32","description":"The value for the link's time constraint"}}},"JourneyViewUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"emailAddress":{"type":"string","description":"Email address of the user","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyViewListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyView"}},"selfUri":{"type":"string","format":"uri"}}},"Label":{"type":"object","required":["encoded","name","value"],"properties":{"name":{"type":"string","description":"Name of the label"},"value":{"type":"string","description":"Value of the label"},"encoded":{"type":"boolean","description":"Whether the label is encoded or not","readOnly":true}}},"JourneyEventDefinition":{"type":"object","required":["description","jsonSchema","name","source"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the event definition","readOnly":true},"source":{"type":"string","description":"The source of the event definition","readOnly":true,"enum":["Native","Custom"]},"description":{"type":"string","description":"The description of this event definition","readOnly":true},"jsonSchema":{"description":"The JSON schema of this event definition","readOnly":true,"$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An event definition used when creating journey views"},"JourneyEventDefinitionListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyEventDefinition"}},"selfUri":{"type":"string","format":"uri"}}},"JourneyViewJob":{"type":"object","required":["dateCompleted","dateCreated","journeyView","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp of execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp of completion. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the job","enum":["Accepted","Executing","Complete","Failed"]},"journeyView":{"description":"The journey view for which the job is executed","$ref":"#/definitions/JourneyView"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupByAttribute":{"type":"object","properties":{"attribute":{"type":"string","description":"Group by attribute","readOnly":true},"value":{"type":"string","description":"Value of this group by attribute","readOnly":true}}},"JourneyViewChartMetricResult":{"type":"object","properties":{"id":{"type":"string","description":"Id of the metric","readOnly":true},"values":{"type":"array","description":"Metric result values","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewChartMetricResultValue"}}}},"JourneyViewChartMetricResultValue":{"type":"object","properties":{"value":{"type":"integer","format":"int32","description":"Value for this metric","readOnly":true},"groupByAttributes":{"type":"array","description":"Group by attributes for this metric","readOnly":true,"items":{"$ref":"#/definitions/GroupByAttribute"}}}},"JourneyViewChartResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"Version of the chart","readOnly":true},"metrics":{"type":"array","description":"Metric results for this chart","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewChartMetricResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyViewResult":{"type":"object","properties":{"elements":{"type":"array","description":"The elements within the journey view result","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewResultElement"}}},"description":"A journey view result"},"JourneyViewResultElement":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"metrics":{"description":"the metrics of the current element","readOnly":true,"$ref":"#/definitions/JourneyViewResultMetrics"},"followedBy":{"type":"array","description":"the list of links following the current element in the journey","readOnly":true,"items":{"$ref":"#/definitions/JourneyViewResultLink"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"An element within a journey view result"},"JourneyViewResultLink":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"connectionCount":{"type":"integer","format":"int32","description":"the number of connections for the journey view link","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents a link between 2 elements in a journey view result"},"JourneyViewResultMetrics":{"type":"object","properties":{"participantCount":{"type":"integer","format":"int32","description":"number of external contacts who participated at the element","readOnly":true},"activeCount":{"type":"integer","format":"int32","description":"number of external contacts who could still complete the journey","readOnly":true},"completedCount":{"type":"integer","format":"int32","description":"number of external contacts who completed the journey forward","readOnly":true},"dropoutCount":{"type":"integer","format":"int32","description":"number of external contacts who did not make it to the next element","readOnly":true},"flowCount":{"type":"integer","format":"int32","description":"number of external contacts who moved from one element to next element but did not complete the journey","readOnly":true}},"description":"The metrics of an element or a link in journey "},"KnowledgeDocumentContentUpload":{"type":"object","required":["contentType","fileName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"contentType":{"type":"string","description":"Type of Article Content.","enum":["Body","Attachment"]},"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"status":{"type":"string","description":"Status of the upload operation","readOnly":true,"enum":["ValidationFailed","InProgress","Completed"]},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}},"document":{"description":"ID of the document for which article content is to be uploaded","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"errorMessage":{"type":"string","description":"Error message when upload fails","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetUploadSourceUrlJobStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the upload from URL job."},"status":{"type":"string","description":"Status of the upload job","enum":["Created","InProgress","Completed","Failed"]},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name"},"errorInformation":{"description":"Any error information, or null of the processing is not in failed state.","$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateUploadSourceUrlJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the upload from URL job."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateUploadSourceUrlJobRequest":{"type":"object","required":["uploadUrl"],"properties":{"uploadUrl":{"type":"string","description":"The URL of the content to upload."}}},"KnowledgeDocumentBulkRemoveRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be deleted","items":{"$ref":"#/definitions/WritableEntity"},"maxItems":100,"minItems":1}}},"KnowledgeDocumentBulkUpdateEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"categoryId":{"type":"string","description":"The category associated with the document."},"labelIds":{"type":"array","description":"The ids of labels associated with the document.","items":{"type":"string"}}}},"KnowledgeDocumentBulkUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be updated","items":{"$ref":"#/definitions/KnowledgeDocumentBulkUpdateEntity"},"maxItems":100,"minItems":1}}},"KnowledgeDocumentBulkVersionAddEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"restoreFromVersionId":{"type":"string","description":"The globally unique identifier for the document version. If the value is provided, the document is restored to the given version."},"restorePrevious":{"type":"boolean","description":"Indicates if the document's previous version will be restored"}}},"KnowledgeDocumentBulkVersionAddRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of unique identifiers referencing documents that are to be versioned","items":{"$ref":"#/definitions/KnowledgeDocumentBulkVersionAddEntity"},"maxItems":100,"minItems":1}}},"OperationCreatorUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"Type of the operation creator entity: User or OAuthClient","enum":["User","OAuthClient"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OperationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OperationResponse"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"OperationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"Status of the operation."},"type":{"type":"string","description":"Type of the operation.","enum":["Import","Export","Parse","Sync"]},"createdBy":{"description":"The user who created the operation.","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Operation creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Operation last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"source":{"description":"Source of the operation.","$ref":"#/definitions/KnowledgeOperationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeParseJobRequestImport":{"type":"object","properties":{"edits":{"type":"array","description":"Override of the result of the parse.","items":{"$ref":"#/definitions/KnowledgeParseRecord"}},"excludes":{"type":"array","description":"Excluded results.","items":{"type":"string"}}}},"KnowledgeParseRecord":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the parsed data."},"title":{"type":"string","description":"Parsed article title."},"body":{"description":"Parsed article content.","$ref":"#/definitions/DocumentBody"}}},"KnowledgeParseImportResult":{"type":"object","required":["failure","success"],"properties":{"success":{"type":"integer","format":"int32","description":"Number of imported articles."},"failure":{"type":"integer","format":"int32","description":"Number of articles failed to import."},"errors":{"type":"array","description":"Error information about the failures.","items":{"$ref":"#/definitions/ErrorBody"}}}},"KnowledgeParseJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the parse job","readOnly":true},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the original html file."},"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}},"status":{"type":"string","description":"Status of the parse job","readOnly":true,"enum":["ReadyToParse","ParseInProgress","ParseCompleted","ReadyToImport","ImportInProgress","ImportCompleted","ImportPartialCompleted","ImportFailed"]},"parseResults":{"type":"array","description":"Results of the parse","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeParseRecord"}},"importResult":{"description":"Result of the import phase","readOnly":true,"$ref":"#/definitions/KnowledgeParseImportResult"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Created date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeParseJobRequestPatch":{"type":"object","properties":{"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}}}},"KnowledgeParseJobRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"hints":{"type":"array","description":"Hinted titles for the parser.","items":{"type":"string"}}}},"NluOrganization":{"type":"object","properties":{"limits":{"type":"object","description":"The NLU limits defined for this Organization","additionalProperties":{"type":"integer","format":"int32"}},"supportedLanguagesInfo":{"type":"array","description":"The list of Supported features for each languages for this Organization","items":{"$ref":"#/definitions/SupportedLanguagesInfoDefinition"}}}},"SupportedEntityTypeStatus":{"type":"object","properties":{"listSlotType":{"type":"string","description":"The configuration status of restricted lists","enum":["All","Restricted","Unrestricted"]}}},"SupportedLanguagesInfoDefinition":{"type":"object","properties":{"language":{"type":"string","description":"The given supported Language"},"intentClassification":{"type":"boolean","description":"The boolean status of if intent classification is supported in this language"},"status":{"type":"string","description":"The language release status","enum":["EARLY_PREVIEW","PREVIEW","GA"]},"supportedEntityTypes":{"type":"array","description":"The supported entity types for this language","items":{"type":"string"}},"supportedEntityTypeConfiguration":{"description":"The configuration for the supported entity types","$ref":"#/definitions/SupportedEntityTypeStatus"}}},"DocumentationV2SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["TERM","COUNT"]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"]}}}},"DocumentationV2SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationV2SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["SIMPLE","EXACT"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"DocumentationV2SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/DocumentationV2SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/DocumentationV2SearchAggregation"}}}},"UtilizationTag":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UtilizationTagEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UtilizationTag"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateUtilizationTagRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The utilization tag name."}}},"SmsAlphanumericProvision":{"type":"object","required":["phoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. Genesys123"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DynamicGroupQueryPreview":{"type":"object","properties":{"userCount":{"type":"integer","format":"int32","description":"Number of Users that match the DynamicGroupQuery"}}},"DynamicGroupLanguageSkillCondition":{"type":"object","required":["comparator","languageSkill","proficiency"],"properties":{"languageSkill":{"type":"string","example":"English-Written","description":"The language skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the language skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupQuery":{"type":"object","required":["skillConditions"],"properties":{"skillConditions":{"type":"array","description":"The skill conditions that need to be used for this dynamic group","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupRoutingSkillCondition":{"type":"object","required":["comparator","proficiency","routingSkill"],"properties":{"routingSkill":{"type":"string","description":"The routing skill to be used in the skill condition query"},"comparator":{"type":"string","description":"Comparator that will be applied to the proficiency","enum":["EqualTo","NotEqualTo","LessThan","GreaterThan","GreaterThanOrEqualTo","LessThanOrEqualTo"]},"proficiency":{"type":"integer","format":"int32","example":5,"description":"The skill proficiency that will be used for the routing skill. Integer range 0-5"},"childConditions":{"type":"array","description":"Nested conditions to be applied to this skill condition","items":{"$ref":"#/definitions/DynamicGroupSkillCondition"}}}},"DynamicGroupSkillCondition":{"type":"object","required":["languageSkillConditions","operation","routingSkillConditions"],"properties":{"routingSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/DynamicGroupRoutingSkillCondition"}},"languageSkillConditions":{"type":"array","description":"Routing skill conditions that will be used for building the query","items":{"$ref":"#/definitions/DynamicGroupLanguageSkillCondition"}},"operation":{"type":"string","description":"Operator that will be applied to the conditions","enum":["And","Not","Or"]}}},"DynamicGroupDefinition":{"type":"object","required":["dateModified","group","query"],"properties":{"group":{"description":"The group the dynamic group definition belongs to","$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time of the dynamic group definition. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"query":{"description":"Properties used for building a dynamic groups query","$ref":"#/definitions/DynamicGroupQuery"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExecutionDataGlobalSettingsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"whether or not the setting is enabled."},"modifiedBy":{"description":"User that last changed the setting.","$ref":"#/definitions/UserReference"},"modifiedByClient":{"description":"OAuth client that last changed the setting.","$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"The time this setting was set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaEndpointStatistics":{"type":"object","properties":{"trunk":{"description":"Trunk information utilized when creating the media endpoint","$ref":"#/definitions/MediaStatisticsTrunkInfo"},"station":{"description":"Station information associated with media endpoint","$ref":"#/definitions/NamedEntity"},"user":{"description":"User information associated media endpoint","$ref":"#/definitions/NamedEntity"},"ice":{"description":"The ICE protocol statistics and details. Reference: https://www.rfc-editor.org/rfc/rfc5245","$ref":"#/definitions/MediaIceStatistics"},"rtp":{"description":"Statistics of sent and received RTP. Reference: https://www.rfc-editor.org/rfc/rfc3550","$ref":"#/definitions/MediaRtpStatistics"},"reconnectAttemptCount":{"type":"integer","format":"int32","description":"Media reconnect attempt count"}}},"MediaIceSelectedCandidate":{"type":"object","properties":{"address":{"type":"string","description":"IP address and port of the candidate"},"type":{"type":"string","description":"Type of the selected candidate","enum":["host","srflx","prflx","relay"]}}},"MediaIceSelectedPair":{"type":"object","properties":{"client":{"description":"The remote candidate that was chosen","$ref":"#/definitions/MediaIceSelectedCandidate"},"server":{"description":"The local candidate that was chosen","$ref":"#/definitions/MediaIceSelectedCandidate"},"candidatePairSelectedMilliseconds":{"type":"integer","format":"int64","description":"Relative milliseconds since creation of endpoint when this ICE candidate pair has been selected"}}},"MediaIceStatistics":{"type":"object","properties":{"selectedPairs":{"type":"array","description":"The candidate pairs selected for the media stream","items":{"$ref":"#/definitions/MediaIceSelectedPair"}}}},"MediaRtpStatistics":{"type":"object","properties":{"packetsReceived":{"type":"integer","format":"int32","description":"Number of packets received, including all invalid, duplicate, and discarded packets"},"packetsSent":{"type":"integer","format":"int32","description":"Number of packets sent"},"rtpEventsReceived":{"type":"integer","format":"int32","description":"Number of RFC#2833 packets received"},"rtpEventsSent":{"type":"integer","format":"int32","description":"Number of RFC#2833 packets sent"},"estimatedAverageMos":{"type":"number","format":"double","description":"The estimated average MOS score"}}},"MediaStatistics":{"type":"object","properties":{"communicationId":{"type":"string"},"dateStart":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationMilliseconds":{"type":"integer","format":"int64","description":"Relative milliseconds to create media session"},"preferredRegion":{"type":"string","description":"Preferred media region"},"effectiveRegion":{"type":"string","description":"Actual media region"},"mediaStatistics":{"type":"array","description":"Media statistics for each media endpoint","items":{"$ref":"#/definitions/MediaEndpointStatistics"}}}},"MediaStatisticsTrunkInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["external","external.pcv","external.pcv.aws","external.pcv.byoc.carrier","external.pcv.byoc.pbx","tie","tie.direct","tie.indirect","tie.cloud.proxy","station","station.cdm","station.cdm.webrtc"]}}},"MediaStatisticsListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MediaStatistics"}}}},"GrammarLanguageFileMetadata":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file as defined by the user"},"fileSizeBytes":{"type":"integer","format":"int32","description":"The size of the file in bytes"},"dateUploaded":{"type":"string","format":"date-time","description":"The date the file was uploaded. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fileType":{"type":"string","description":"The extension of the file","enum":["Gram","Grxml"]}}},"GrammarFileUploadRequest":{"type":"object","properties":{"fileType":{"type":"string","enum":["gram","grxml"]}}},"GrammarLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"grammarId":{"type":"string","description":"The ID of the grammar associated with this grammar language"},"language":{"type":"string"},"voiceFileUrl":{"type":"string","description":"The URL to the voice mode file associated with this grammar language","readOnly":true},"dtmfFileUrl":{"type":"string","description":"The URL to the DTMF mode file associated with this grammar language","readOnly":true},"voiceFileMetadata":{"description":"Additional information about the associated voice file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"dtmfFileMetadata":{"description":"Additional information about the associated dtmf file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GrammarLanguageUpdate":{"type":"object","properties":{"voiceFileMetadata":{"description":"Additional information about the associated voice file","$ref":"#/definitions/GrammarLanguageFileMetadata"},"dtmfFileMetadata":{"description":"Additional information about the associated dtmf file","$ref":"#/definitions/GrammarLanguageFileMetadata"}}},"Grammar":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"languages":{"type":"array","description":"List of languages configured for this grammar","readOnly":true,"items":{"$ref":"#/definitions/GrammarLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GrammarListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Grammar"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WorkbinVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Workbin name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"Workbin description"},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workbin. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The id of the User who modified the Workbin.","$ref":"#/definitions/UserReference"},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkbinVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkbinVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkbinChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorkbinDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkbinDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"}}},"WorkitemsAttributeChangeInstant":{"type":"object","properties":{"newValue":{"type":"string","format":"date-time","description":"New property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oldValue":{"type":"string","format":"date-time","description":"Old property value. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"WorkitemsAttributeChangeString":{"type":"object","properties":{"newValue":{"type":"string","description":"New property value"},"oldValue":{"type":"string","description":"Old property value"}}},"WorkitemsChangeWorkbinDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorkbinDelta"}}},"WorkitemPostQueryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workitem"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"WorkitemQueryPostRequest":{"type":"object","required":["filters"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."},"select":{"type":"string","description":"Specify the value 'Count' for this parameter in order to return only the record count.","enum":["Count"]},"filters":{"type":"array","description":"List of filter objects to be used in the search.","items":{"$ref":"#/definitions/WorkitemFilter"}},"attributes":{"type":"array","description":"List of entity attributes to be retrieved in the result.","items":{"type":"string"}},"after":{"type":"string","description":"The cursor that points to the end of the set of entities that has been returned."},"sort":{"description":"Sort","$ref":"#/definitions/WorkitemQuerySort"},"expands":{"type":"array","description":"List of entity attributes to be expanded in the result.","items":{"type":"string","enum":["type","workbin","status","assignee","reporter","queue"]}}}},"WorkitemQuerySort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.","enum":["dateDue","priority"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"WorkitemVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Workitem."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"type":{"description":"The Worktype of the Workitem.","$ref":"#/definitions/WorktypeReference"},"description":{"type":"string","description":"The description of the Workitem."},"language":{"description":"The language of the Workitem.","$ref":"#/definitions/LanguageReference"},"utilizationLabel":{"description":"The utilization label of the Workitem.","$ref":"#/definitions/WorkitemUtilizationLabelReference"},"priority":{"type":"integer","format":"int32","description":"The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateDue":{"type":"string","format":"date-time","description":"The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"durationSeconds":{"type":"integer","format":"int32","description":"The estimated duration in seconds to complete the workitem."},"ttl":{"type":"integer","format":"int32","description":"The time to live of the Workitem in seconds."},"status":{"description":"The current Status of the Workitem.","$ref":"#/definitions/WorkitemStatusReference"},"statusCategory":{"type":"string","description":"The Category of the current Status of the Workitem.","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"dateStatusChanged":{"type":"string","format":"date-time","description":"The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateClosed":{"type":"string","format":"date-time","description":"The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workbin":{"description":"The Workbin that contains the Workitem.","$ref":"#/definitions/WorkbinReference"},"reporter":{"description":"The reporter of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"assignee":{"description":"The assignee of the Workitem.","$ref":"#/definitions/UserReferenceWithName"},"externalContact":{"description":"The external contact of the Workitem.","$ref":"#/definitions/ExternalContactReference"},"externalTag":{"type":"string","description":"The external tag of the Workitem."},"modifiedBy":{"description":"The User who modified the Workitem.","$ref":"#/definitions/UserReference"},"queue":{"description":"The Workitems queue.","$ref":"#/definitions/WorkitemQueueReference"},"assignmentState":{"type":"string","description":"The assignment state of the workitem.","enum":["Unknown","AcdStarted","Alerting","AlertTimeout","AcdCancelled","Terminated","Idle","Declined","Connected","Disconnected","Parked","Held","AcdExpired"]},"dateAssignmentStateChanged":{"type":"string","format":"date-time","description":"The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The duration in seconds before an alert will timeout."},"skills":{"type":"array","description":"The skills of the Workitem.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"preferredAgents":{"type":"array","description":"The preferred agents of the Workitem.","items":{"$ref":"#/definitions/UserReference"}},"autoStatusTransition":{"type":"boolean","description":"Set it to false to disable auto status transition. By default, it is enabled."},"schema":{"description":"The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time.","$ref":"#/definitions/WorkitemSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by the Workitem.","additionalProperties":{"type":"object"}},"autoStatusTransitionDetail":{"description":"Auto status transition details of Workitem.","$ref":"#/definitions/AutoStatusTransitionDetail"},"scoredAgents":{"type":"array","description":"A list of scored agents for the Workitem.","items":{"$ref":"#/definitions/WorkitemScoredAgent"}},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorkitemDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"languageId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"utilizationLabelId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"priority":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"skillIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"preferredAgentIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"dateDue":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"dateExpires":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"durationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"statusId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"reporterId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"externalContactId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"assigneeId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"workbinId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"queueId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"externalTag":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"wrapupId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"ttl":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"dateClosed":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"assignmentState":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"autoStatusTransition":{"$ref":"#/definitions/WorkitemsAttributeChangeBoolean"},"customFields":{"$ref":"#/definitions/WorkitemsAttributeChangeMap"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"statusCategory":{"$ref":"#/definitions/WorkitemsAttributeChangeWorkitemStatusCategory"}}},"WorkitemsAttributeChangeBoolean":{"type":"object","properties":{"newValue":{"type":"boolean","description":"New property value"},"oldValue":{"type":"boolean","description":"Old property value"}}},"WorkitemsAttributeChangeInteger":{"type":"object","properties":{"newValue":{"type":"integer","format":"int32","description":"New property value"},"oldValue":{"type":"integer","format":"int32","description":"Old property value"}}},"WorkitemsAttributeChangeList":{"type":"object","properties":{"newValue":{"type":"array","description":"New property value","items":{"type":"object"}},"oldValue":{"type":"array","description":"Old property value","items":{"type":"object"}}}},"WorkitemsAttributeChangeMap":{"type":"object","properties":{"newValue":{"type":"object","description":"New property value","additionalProperties":{"type":"object"}},"oldValue":{"type":"object","description":"Old property value","additionalProperties":{"type":"object"}}}},"WorkitemsAttributeChangeWorkitemStatusCategory":{"type":"object","properties":{"newValue":{"type":"string","description":"New property value","enum":["Open","InProgress","Waiting","Closed","Unknown"]},"oldValue":{"type":"string","description":"Old property value","enum":["Open","InProgress","Waiting","Closed","Unknown"]}}},"WorkitemsChangeWorkitemDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorkitemDelta"}}},"WorktypeVersion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Worktype."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The description of the Worktype."},"dateCreated":{"type":"string","format":"date-time","description":"The creation date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The modified date of the Worktype. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultWorkbin":{"description":"The default Workbin for Workitems created from the Worktype.","$ref":"#/definitions/WorkbinReference"},"defaultStatus":{"description":"The default status for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemStatusReference"},"statuses":{"type":"array","description":"The list of possible statuses for Workitems created from the Worktype.","items":{"$ref":"#/definitions/WorkitemStatus"}},"defaultDurationSeconds":{"type":"integer","format":"int32","description":"The default duration in seconds for Workitems created from the Worktype."},"defaultExpirationSeconds":{"type":"integer","format":"int32","description":"The default expiration time in seconds for Workitems created from the Worktype."},"defaultDueDurationSeconds":{"type":"integer","format":"int32","description":"The default due duration in seconds for Workitems created from the Worktype."},"defaultPriority":{"type":"integer","format":"int32","description":"The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."},"defaultLanguage":{"description":"The default language for Workitems created from the Worktype.","$ref":"#/definitions/LanguageReference"},"defaultTtlSeconds":{"type":"integer","format":"int32","description":"The default time to time to live in seconds for Workitems created from the Worktype."},"modifiedBy":{"description":"The id of the User who modified the Worktype.","$ref":"#/definitions/UserReference"},"defaultQueue":{"description":"The default queue for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemQueueReference"},"defaultSkills":{"type":"array","description":"The default skills for Workitems created from the Worktype.","items":{"$ref":"#/definitions/RoutingSkillReference"}},"assignmentEnabled":{"type":"boolean","description":"When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."},"schema":{"description":"The schema defining the custom attributes for Workitems created from the Worktype.","$ref":"#/definitions/WorkitemSchema"},"serviceLevelTarget":{"type":"integer","format":"int32","description":"The target service level for Workitems created from the Worktype. The default value is 100."},"version":{"type":"integer","format":"int32","description":"Version"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorktypeVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorktypeVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemsChangeWorktypeDelta":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version"},"modifiedBy":{"description":"modifiedBy","$ref":"#/definitions/UserReference"},"delta":{"description":"The changes that originated this version","$ref":"#/definitions/WorktypeDelta"}}},"WorktypeChangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemsChangeWorktypeDelta"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorktypeDelta":{"type":"object","properties":{"name":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"description":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"statuses":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"defaultWorkbinId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultDurationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultExpirationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultDueDurationSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultPriority":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"defaultSkillIds":{"$ref":"#/definitions/WorkitemsAttributeChangeList"},"defaultStatusId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultLanguageId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"defaultTtlSeconds":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"assignmentEnabled":{"$ref":"#/definitions/WorkitemsAttributeChangeBoolean"},"defaultQueueId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"schemaId":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"schemaVersion":{"$ref":"#/definitions/WorkitemsAttributeChangeString"},"serviceLevelTarget":{"$ref":"#/definitions/WorkitemsAttributeChangeInteger"},"dateModified":{"$ref":"#/definitions/WorkitemsAttributeChangeInstant"},"modifiedBy":{"$ref":"#/definitions/WorkitemsAttributeChangeString"}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.genesys.cloud"}} \ No newline at end of file diff --git a/version.json b/version.json index 53835226..a80cb9a8 100644 --- a/version.json +++ b/version.json @@ -1,9 +1,9 @@ { - "major": 194, + "major": 195, "minor": 0, "point": 0, "prerelease": "", "apiVersion": 0, - "display": "194.0.0", - "displayFull": "194.0.0" + "display": "195.0.0", + "displayFull": "195.0.0" } \ No newline at end of file